Identifies the Microsoft® Active Directory global catalog (GC) or catalogs to use. See also the GCPort property.

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 attempt to connect to the GC that runs on that host. Content Engine uses the port number specified by the GCPort property for this connection attempt.
  • Single host name, multiple IP addresses (Microsoft® Active Directory)
    You can manually create DNS address records ("A" records) assigning the same host name to each of several different GC IP addresses. This is useful when the Active Directory domain is remote and you want to connect only to local GCs (as opposed to using the "Domain name" option below). The GC connection attempts are done in parallel. The first successful connection is the GC 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 GC in the specified domain. Each GC must use the same LDAP port numbers (generally the case). The GC connection attempts are done in parallel. The first successful connection is the GC used.
  • Failover list
    When the value is a list of host names paired with port numbers, Content Engine attempts to connect to one of the GCs represented in the list. (The GCPort property is ignored.)
  • No value
    When the value is null, Content Engine uses an internal mechanism to find a GC.

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 3268 as the port number.

        LaurelTree:3268 OliveTree:3269 FigTree:3268

Content Engine makes connection attempts to GCs based on the order of the pairs in the list. The connection attempts stop when Content Engine either successfully connects to a GC or exhausts the list. The connection attempts resume at the beginning of the list when Content Engine loses a previously established GC connection.

For instance, given the example list, Content Engine first attempts to connect to the GC on the LaurelTree machine on port 3268. If that attempt fails, it attempts to connect to the GC on the OliveTree machine on port 3269. If that attempt succeeds, the connection attempts stop. If, later on, Content Engine loses the connection to the GC on OliveTree, the connection attempts start over again with LaurelTree.

Namespace:  FileNet.Api.Admin
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Property GCHost As String
C#
string GCHost { get; set; }
Visual C++
property String^ GCHost {
	String^ get ();
	void set (String^ value);
}
JavaScript
function get_gcHost();
function set_gcHost(value);

ToggleRemarks

ToggleSee Also