ldaparray

This function is only available in CFEngine Enterprise.

Prototype: ldaparray(array, uri, dn, filter, scope, security)

Return type: boolean

Description: Fills array with the entire LDAP record, and returns whether there was a match for the search.

This function retrieves an entire record with all elements and populates an associative array with the entries. It returns a class that is true if there was a match for the search, and false if nothing was retrieved.

Arguments:

• array: string - Array name - in the range: .*
• uri: string - URI - in the range: .*
• dn: string - Distinguished name - in the range: .*
• filter: string - Filter - in the range: .*
• scope: - Search scope policy - one of
  • subtree
  • onelevel
  • base
• security: - Security level - one of
  • none
  • ssl
  • sasl

dn specifies the distinguished name, an ldap formatted name built from components, e.g. "dc=cfengine,dc=com". filter is an ldap search, e.g. "(sn=User)". Which security values are supported depends on machine and server capabilities.

Example:

classes:

   "gotdata" expression => ldaparray(
                                    "myarray",
                                    "ldap://ldap.example.org",
                                    "dc=cfengine,dc=com",
                                    "(uid=mark)",
                                    "subtree",
                                    "none");