ldapsearch

Description

Perform LDAP search operations in the Metrics Engine.

This tool can search the directory for a single entry or multiple entries in a particular subtree. A filter can be used to restrict the entries returned.

At least one search filter must be specified for all searches. The --filename option can be used to include multiple filters. If multiple filters are specified, all trailing arguments are considered to be attributes.

Attribute names can be specified as space-separated trailing arguments to restrict the information that is returned for each entry. If no attributes are specified, all non-operational attributes are returned. The attributes returned can be restricted by specifying a space-separated list of attributes as trailing arguments, resulting in only those attributes being returned. If operational attributes are desired in the result, they must be specified in this way or with a '+' which results in all operational attributes being returned.

Examples

ldapsearch --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN uid=jdoe,ou=People,dc=example,dc=com --searchScope base \
     '(objectclass=*)'

ldapsearch --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN ou=People,dc=example,dc=com --searchScope sub "(uid=jdoe)"

ldapsearch --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN ou=People,dc=example,dc=com --searchScope one '(objectclass=*)' \
     sn givenName "+"

ldapsearch --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN ou=People,dc=example,dc=com --searchScope sub \
     --sortOrder sn,-givenName '(objectclass=*)'

ldapsearch --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --baseDN ou=People,dc=example,dc=com --searchScope sub --sizeLimit 200 \
     --timeLimit 5 "(&(sn<=Doe)(employeeNumber<=1000))" ds-entry-unique-id \
     entryUUID

Arguments

-H
--help

--help-ldap

--help-sasl

--help-debug

--propertiesFilePath {propertiesFilePath}

--noPropertiesFile

--script-friendly

-h {host}
--hostname {host}

-p {port}
--port {port}

-Z
--useSSL

-q
--useStartTLS

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-b {baseDN}
--baseDN {baseDN}

-s {searchScope}
--searchScope {searchScope}

-f {file}
--filename {file}

-r
--useSASLExternal

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-K {keyStorePath}
--keyStorePath {keyStorePath}

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

-N {nickname}
--certNickname {nickname}

-P {trustStorePath}
--trustStorePath {trustStorePath}

-Y {authzID}
--proxyAs {authzID}

-E
--reportAuthzID

--usePasswordPolicyControl

-C ps[:changetype[:changesonly[:entrychgcontrols]]]
--persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]

--simplePageSize {numEntries}

--assertionFilter {filter}

--matchedValuesFilter {filter}

-S {sortOrder}
--sortOrder {sortOrder}

-G {before:after:index:count | before:after:value}
--virtualListView {before:after:index:count | before:after:value}

-J {controloid[:criticality[:value|::b64value|:
--control {controloid[:criticality[:value|::b64value|: