Search <book_title>...

Veritas NetBackup™ Virtual Appliance Documentation

Last Published: 2017-07-25

Product(s): Appliances (3.0)

Name

Main > Settings > Security > Authentication > LDAP — configure and manage Lightweight Directory Access Protocol (LDAP) user registration and authentication on the appliance.

SYNOPSIS

Attribute

Certificate

ConfigParam

Configure

Disable

Enable

Export

Groups

Import

List

Map

Show

Status

Unconfigure

Users

DESCRIPTION

You can use the LDAP command to perform the following tasks:

Add or delete LDAP configuration attributes.
Set or show the trusted LDAP server certificate.
Set, unset, or show the various LDAP configuration parameters.
Configure the appliance for LDAP user authentication.
Disable LDAP user authentication.
Enable LDAP user authentication.
Export LDAP configuration as an XML file.
Add or remove one or more LDAP user groups.
Import LDAP configuration from an XML file.
List all LDAP users and user groups.
Add, delete, or show NSS map attributes or object classes.
Show the LDAP configuration.
Show the status of LDAP authentication.
Unconfigure LDAP user authentication for the appliance.
Add or remove one or more LDAP users.

OPTIONS

The following commands and options are available under Authentication > LDAP:

Attribute

Add or delete LDAP configuration attributes.

Use the Attribute Add <parameter_name> <attribute> command to add a new attribute.
Use the Attribute Delete <attribute_name> command to delete an existing attribute.

Certificate

Set, view, or disable the SSL certificate.

Use the Certificate Set <filename> command to enable and add the SSL certificate. The SSL certificate must be stored in the /inst/patch/incoming directory.
Note:
When you use the ssl=StartTLS and ssl=Yes options during LDAP or AD configuration on the appliance, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, establishing the SSL channel does not perform the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set <path> option.
Use the Certificate Show command to view the certificate applicable for the LDAP server.
Use the Certificate Unset command to disable the SSL certificate.

ConfigParam

Set, view, and unset the LDAP configuration parameters.

Note:

The ConfigParam command is only used to set the various LDAP configuration parameters. Once you set all of the necessary parameters, use the Configure command to enable the LDAP configuration and establish a connection with the LDAP server.

Use the ConfigParam Set command to add or change the following LDAP configuration parameters:
* Required parameters
- *ConfigParam Set base <base_DN>
  Enter the base directory name which is the top level of the LDAP directory tree.
- ConfigParam Set binddn <bind_DN>
  Enter the bind directory name. The bind DN is used as an authentication to externally search the LDAP directory within the defined search base.
- ConfigParam Set bindpw <password>
  Enter the password to access the LDAP server.
- ConfigParam Set directoryType <directoryType>
  Enter the LDAP directory type. The available options are: OpenLDAP, ActiveDirectory, and Others.
  Select OpenLDAP if you use a typical OpenLDAP directory service.
  Select ActiveDirectory if you use AD as an LDAP directory service.
  Select Others if you use a different type of LDAP directory service.
- ConfigParam Set groupList <group_name(s)>
  Enter the name of an existing LDAP user group that resides on the LDAP server. To enter multiple groups, separate each group name with a comma (,).
- *ConfigParam Set host <server_name or IP>
  Enter the FQDN or IP address of the LDAP server.
  Note:
  The specified LDAP server should comply with RFC 2307bis. The RFC2307bis specifies that hosts with IPv6 addresses must be written in their preferred form, such that all components of the address are indicated and leading zeros are omitted.
- *ConfigParam Set ssl <No|Yes|StartTLS>
  Enable SSL certificate for the LDAP server.
  Note:
  When you use the StartTLS and Yes options during LDAP configuration, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, the established SSL channel doesn't do the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set command.
- ConfigParam Set userList <user_name(s)>
  Enter the name of an existing LDAP user that resides on the LDAP server. To enter multiple users, separate each user name with a comma (,).
Use the ConfigParam Show command to view the existing LDAP configuration parameters.
Use the ConfigParam Unset <parameters> command to unset the LDAP configuration parameters.

Configure: After setting the LDAP parameters using the ConfigParam command, run the Configure command to complete the configuration and enable LDAP authentication on the appliance.

Disable: Disable LDAP user authentication on the appliance. This command does not remove the configuration and you can reenable it using the Enable command.

Enable: Enable a disabled LDAP configuration on the appliance.

Export <file_name>: Export the existing LDAP configuration as an XML file. The file is saved at /inst/patch/incoming/<file_name>. This file can be imported to configure LDAP on other appliances.

Groups

Add or remove one or more LDAP user groups. Only the user groups that already exist on the LDAP server can be added to the appliance.

Use the Groups Add <groupname> command to add a comma-separated list of LDAP user groups.
Use the Groups Remove <groupname> command to delete a comma-separated list of LDAP user groups.

Import <path>: Import the LDAP configuration from an XML file. The XML file must reside at /inst/patch/incoming/<file_name>.

List: List all of the LDAP users and user groups that have been added to the appliance.

Map

Add, delete, or show NSS map attributes.

Use the Map Add Attribute <attribute type> <attribute value> command to set an NSS map attribute.
Use the Map Delete Attribute <attribute type> command to delete an NSS map attribute.
Use the Map Show command to view the NSS map attributes.

Show: View the LDAP configuration details.
Status: View the status of LDAP authentication on the appliance.

Unconfigure: Unconfigure LDAP user authentication for the appliance.
Note:
Before you unconfigure the LDAP server, you must revoke the roles from all of the LDAP users that have been added to the appliance. Otherwise the operation fails.
Warning:
Unconfiguring LDAP user authentication disables and deletes the current LDAP configuration. The LDAP users are deleted from the appliance, but not from the LDAP server.

Users

Add or remove one or more LDAP users. Only the users that already exist on the LDAP server can be added to the appliance.

Use the Users Add <username> command to add a comma-separated list of LDAP users.
Use the Users Remove <username> command to delete a comma-separated list of LDAP users.
Note:
As a matter of best practice, you should delete a registered user or user group from the appliance before deleting it from the LDAP server, AD server, or NIS server. If a user is removed from the remote directory service first (and not removed from appliance), the user is listed as a registered user on the appliance but won't be able to log on.

EXAMPLES

Example 1 - Configure an association between the appliance and an LDAP directory server to enable the appliance to import users and user groups.

appliance123.LDAP > ConfigParam Set host ldap.example.com
appliance123.LDAP > ConfigParam Set base dc=sample,dc=com
appliance123.LDAP > ConfigParam Set ssl no
appliance123.LDAP > Configure
- [Info] Configure Successful. Continuing with Post-Configure Processing!
Configure Successful. Continuing with Post-Configure Processing!

Command was successful!

Example 2 - Register a user or user group from the LDAP directory server so that those users can be authorized and authenticated on the appliance.

appliance123.LDAP> Users Add ldapuser1,ldapuser2
Command was successful!
appliance123.LDAP> Groups Add ldapgroup01
Command was successful!
appliance123.Authorization> List

+----------------------------------------------------------+
|Principal Type|Name/login |Access | Role |Principal Source|
|--------------+-----------+-------+------+----------------|
|User          |ldapuser1  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|User          |ldapuser2  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|Group         |ldapgroup01|Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|  -Member     |ldapuser3  |Allowed|      |                |
+----------------------------------------------------------+

Command was successful!

Example 3 - Export the current LDAP configuration into an XML file that can be imported on other appliances.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!

Example 4 - Import an LDAP configuration from an XML file.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!