ArcObjects Library Reference (Server)  

IServerObjectAdmin Interface

Provides access to members that administer the ArcGIS server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

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.

Members

Description
Method AddConfiguration Adds a server object configuration (created with CreateConfiguration) to the GIS server.
Method AddMachine Adds a host machine (created with CreateMachine) to the GIS server.
Method AddServerDirectory Adds a server directory (created with CreateServerDirectory) to the GIS server.
Method CreateConfiguration Creates a new server object configuration.
Method CreateMachine Creates a new host machine.
Method CreateServerDirectory Creates a new server directory.
Method DeleteConfiguration Deletes a server object configuration from the GIS server.
Method DeleteMachine Deletes a host machine from the GIS server, making it unavailable to host server objects.
Method 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.
Method GetConfiguration Get the server object configuration with the specified Name and TypeName.
Method GetConfigurations An enumerator over all the server object configurations.
Method GetConfigurationStatus Get the configuration status for a server object configuration with the specified Name and TypeName.
Method GetMachine Get the host machine with the specified Name.
Method GetMachines An enumerator over all the GIS server's host machines.
Method GetServerDirectories An enumerator over the GIS server's output directories.
Method GetServerDirectory Get the server directory with the specified Path.
Method GetTypes An enumerator over all the server object types.
Method 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.
Read/write property Properties The properties for the GIS server.
Method StartConfiguration Starts a server object configuration and makes it available to clients for processing requests.
Method StopConfiguration Stops a server object configuration and shuts down any running instances of server objects defined by the configuration.
Method UpdateConfiguration Updates the properties of a server object configuration.
Method UpdateMachine Updates the properties of a host machine.
Method 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.

Remarks

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:

Administer aspects of the server itself: