Provides access to members that administer the ArcGIS server.
IServerObjectAdmin provides methods to retrieve server configuration information and to administer the ArcGIS Server.
The IServerObjectAdmin interface can be obtained by a call to GISServerConnection.ServerObjectAdmin.
When To Use
Use the IServerObjectAmin interface when your application connects to the ArcGIS Server to administer the server's set of server object configurations and server object types, and for administering aspects of the server itself, such as the list of machines that may host server objects.
If your application is connecting to the server to make use of objects in the server, use the IServerObjectManager interface.
|AddConfiguration||Adds a server object configuration (created with CreateConfiguration) to the GIS server.|
|AddMachine||Adds a host machine (created with CreateMachine) to the GIS server.|
|AddServerDirectory||Adds a server directory (created with CreateServerDirectory) to the GIS server.|
|CreateConfiguration||Creates a new server object configuration.|
|CreateMachine||Creates a new host machine.|
|CreateServerDirectory||Creates a new server directory.|
|DeleteConfiguration||Deletes a server object configuration from the GIS server.|
|DeleteMachine||Deletes a host machine from the GIS server, making it unavailable to host server objects.|
|DeleteServerDirectory||Deletes a server directory such that its cleanup is no longer managed by the GIS server. It does not delete the physical directory from disk.|
|GetConfiguration||Get the server object configuration with the specified Name and TypeName.|
|GetConfigurations||An enumerator over all the server object configurations.|
|GetConfigurationStatus||Get the configuration status for a server object configuration with the specified Name and TypeName.|
|GetMachine||Get the host machine with the specified Name.|
|GetMachines||An enumerator over all the GIS server's host machines.|
|GetServerDirectories||An enumerator over the GIS server's output directories.|
|GetServerDirectory||Get the server directory with the specified Path.|
|GetTypes||An enumerator over all the server object types.|
|PauseConfiguration||Makes the configuration unavailable to clients for processing requests, but does not shut down running instances of server objects, or interrupt requests in progress.|
|Properties||The properties for the GIS server.|
|StartConfiguration||Starts a server object configuration and makes it available to clients for processing requests.|
|StopConfiguration||Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.|
|UpdateConfiguration||Updates the properties of a server object configuration.|
|UpdateMachine||Updates the properties of a host machine.|
|UpdateServerDirectory||Updates the properties of a server directory.|
CoClasses that implement IServerObjectAdmin
|CoClasses and Classes||Description|
|ServerObjectAdmin||The ServerObjectAdmin object which administrates the GIS Server.|
Any application that runs as a user account in the agsadmin user group on the ArcGIS Server can use the IGISServerConnection interface to connect to the ArcGIS Server and to get a reference to the ServerObjectAdmin. If the user account is not part of the agsadmin user group, the ServerObjectAdmin property on IServerConnection will return an error. Applications that are running as accounts that can connect to the server but are not part of the agsadmin user group can use the ServerObjectManager property on IGISServerConnection to get a reference on the ServerObjectManager.
The IServerObjectAdmin interface has the necessary methods for an application to adminstrate both the set of server object configurations and types associated with the server, and to administer aspects of the server itself. The following administration functionality of the ArcGIS Server is exposed by methods and properties on IServerObjectAdmin:
Adminster server object configurations:
- Add and delete server object configurations
- Update a server object configuration's properties
- Start, stop, and pause server object configurations
- Report the status of a server object configuration
- Get all server object configurations and their properties
- Get all server object types and their properties
Administer aspects of the server itself:
- Add and remove server container machines
- Get all server container machines
- Add and remove server directories
- Get all server directories
- Configure the server's logging properties