IServerObjectAdmin2 Interface

Provides access to members that administer the 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

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

IServerObjectAdmin2.AddExtensionType Method

Registers a new server object extension type with the server object type indicated in the argument list.

Public Sub AddExtensionType ( _
    ByVal SOTypeName As String, _
    ByVal pSOEType As IServerObjectExtensionType _
)

public void AddExtensionType (
    string SOTypeName,
    IServerObjectExtensionType pSOEType
);

IServerObjectAdmin2.CreateExtensionType Method

Creates a new empty server object extension type.

Public Function CreateExtensionType ( _
) As IServerObjectExtensionType

public IServerObjectExtensionType CreateExtensionType (
);

IServerObjectAdmin2.CreateFolder Method

Creates a server configuration folder.

Public Sub CreateFolder ( _
    ByVal folderName As String _
)

public void CreateFolder (
    string folderName
);

IServerObjectAdmin2.DeleteExtensionType Method

Unregisters a server object extension type from the server object type indicated in the argument list.

Public Sub DeleteExtensionType ( _
    ByVal SOTypeName As String, _
    ByVal SOETypeName As String _
)

public void DeleteExtensionType (
    string SOTypeName,
    string SOETypeName
);

IServerObjectAdmin2.DeleteFolder Method

Deletes a server configuration folder.

Public Sub DeleteFolder ( _
    ByVal folderName As String _
)

public void DeleteFolder (
    string folderName
);

IServerObjectAdmin2.Disable Method

Disables a started SOM.

Public Sub Disable ( _
)

public void Disable (
);

Remarks

The Disable method of the IServerObjectAdmin2 interface disables a SOM. This prevents further communication with any server objects until the Enable method is called. Diabling a SOM does not remove server objects from RAM. When the SOM is enabled again, the server objects will be immediately available.

IServerObjectAdmin2.Enable Method

Enables a disabled SOM.

Public Sub Enable ( _
)

public void Enable (
);

Remarks

The Enable method of the IServerObjectAdmin2 interface enables a previously disabled SOM. Using this method on a currently enabled SOM has no effect. Server objects that had been disabled will be immediately available.

IServerObjectAdmin2.FolderInfo Property

Properties associated with a server configuration folder.

Public Function get_FolderInfo ( _
    ByVal folderName As String _
) As IPropertySet

Public Sub set_FolderInfo ( _
    ByVal folderName As String, _
    ByVal ppInfo As IPropertySet _
)

public IPropertySet get_FolderInfo (
    string folderName
);

public void set_FolderInfo (
    string folderName,
    IPropertySet ppInfo
);

IServerObjectAdmin2.GetConfigurationsEx Method

An enumerator over all the server object configurations in a server configuration folder.

Public Function GetConfigurationsEx ( _
    ByVal folderName As String _
) As IEnumServerObjectConfiguration

public IEnumServerObjectConfiguration GetConfigurationsEx (
    string folderName
);

Remarks

GetConfigurationEx returns an enumeration (IEnumServerObjectConfiguration) of IServerObjectConfiguration for configurations of any esriConfigurationStatus from the folder specified.

Some folderNames have special significance:

folderName == “” means “root”.

folderName == “NULL” means “all folders and root”

IServerObjectAdmin2.GetExtensionTypes Method

An enumerator over all the server object extension types.

Public Function GetExtensionTypes ( _
    ByVal SOTypeName As String _
) As IEnumServerObjectExtensionType

public IEnumServerObjectExtensionType GetExtensionTypes (
    string SOTypeName
);

Remarks

Server object extensions can be designated by a type name, description and class ID. The GetExtensionTypes method of the IServerObjectAdmin2 interface provides a reference to an enumeration of IServerObjectExtensionTypes. IServerObjectExtensionType has methods that can be interrogated for type name, description and class ID.

IServerObjectAdmin2.GetFolders Method

An array of folder names in the server configuration folder.

Public Function GetFolders ( _
    ByVal folderName As String _
) As IEnumBSTR

public IEnumBSTR GetFolders (
    string folderName
);

IServerObjectAdmin2.RenameFolder Method

Renames a server configuration folder.

Public Sub RenameFolder ( _
    ByVal folderName As String, _
    ByVal newName As String _
)

public void RenameFolder (
    string folderName,
    string newName
);

IServerObjectAdmin2.ServerLog Property

Retrieves a reference to the ArcGIS Server logs.

Public ReadOnly Property ServerLog As IServerLog

public IServerLog ServerLog {get;}

Remarks

The ServerLog property of the IServerObjectAdmin2 interface is a reference to an IServerLog interface. The IServerLog interface is used to query and retrieve records from the logs on disk.

IServerObjectAdmin2.ValidateConfiguration Method

Validates server object configuration.

Public Sub ValidateConfiguration ( _
    ByVal Name As String, _
    ByVal TypeName As String _
)

public void ValidateConfiguration (
    string Name,
    string TypeName
);

Inherited Interfaces

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

Classes that implement IServerObjectAdmin2

Classes	Description

Remarks

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

Administer the ArcGIS Server:

• add and remove server object extension types.
• access the server log.
• enable a disabled ArcGIS server.
• disable an enabled ArcGIS server.

Get ArcGIS Server configuration information:

• get information about server object extension types.
• get a reference to the server logs.
• retrieve information about the underlying hardware and operating system.