LDAPURL

The LDAPURL option specifies the location of a Lightweight Directory Access Protocol (LDAP) server. Set the LDAPURL option after you configure the LDAP server.

Tip: The information in this documentation applies to the LDAP authentication method that is preferred for IBM Spectrum Protect V7.1.7 or later servers. For instructions about using the previous LDAP authentication method, see Managing passwords and logon procedures.
The following restrictions apply:
  • The LDAPURL option cannot be used in combination with the SETOPT command.
  • The LDAPURL option does not apply to storage agents.

Syntax


1  LDAPURL ldap_url_value

Parameters

ldap_url_value
Specifies the URL of one LDAP or LDAPS server, or the URLs of multiple LDAP or LDAPS servers. You can enter multiple values, with each URL value up to 1024 characters. The port number is optional and defaults to 389 for LDAP and to 636 for LDAPS. Each URL value must contain an LDAP server name. For example, the format of the server name is server1.storage.us.example.com and the LDAP port is 341.

LDAPS uses a Secure Sockets Layer (SSL) connection to send LDAP data. To define an LDAPS server address, specify a URL that begins with ldaps://.

The value of the LDAPURL option must conform to the following specifications:
  • If you specify multiple URLs, each URL must be on a separate line.
  • When you specify multiple LDAPURL server option values, they must be either all LDAPS addresses or all LDAP addresses.
  • Each URL must begin with ldap:// or ldaps://.

    When ldap:// is specified, IBM Spectrum Protect supports LDAP connections that are secured with the standard LDAPv3 StartTLS operation, which establishes a secure Transport Layer Security (TLS) exchange on an existing LDAP connection. The LDAP Simple Bind operation that IBM Spectrum Protect uses does not protect the password when it is sent. A secure TLS connection is required to protect the password.

Example: Set the port value for an LDAP server

In the dsmserv.opt file, specify the port value as 341 for an LDAP server:
ldapurl ldap://server1.storage.us.example.com:341

Example: Set the port value for an LDAPS server

In the dsmserv.opt file, specify the port value as 636 for an LDAPS server:
ldapurl ldaps://server2.storage.us.example.com:636