user-mgmt config-ldap

Configure LDAP settings.

Syntax

cpd-cli user-mgmt config-ldap \
--config=<ldap-configuration-file-name> \
--profile=<cpd-profile-name> \
[--cpdconfig=<cpd-configuration-location>] \
[--skip-verify-connection] \
[--verbose] \
[--verify-connection-password=<ldap-user-password>] \
[--verify-connection-username=<ldap-user-name>] \

Arguments

The config-ldap command has no arguments.

Options

Option Description
--config The LDAP configuration file.
Status
Required.
Syntax
--config=<ldap-configuration-file-name>
Default value
No default.
Valid values
A valid LDAP configuration file name.
--cpdconfig The Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpdconfig=<cpd-configuration-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--skip-verify-connection Skip connection verification and save the LDAP configuration.
Status
Optional.
Syntax
--skip-verify-connection
Default value
Not applicable.
Valid values
Not applicable.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--verify-connection-password The LDAP username password to use for connection verification. The password is not saved or recorded.
Status
Optional.
Syntax
--verify-connection-password=<ldap-user-password>
Default value
No default.
Valid values
A valid LDAP user password.
--verify-connection-username The LDAP username to use for connection verification. The username is not saved or recorded.
Status
Optional.
Syntax
--verify-connection-username=<ldap-user-name>
Default value
No default.
Valid values
A valid LDAP user name.

Table 1: Command options

Examples

Note: The following examples use the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up installation environment variables.

Configure LDAP with parameters from an ldap-config.json file.
cpd-cli user-mgmt config-ldap \
--config=ldap-config.json \
--profile=${CPD_PROFILE_NAME}

Sample ldap-config.json file.

{
  "externalLDAPHost": "ldap://9.87.654.321",
  "externalLDAPPort": 389,
  "externalLDAPSearchBase": "dc=wdp,dc=com",
  "externalLDAPSearchField": "cn",
  "externalLDAPSearchUser": "jdoe@wdp.com",
  "externalLDAPSearchPassword": "XXXXXXXXX"
}