This document is archived and information here might be outdated.  Recommended version.


IServerStatus Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Server)  

IServerStatus Interface

Provides access to the properties of the status of the ArcGIS Server.

Product Availability

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

Members

Description
Read-only property Enabled Indicates if the server is started and enabled(true) or not(false).
Method GetConfigurationStatus Gets the configuration status for the server object configuration with the specified Name and TypeName.
Method GetMachineStatus Gets the status for an ArcGIS Server host machine.
Read-only property InstanceCount The number of server object instances currently running in the ArcGIS server.
Read-only property InstanceInUseCount The number of currently running server object instances in use by clients of the ArcGIS server.
Read-only property StartTime The time that the server was started.

Remarks

The IServerStatus interface provides access to information concerning the state of the ArcGIS Server, its SOC machines and its server object configurations. This interface can be obtained with a Query Interface on IServerObjectAdmin.

 

The InstanceCount property holds the number of server object instances currently running on the entire ArcGIS Server (includes all SOC machines). This number will always contain two more configuration instances than you deploy.  These two "extra" configuration instances correspond to an instance of the SDM.ServerDirectoryManager and an instance of the SrvLog.ServerLog configurations and are started and controlled by the SOM.  You cannot alter these configurations.  It is also important to note that these two instances do participate in the total number of instances allowed by the server configuration Capacity property. For example, if you set Capacity=22, you will only be able to add 20 more configuration instances before the pool-shrinking algorithm engages. However, these two configurations will not be removed in a pool-shrinking operation and will stay on the machine on which they were instantiated unless that machine is removed or becomes disabled.  In this case, the two instances will get redistributed to somewhere on the other SOC machines.

 

The InstanceInUseCount property holds the number of server object instances that are currently in use by ArcGIS Server clients. An instance is counted as "in use" until the client releases the server context.

 

The GetConfigurationStatus method returns an IServerObjectConfigurationStatus interface which can report the number of active and inactive instances and the enabled status of the configuration in the method argument.