The value of this property can be any one of the following:
-
Single host name, single IP address (all LDAP directory types)
When the value is a host name, Content Engine attempts to connect to the directory server that runs on that host. Content Engine uses the port number specified by the DirectoryServerPort property for this connection attempt.
-
Single host name, multiple IP addresses (Microsoft® Active Directory and IBM® Tivoli® Directory Server)
You can manually create DNS address records ("A" records) to assign the same host name to each of the different IP addresses. Failover using multiple IP addresses can be specified only when the value of the DirectoryServerType property is AD (Active Directory) or IBM (Tivoli Directory Server).The benefit of using multiple IP addresses for failover is that you do not need to modify a failover list when you change the host name, or when you decommission a domain controller or a Tivoli Directory Server. In addition, this option is useful when the Active Directory domain contains remote domain controllers but you want to connect only to local DCs (as opposed to using the "Domain name" option below). The DC connection attempts are done in parallel. The first successful connection is the DC used.
-
Domain name (Microsoft Active Directory)
When the value is an Active Directory domain name and the value of the DirectoryServerType property is AD (Active Directory), Content Engine attempts to connect to any domain controller (DC) in the specified domain. Each DC must use the same LDAP port numbers (generally the case). The DC connection attempts are done in parallel. The first successful connection is the DC used.
-
Failover list (Microsoft Active Directory and IBM® Tivoli® Directory Server)
When the value is a list of unique host names paired with port numbers, Content Engine attempts to connect to one of the directory servers represented in the list. (The DirectoryServerPort property is ignored.) A failover list can be specified only when the value of the DirectoryServerType property is AD (Active Directory). or IBM (Tivoli Directory Server). For Active Directory, each directory server represented in the failover list is expected to be an Active Directory domain controller (DC).
Failover list format
Format the failover list in the following manner:
Hostname1:Port1 Hostname2:Port2 Hostname3:Port3 ... HostnameN:PortN
Separate the host name and port number pairs with one space character. In the following example, the first pair specifies LaurelTree as the machine name and 389 as the port number:
LaurelTree:389 OliveTree:636 FigTree:389
Content Engine makes connection attempts to directory servers based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a directory server or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established directory server connection.
For instance, given the example list, Content Engine first attempts to connect to the directory server on the LaurelTree machine on port 389. If that attempt fails, it attempts to connect to the directory server on the OliveTree machine on port 636. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the directory server on OliveTree, the connection attempts start over again with LaurelTree.
Assembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property DirectoryServerHost As String |
C# |
---|
string DirectoryServerHost { get; set; } |
Visual C++ |
---|
property String^ DirectoryServerHost { String^ get (); void set (String^ value); } |
JavaScript |
---|
function get_directoryServerHost(); function set_directoryServerHost(value); |
Remarks
Metadata
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ