ArcObjects Library Reference (Server)  

IServerObjectAdmin2 Interface

Provides access to members that administer the ArcGIS server.

Product Availability

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

Description

IServerObjectAdmin2 provides methods to retrieve server configuration information and to administer the ArcGIS Server.

 

The IServerObjectAdmin2 interface can be obtained by a query interface with the IServerObjectAdmin interface.

When To Use

Use the IServerObjectAmin2 interface when your application needs to connect to retrieve configuration information about the ArcGIS Server and when your application intends to administer the ArcGIS Server.

If your application is connecting to the server only to make use of objects in the server, use the IServerObjectManager interface instead.

Members

Description
Method AddConfiguration Adds a server object configuration (created with CreateConfiguration) to the GIS server.
Method AddExtensionType Registers a new server object extension type with the server object type indicated in the argument list.
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 CreateExtensionType Creates a new empty server object extension type.
Method CreateFolder Creates a server configuration folder.
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 DeleteExtensionType Unregisters a server object extension type from the server object type indicated in the argument list.
Method DeleteFolder Deletes a server configuration folder.
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 Disable Disables a started SOM.
Method Enable Enables a disabled SOM.
Read/write property FolderInfo Properties associated with a server configuration folder.
Method GetConfiguration Get the server object configuration with the specified Name and TypeName.
Method GetConfigurations An enumerator over all the server object configurations.
Method GetConfigurationsEx An enumerator over all the server object configurations in a server configuration folder.
Method GetConfigurationStatus Get the configuration status for a server object configuration with the specified Name and TypeName.
Method GetExtensionTypes An enumerator over all the server object extension types.
Method GetFolders An array of folder names in the server configuration folder.
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 RenameFolder Renames a server configuration folder.
Read-only property ServerLog Retrieves a reference to the ArcGIS Server logs.
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.
Method ValidateConfiguration Validates server object configuration.

Inherited Interfaces

Interfaces Description
IServerObjectAdmin Provides access to members that administer the ArcGIS server.

CoClasses that implement IServerObjectAdmin2

CoClasses and Classes Description
ServerObjectAdmin The ServerObjectAdmin object which administrates the GIS Server.

Remarks

The following administration functionality of the ArcGIS Server is exposed by the methods of IServerObjectAdmin2 :

 

Administer the ArcGIS Server:

 

Get ArcGIS Server configuration information:

.NET Samples

Find near features REST SOE (Code Files: Program) | Server spatial query server object extension (Code Files: Program) | Simple REST SOE (Code Files: Program) | Simple SOAP SOE (Code Files: Program) | Simple SOE (Code Files: Program) |

.NET Related Topics

How to register the SOE | Server | Server object extensions (SOE) |