IServerStatus Interface

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

Members

Name 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.

IServerStatus.Enabled Property

Indicates if the server is started and enabled(true) or not(false).

Public ReadOnly Property Enabled As Boolean
public bool Enabled {get;}

IServerStatus.GetConfigurationStatus Method

Gets the configuration status for the server object configuration with the specified Name and TypeName.

Public Function GetConfigurationStatus ( _
    ByVal Name As String, _
    ByVal TypeName As String _
) As IServerObjectConfigurationStatus
public IServerObjectConfigurationStatus GetConfigurationStatus (
    string Name,
    string TypeName
);

Remarks

The GetConfigurationStatus method of the IServerStatus interface provides access to information about the enabled state and running instances of a particular server object configuration.

IServerStatus.GetMachineStatus Method

Gets the status for an ArcGIS Server host machine.

Public Function GetMachineStatus ( _
    ByVal Machine As String _
) As IServerMachineStatus
public IServerMachineStatus GetMachineStatus (
    string Machine
);

IServerStatus.InstanceCount Property

The number of server object instances currently running in the ArcGIS server.

Public Function get_InstanceCount ( _
    ByVal access As esriAccessLevel _
) As Integer
public int get_InstanceCount (
    esriAccessLevel access
);

Remarks

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.

IServerStatus.InstanceInUseCount Property

The number of currently running server object instances in use by clients of the ArcGIS server.

Public Function get_InstanceInUseCount ( _
    ByVal access As esriAccessLevel _
) As Integer
public int get_InstanceInUseCount (
    esriAccessLevel access
);

IServerStatus.StartTime Property

The time that the server was started.

Public ReadOnly Property StartTime As DateTime
public DateTime StartTime {get;}

Classes that implement IServerStatus

Classes Description

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.