Skip to main content

ldap command

Use this command to display and configure the LDAP protocol configuration parameters.

The following table shows the arguments for the options.

Table 1. ldap command.

The following table is a multi-row three column table consisting of the options, option descriptions, and associated values for the options.

OptionDescriptionValues
-aUser authentication methodlocal only, LDAP only, local first then LDAP, LDAP first then local
-aomAuthentication only modeenabled, disabled
-bBinding methodanonymous, bind with ClientDN and password, bind with Login Credential
-cClient distinguished nameString of up to 127 characters for client_dn
-dSearch domainString of up to 63 characters for search_domain
-fGroup filterString of up to 127 characters for group_filter
-fnForest nameFor active directory environments. String of up to 127 characters.
-gGroup search attributeString of up to 63 characters for group_search_attr
-lLogin permission attributeString of up to 63 characters for string
-pClient passwordString of up to 15 characters for client_pw
-pcConfirm client passwordString of up to 15 characters for confirm_pw

Command usage is: ldap -p client_pw -pc confirm_pw

This option is required when you change the client password. It compares the confirm_pw argument with the client_pw argument. The command will fail if the arguments do not match.

-epEncrypted passwordBackup/restore password (internal use only)
-rRoot entry distinguished name (DN)String of up to 127 characters for root_dn
-rbsEnhanced Role-Based Security for active directory usersenabled, disabled
-s1ipServer 1 host name/IP addressString up to 127 characters or an IP address for host name/ip_addr
-s2ipServer 2 host name/IP addressString up to 127 characters or an IP address for host name/ip_addr
-s3ipServer 3 host name/IP addressString up to 127 characters or an IP address for host name/ip_addr
-s4ipServer 4 host name/IP addressString up to 127 characters or an IP address for host name/ip_addr
-s1pnServer 1 port numberA numeric port number up to 5 digits for port_number
-s2pnServer 2 port numberA numeric port number up to 5 digits for port_number
-s3pnServer 3 port numberA numeric port number up to 5 digits for port_number
-s4pnServer 4 port numberA numeric port number up to 5 digits for port_number
-tServer target nameWhen the rbs option is enabled, this field specifies a target name that can be associated with one or more roles on the Active Directory server through the Role-Based Security (RBS) Snap-In tool.
-uUID search attributeString of up to 63 characters for search_attrib
-vGet LDAP server address through DNSoff, on
-hDisplays the command usage and options 
Syntax:
ldap [<em className="ph i">options</em>]
options:
   -a <em className="ph i">loc|ldap|locld|ldloc</em> 
   -aom <em className="ph i">enable/disabled</em>
   -b <em className="ph i">anon|client|login</em>   
   -c <em className="ph i">client_dn</em>            
   -d <em className="ph i">search_domain</em>         
   -f <em className="ph i">group_filter</em>          
   -fn <em className="ph i">forest_name</em>
   -g <em className="ph i">group_search_attr</em>   
   -l <em className="ph i">string</em>               
   -p <em className="ph i">client_pw</em>            
   -pc <em className="ph i">confirm_pw</em>          
   -ep <em className="ph i">encrypted_pw</em>
   -r <em className="ph i">root_dn</em>               
   -rbs <em className="ph i">enable|disabled</em>
   -s1ip <em className="ph i">host name/ip_addr</em> 
   -s2ip <em className="ph i">host name/ip_addr</em> 
   -s3ip <em className="ph i">host name/ip_addr</em> 
   -s4ip <em className="ph i">host name/ip_addr</em> 
   -s1pn <em className="ph i">port_number</em>       
   -s2pn <em className="ph i">port_number</em>       
   -s3pn <em className="ph i">port_number</em>       
   -s4pn <em className="ph i">port_number</em>       
   -t <em className="ph i">name</em>
   -u <em className="ph i">search_attrib</em>        
   -v <em className="ph i">off|on</em>               
   -h