# Configuring LDAP Collector

The Open iT LDAPCollector collects Active Directory information and sends them over to the server. This allows the server installation in the cloud to integrate the Active Directory to their reports.

# Configuring LDAP Settings

  1. Open ldapcollector.xml located at C:\Program Files\OpeniT\Core\Configuration\Components.

  2. Update the following objects under the ldap-settings node:

    url

    LDAP://HostName

    or

    LDAP://IPAddress

    or

    LDAP://HostName:[PortNumber]

    or

    LDAP://IPAddress:[PortNumber]

    or

    LDAP://HostName:[PortNumber]/[DistiguishedName]

    or

    LDAP://IPAddress:[PortNumber\]/[DistiguishedName] 

    LDAP URL Description
    LDAP: Binds to the root of the LDAP namespace
    LDAP://server01 Binds to a specific server
    LDAP://server01:390 Binds to a specific server using the specified port number
    LDAP://CN=Jeff Smith,CN=Users,DC=fabrikam,DC=com Binds to a specific object and start the search from that node
    LDAP://server01/CN=Jeff Smith,CN=Users,DC=fabrikam,DC=com Binds to a specific object through a specific server
    Sample url values

    filter

    The default value is objectClass=User. Update the value by following either of the following format:

    ([attribute][operator][value])  

    or

    ([operator][filter1][filter2])

    Search Filter Description
    (objectClass=*) All objects
    (&(objectClass=User)(!(CN=andy))) All user objects but not "andy"
    (sn=sm*) All objects with a surname that starts with "sm"
    (&(objectClass=contact)(|(sn=Smith)(sn=Johnson))) All contacts with a surname equal to "Smith" or Johnson
    Sample filter Values

    attribute

    The default value is sAMAccountName,displayName,department,division,employeeType,l, mail,physicalDeliveryOfficeName,title. Update the attribute separated by comma.

    attrib1,attrib2,...attribN

    Attribute Description
    givenName First Name
    initials Middle Name / Initials
    sn Last Name
    userPrincipalName Logon Name
    sAMAccountName Logon Name (Pre Windows 2000)
    displayName Display Name
    description Description
    physicalDeliveryOfficeName Office
    telephoneNumber Telephone Number
    Sample attribute Values

  3. Save the file.

  1. Open ldapcollector.xml located at /var/opt/openit/etc/Components.

  2. Update the following objects under the ldap-settings node:

    url

    LDAP://HostName

    or

    LDAP://IPAddress

    or

    LDAP://HostName:[PortNumber]

    or

    LDAP://IPAddress:[PortNumber]

    or

    LDAP://HostName:[PortNumber]/[DistiguishedName]

    or

    LDAP://IPAddress:[PortNumber\]/[DistiguishedName] 

    LDAP URL Description
    LDAP: Binds to the root of the LDAP namespace
    LDAP://server01 Binds to a specific server
    LDAP://server01:390 Binds to a specific server using the specified port number
    LDAP://CN=Jeff Smith,CN=Users,DC=fabrikam,DC=com Binds to a specific object and start the search from that node
    LDAP://server01/CN=Jeff Smith,CN=Users,DC=fabrikam,DC=com Binds to a specific object through a specific server
    Sample url values

    filter

    The default value is objectClass=User. Update the value by following either of the following format:

    ([attribute][operator][value])  

    or

    ([operator][filter1][filter2])

    Search Filter Description
    (objectClass=*) All objects
    (&(objectClass=User)(!(CN=andy))) All user objects but not "andy"
    (sn=sm*) All objects with a surname that starts with "sm"
    (&(objectClass=contact)(|(sn=Smith)(sn=Johnson))) All contacts with a surname equal to "Smith" or Johnson
    Sample filter Values

    attribute

    The default value is sAMAccountName,displayName,department,division,employeeType,l, mail,physicalDeliveryOfficeName,title. Update the attribute separated by comma.

    attrib1,attrib2,...attribN

    Attribute Description
    givenName First Name
    initials Middle Name / Initials
    sn Last Name
    userPrincipalName Logon Name
    sAMAccountName Logon Name (Pre Windows 2000)
    displayName Display Name
    description Description
    physicalDeliveryOfficeName Office
    telephoneNumber Telephone Number
    Sample attribute Values

  3. Save the file.

# Configuring LDAP Crendential File

The configuration requires a user credential in the ldap_auth file if the current user does not have access to the Active Directory.

  1. Open the ldap_auth file located at C:\Program Files\OpeniT\Core\Configuration\.

  2. Provide an existing username and password from the Active Directory with the following format:

    svg\jsmith=jsmith_password

    or

    jsmith@domainName.com=jsmith_password
  3. Save the file.

  1. Open the ldap_auth file located at /var/opt/openit/etc.

  2. Provide an existing username and password from the Active Directory with the following format:

    svg\jsmith=jsmith_password

    or

    jsmith@domainName.com=jsmith_password
  3. Save the file.

# Configuring the Collection of LDAP data

  1. Open collect_ldap.oconf located at C:\Program Files\OpeniT\Core\Configuration\scheduler.

  2. Locate and set collect_ldap.active to true.

    collect_ldap.oconf
     1|root
     2|{
     3| scheduler
     4| {
     5|   jobs
     6|   {
     7|     collect_ldap
     8|     {
            ...
    16|         active
    17|         {
    18|           type=bool
    19|           value=true
    20|         }
    ...
  3. Save the file.

  1. Open collect_ldap.oconf located at /var/opt/openit/etc/scheduler.

  2. Locate and set collect_ldap.active to true.

    collect_ldap.oconf
     1|root
     2|{
     3| scheduler
     4| {
     5|   jobs
     6|   {
     7|     collect_ldap
     8|     {
            ...
    16|         active
    17|         {
    18|           type=bool
    19|           value=true
    20|         }
    ...
  3. Save the file.

# Verifying LDAP Collector Configuration

Follow these steps to manually check if the configuration works:

  1. Run command prompt as Administrator.

  2. Go to C:\Program Files\OpeniT\Core\bin and run:

    openit_confbuilder --client
  3. Run the LDAP collector binary:

    openit_ldapcollector

    Ensure that there is no error encountered upon running the command.

  4. Check if there is a C:\Program Files\OpeniT\Core\Log\temp\LdapCollector directory and if it contains a file called ldap_data.tsv.

  1. Run command prompt as Administrator.

  2. Go to /opt/openit/bin and run:

    openit_confbuilder --client
  3. Run the LDAP collector binary:

    openit_ldapcollector

    Ensure that there is no error encountered upon running the command.

  4. Check if there is a /var/opt/openit/temp/LdapCollector directory and if it contains a file called ldap_data.tsv.

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close