Microsoft Identity Integration Server 2003 Developer Reference

GetServerStatus Method of the MIIS_ManagementAgent Class

The GetServerStatus method determines if the connected directory server is running and connected to the network. To use this method, you must be logged on as a member of the MIISOperators security group or the MIISAdmins security group. This method is a synchronous call used by the server to determine the status of a remote server. 
string GetServerStatus(
  string PartitionGuid
);

Parameters

PartitionGuid
[in] Contains the globally unique identifier (GUID) of the management agent partition of the object. You can set this parameter by getting the MIIS_CSObject.PartitionGuid property of the object from the MIIS_CSObject collection.

Return Values

Returns the status of the connected directory server. The return value can be one of the following values or one of the values listed in Return Strings:
Return code Description
success The connected directory server is running with a secure communication link so passwords can be securely changed or set.
success-low-security The connected directory server is running but the security between the server and the connected directory server is low (40-bit) so passwords cannot be sent. Enable the Secure Sockets Layer (SSL) connections and authentications if you need to send passwords.
password-sync-disabled The connected directory server is running but the password synchronization setting for the management agent is not enabled. Enable password synchronization for the management agent.
success-security-restrictions The connected directory server with Active Directory Application Mode (ADAM) is running but you cannot set or change passwords because the connection is not secure.
incorrect-partition-id-format The PartitionGuid parameter is not in a GUID format.
ma-credentials-failure The management agent was unable to log on to the connected directory server with the stored credentials. Verify that the management agent credentials are correct. For more information about configuring Active Directory management agent credentials, see "Connect to an Active Directory Forest" in the Microsoft Identity Integration Server 2003 Help. For more information about configuring credentials for the management agent for Sun ONE Directory Server 4.1x and 5.x (formerly iPlanet Directory Server) and Netscape Directory Server 4.1 and 6.01, see "Connect to a Sun or Netscape directory server" in the Microsoft Identity Integration Server 2003 Help.
ma-feature-not-supported The management agent type does not support password changes.
partition-not-configured The partition corresponding to the PartitionGuid parameter has not been configured. Configure the partition using Identity Manager. For more information, see "Configure directory partitions" in the Microsoft Identity Integration Server 2003 Help.
server-down The server could not connect to the connected directory server. Verify that the connected directory server is running and connected the network.
unknown-partition-id The PartitionGuid parameter cannot be matched to a partition in the connected directory server that belongs to the management agent. Verify that you are using the correct PartitionGuid parameter for the partition.

Example Code

The following example shows how to use Visual Basic Scripting Edition (VBScript) to get the status of the connected directory server that contains an object with a specified domain and account:
[VBScript] 
Option Explicit

On Error Resume Next

Dim Service
Dim CsObjects
Dim CsObject
Dim MAObjects
Dim MAObject

Set Service = GetObject("winmgmts:root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery _
						("Select * from MIIS_CSObject where domain='Main' and account='Jeff'")
					
For Each CsObject in Csobjects
	Set MAObjects = Service.ExecQuery _
	 ("select * from MIIS_ManagementAgent where guid='"& CSObject.MaGuid &"'")
	 
	For Each MAObject in MAObjects
		WScript.Echo "GetServerStatus returns '" + MAObject.GetServerStatus _
		 ( CSObject.PartitionGuid )
	Next

Next

Sub ErrorHandler (ErrorMessage)
  WScript.Echo ErrorMessage
  WScript.Quit(1)
End Sub

Requirements

Server: Requires Microsoft Identity Integration Server 2003.
Header: Declared in mmswmi.mof.


See Also

MIIS_CSObject, MIIS_CSObject.Guid, MIIS_CSObject.SetPassword