Share via


MIIS_CSObject Class

Represents an instance of each connector space object in the server. To use this class, you must be logged on as a member of the MIISPasswordSet security group or the MIISBrowse security group.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.

class MIIS_CSObject{ String Account;
String UnconfirmedExportHologram;
String Dn;
String Domain;
String EscrowedExportHologram;
String FullyQualifiedDomainName;
String Guid;
String Hologram;
String MaGuid;
String MaName;
String MvGuid;
String ObjectType;
String PartitionGuid;
String PasswordChangeHistory;
String PartitionName;
String PendingImportHologram;
String PartitionDisplayName;
String UnappliedExportHologram;
String UserPrincipalName;
}

Name : MIIS_CSObject

Methods

Method Description

ChangePassword Method

Changes the password on a connector space object to a new password.

SetPassword Method

Sets the password on a connector space object to a new password.

Properties

Property Data Type Description

Account Property

String

Gets the security account manager (SAM) account name for the user.

UnconfirmedExportHologram Property

String

Gets an XML representation of the latest view of an object in the connected directory.

Dn Property

String

Gets the distinguished name of the connector space object.

Domain Property

String

Gets the domain name of the connector space object.

EscrowedExportHologram Property

String

Gets an XML representation of what the connector space object properties will be if all the exports in progress are applied to the object.

FullyQualifiedDomainName Property

String

Gets the domain name of the connector space object in domain name system (DNS) format.

Guid Property

String

Qualifiers : Key

Gets the GUID that is used to identify the connector space object in the Microsoft SQL Server 2008 database.

Hologram Property

String

Gets an XML representation of the connector space object that has been synchronized to a metaverse object.

MaGuid Property

String

Gets the GUID of the management agent for the connector space object.

MaName Property

String

Gets the name of the management agent for the connector space object.

MvGuid Property

String

Gets the GUID of the metaverse object that is joined to the connector space object.

ObjectType Property

String

Gets the name of the primary object type of the connector space object.

PartitionGuid Property

String

Gets the GUID of the management agent partition with the connector space object.

PasswordChangeHistory Property

String

Gets the log in an XML format of the calls to the MIIS_CSObject.ChangePassword and MIIS_CSObject.SetPassword methods.

PartitionName Property

String

Gets the display name of the management agent partition with the connector space object.

PendingImportHologram Property

String

Gets an XML representation of the connector space object in the connected directory that has been imported into the server from a full or delta import run profile.

PartitionDisplayName Property

String

Gets an alternate display name of the management agent partition with the connector space object. This alternate display name is used by password management applications.

UnappliedExportHologram Property

String

Gets an XML representation of the properties of a connector space object if all the exports from the metaverse are successfully applied to the object.

UserPrincipalName Property

String

Gets the UserPrincipalName property of the connector space object. This property is populated only through Active Directory Domain Services (AD DS) and the global address list (GAL) synchronization management agent.

Remarks

The class supports the following restricted set of queries:

  • Search for a connector space object with a specified GUID.

  • Search for a connector space object joined to a metaverse object with a specified metaverse GUID.

  • Search for a connector space object that has a specified domain and account name in AD DS, a global address list, or a Windows NT domain.

  • Search for a connector space object that has a specified domain and user principal name in AD DS, a global address list, or a Windows NT domain.

This class also supports searching for a connector space object that has a specified distinguished name and management agent GUID. For directory-based management agents, you can search by distinguished name. For management agent types that do not have a distinguished name (for example, a database or non-hierarchical file-based management agent), you can search by anchor attribute. This is because in the FIM Synchronization Service, the anchor attribute is treated as a distinguished name.

Windows Management Instrumentation (WMI) contains special characters, and you must escape these characters before passing them into the function. The special characters for WMI include quotation marks ("), commas (,), backslashes (\), and apostrophes ('). You must precede commas, backslashes, and apostrophes with a backslash. Quotation marks must be preceded by another set of quotation marks.

For example, to search for the following objects:

  • DC=c"om

  • DC=c\om

  • DC=c\,om

  • DC=c'om

You must write the following WMI code:

  • Set CsObjects = Service.ExecQuery ("Select * from MIIS_CSObject where DN = 'DC=c""om' and MaGuid = '{AD76535A-2523-4EB2-9C2B-4C0E02E9CF95}' ")

  • Set CsObjects = Service.ExecQuery ("Select * from MIIS_CSObject where DN = 'DC=c\\om' and MaGuid = '{AD76535A-2523-4EB2-9C2B-4C0E02E9CF95}' ")

  • Set CsObjects = Service.ExecQuery ("Select * from MIIS_CSObject where DN = 'DC=c\\,om' and MaGuid = '{AD76535A-2523-4EB2-9C2B-4C0E02E9CF95}' ")

  • Set CsObjects = Service.ExecQuery ("Select * from MIIS_CSObject where DN = 'DC=c\'om' and MaGuid = '{AD76535A-2523-4EB2-9C2B-4C0E02E9CF95}' ")

The class supports the OR operator in these searches. If the query does not contain a WHERE clause, the search fails.

Example

The following Microsoft Visual Basic Scripting Edition (VBScript) example shows how to get a connector space object that has a specified GUID.

Option Explicit

' Authentication level
Const PktPrivacy = 6

Dim Service
Dim CsObject
Dim CsObjects

Set Service = GetObject("winmgmts:{authenticationLevel=PktPrivacy}!root\MicrosoftIdentityIntegrationServer")
Set CsObject = Service.ExecQuery("Select * from MIIS_CSObject where Guid='{5B3B52B7-5881-4780-9D46-72696AAC4A8B}'")

For each CsObject in CsObjects
WScript.Echo "Guid:                    " + CSObject.Guid
WScript.Echo "Domain:                  " + CSObject.Domain
Next

The following VBScript example shows how to find all connector space objects that are joined to a metaverse object with a specified GUID.

Option Explicit

' Authentication level
Const PktPrivacy = 6

Dim Service
Dim CsObjects
Dim CsObject
Dim hr_mvguid

Set Service = GetObject("winmgmts:{authenticationLevel=PktPrivacy}!root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery _
   ("Select * from MIIS_CSObject where domain='Fabrikam' and account='HRAccount'")
   
For Each CSObject in CSObjects
   If (CSObject.MaName = "Fabrikam HR MA") Then
       hr_mvguid = CSObject.mvguid
   End if
Next

Set CsObjects = Service.ExecQuery _
      ("Select * from MIIS_CSObject where mvguid = hr_mvguid")

The following VBScript example shows how to retrieve all connector space objects with a specified domain and SAM account name.

Option Explicit

Const PktPrivacy = 6    ' Authentication level

Dim Service
Dim CsObjects
Set Service = GetObject("winmgmts:{authenticationLevel=PktPrivacy}!root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery

   ("Select * from MIIS_CSObject where domain='Fabrikam' and account='HRAccount'")

The following VBScript example shows how to retrieve all connector space objects with a specified domain and user principal name.

Option Explicit

Const PktPrivacy = 6    ' Authentication level

Dim Service
Dim CsObjects
Set Service = GetObject("winmgmts:{authenticationLevel=PktPrivacy}!root\MicrosoftIdentityIntegrationServer")
Set CsObjects = Service.ExecQuery

   ("Select * from MIIS_CSObject where domain='Fabrikam' and userPrincipalName='Jeff'")

The following VBScript example shows how to retrieve all connector space objects with a specified distinguished name and management agent GUID.

Option Explicit

Const PktPrivacy = 6    ' Authentication level 

Dim Service
Dim CsObject
Dim CsObjects

Set Service = GetObject("winmgmts:{authenticationLevel=PktPrivacy}!root\MicrosoftIdentityIntegrationServer")
Set CsObject = Service.ExecQuery("Select * from MIIS_CSObject where Guid='{5B3B52B7-5881-4780-9D46-72696AAC4A8B}'")

For each CsObject in CsObjects
WScript.Echo "Guid:                    " + CSObject.Guid
WScript.Echo "Domain:                  " + CSObject.Domain
Next

Requirements

Product

Forefront Identity Manager Synchronization Service 2010

MOF

Mmswmi.mof

Namespace

MicrosoftIdentityIntegrationServer

See Also

Concepts

WMI Provider Reference
Classes