The FPCLdapServersSets collection holds a set of FPCLdapServersSet objects that represent all the Lightweight Directory Access Protocol (LDAP) server sets defined in a Forefront TMG array. LDAP servers can be used by Forefront TMG computers belonging to a workgroup for authenticating domain users.
When Active Directory® directory service authentication is required and the Forefront TMG computer belongs to a workgroup or to a domain in a forest other than the one that contains the user's account, the Forefront TMG computer must connect to a domain controller over an LDAP protocol (LDAP, LDAPS, LDAP-GC, and LDAPS-GC are supported) to authenticate the user, and the domain controller acts as an LDAP server. Because each domain controller is only able to authenticate the users in its domain, Forefront TMG by default queries the global catalog for the forest to validate the user's credentials. The user must enter credentials recognized by Active Directory in one of these formats:
- SAM account name (domain\username)
- User principal name (email@example.com)
- Distinguished name
When an LDAP user supplies a user name in one of these formats (for example, contoso\stephanie or firstname.lastname@example.org), Forefront TMG tests the logon string patterns defined in the FPCLdapMatchingPatterns collection to find a pattern that matches the user name supplied by the user. When a match is found, Forefront TMG attempts to establish a connection with an LDAP server defined in the LDAP server set associated with the matching logon string pattern in the order defined by the collection using the credentials specified in the Credentials property of this LDAP server set, and after a connection with an LDAP server is established, Forefront TMG sends a query to validate the user using the credentials supplied by the user. If no matching logon string pattern is found, authentication fails.
The FPCLdapServersSet collection representing the LDAP server set associated with a specific logon string pattern is referenced through the FPCRef object held in the LDAPServersSet property of the applicable FPCLdapMatchingPattern object.
The FPCLdapServersSets collection is accessed through the LdapServersSets property of an FPCRuleElements object.
Click here to see the Forefront TMG object hierarchy.
This collection inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting an object's data to and importing it from XML documents.
The FPCLdapServersSets collection defines the following methods.
Creates a new FPCLdapServersSet object in the collection and returns a reference to it.
Retrieves the requested FPCLdapServersSet object from the collection.
Removes the specified FPCLdapServersSet object from the collection.
The FPCLdapServersSets collection defines the following properties.
Gets an enumerator object for the collection.
Gets the number of FPCLdapServersSet objects in the collection.
Methods Inherited from FPCPersist
|CancelWaitForChanges||Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).|
|CanImport||Returns a Boolean value that indicates whether the properties of the collection and its elements can be imported from the specified XML document.|
|Export||Writes the stored values of all the properties of the collection and its elements to the specified XML document.|
|ExportToFile||Writes the stored values of all the properties of the collection and its elements to the specified XML file.|
|GetServiceRestartMask||Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.|
|Import||Copies the values of all the properties of the collection and its elements from the specified XML document to persistent storage.|
|ImportFromFile||Copies the values of all the properties of the collection and its elements from the specified XML file to persistent storage.|
|LoadDocProperties||Provides the XML document's properties so that you can know what information can be imported from the document.|
|Refresh||Reads the values of all the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved.|
|Save||Writes the current values of all the properties of the collection and its elements to persistent storage.|
|WaitForChanges||Registers to wait for an event indicating that the contents of the collection have changed (for use in C and C++ programming only).|
Properties Inherited from FPCPersist
|PersistentName||Gets the persistent name of the collection. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.|
|VendorParameterSets||Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the collection.|
Interfaces for C++ Programming
This collection implements the IFPCLdapServersSets interface.
|Client||Requires Windows 7 or Windows Vista.|
|Server||Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.|
|Version||Requires Forefront Threat Management Gateway (TMG) 2010.|
Declared in Msfpccom.idl.
Send comments about this topic to Microsoft
Build date: 6/30/2010