Use this procedure to configure a connection to an LDAP-based directory server to use the server as an authorization provider for NFS access. This can be an Active Directory domain controller. However, if you are using this Active Directory domain controller to authenticate and authorize SMB users, the cluster needs to join the Active Directory domain and you should follow the complete joining procedure instead: see Joining Active Directory.
From the left navigation menu, select User Management and then LDAP.
If no LDAP configuration is displayed, click Create LDAP to create one. If an LDAP configuration record is already displayed, click to open the Actions menu for the existing LDAP configuration and select Edit.
Enter the details of your LDAP server:
URLs (required if Auto-discovery is off)
This field is available only if Auto-discovery is disabled.
Enter a comma-separated list of URIs of LDAP servers (Domain Controllers (DCs) in Active Directory). The order of listing defines the priority order. The URI with highest priority that has a good health status is used.
Specify each URI in the format
<address>can be either a DNS name or an IP address.
When enabled, VAST Cluster automatically discovers and queries all domains and domain controllers in the Active Directory forest. For more information, see AD Domain Auto-Discovery.
When disabled, the LDAP URI ( URLs ) and search base DN ( Base DN ) fields must be specified manually. VAST Cluster contacts only the domain controller configured in the URLs field and does not process requests from users in other domains in the Active Directory forest.
The port of the remote LDAP server.
389for LDAP (with or without TLS),
The recommended values are required if Auto-discovery and Use TLS are enabled. Failing to set the recommended port value can cause LDAP to disconnect.
Enables or disables use of LDAP over TLS (LDAPS) if Auto-discovery is enabled.
When enabled, VAST Cluster connects to an alternative port (port 636 for the domain controller, port 3269 for the Global Catalog) and initiates a TLS handshake immediately afterwards.
Authentication method (required)
The authentication method the LDAP server uses to authenticate VAST Cluster as a client querying the LDAP database. Set the method according to how the LDAP server is configured to authenticate clients. The following options are available:
Anonymous. The LDAP server accepts queries without any authentication.
Simple. The LDAP server attempts to bind a specified user name to a matching LDAP user. If the LDAP bind succeeds, VAST Cluster is allowed access to perform the query. If this method is selected, you have to set Bind DN and Bind password.
This field is available only if Auto-discovery is disabled.
The entry in the LDAP directory tree to use as a starting point for user queries. By default, this is also used as the starting point for group queries. Optionally, you can specify a different entry as the Group Base DN.
To maximize the speed of authentication queries, start the search in the lowest branch of the tree under which all users can be found. For example, if the entire directory must be queried, the search base must specify the root of the tree. However, if the search can be restricted to a specific organizational unit (OU), queries may be faster.
The format for base DN is a comma separated list of components. Each component is an attribute=value pair defining an object in the directory tree. The first component defines the object at the lowest part of the tree that you want to use as the starting point of the search, the next component is its container and so on up the tree, with the last component representing the top level domain.
The following attributes can be specified:
cn: common name
ou: organizational unit
For example, supposing your user accounts are all located in a container called 'users' under a domain 'mydomain.local'. If you want to set the users container as the starting point for search queries, you would enter:
To specify the full domain as your search base, you would enter:
Bind DN (required if Authentication method is set to Simple)
Enter the bind DN for authenticating to the LDAP domain. The bind DN specifies the user with which VAST Cluster authenticates to the LDAP directory. You can specify any user account that has read access to the domain.
Format is as described for Base DN beginning with a cn attribute component specifying the user object.
cn=admin,ou=users,dc=mydomain,dc=localspecifies user 'admin' located in the 'users' container under the domain 'mydomain.local'.
Bind password (required if Authentication method is set to SImple)
This field appears if Simple is selected in the Method field. This is the password used with the Bind DN to authenticate to the LDAP server.
Sets the mode for querying a users' auxiliary group memberships, where applicable:
Group memberships may or may not be queried during access checks depending on the Group Membership Source setting in the view policy.
Compatible (default). Groups are queried using an aggregate of the RFC2307BIS and RFC2307 compliant group membership queries (see the other options). You can use this default option unless you are using an authentication provider which is incompatible with this aggregated query mode.
RFC2307BIS only. Auxiliary group memberships are queried according to the RFC2307BIS standard, in which the group has a member attribute that contains the Distinguished Name (DN) of the member user and the user has a memberOf attribute which contains the DNs of the groups to which the user belongs. This standard is used by Active Directory and may be used with other LDAP-based authorization providers with LDAP schema extensions.
RFC2307 only. Auxiliary group memberships are queried according to the RFC2307 standard, in which the group object has a memberUid attribute for each user object that is a member of the group, specifying the name of the user object. This standard may be used by openLDAP, freeIPA and other LDAP-based authorization providers.
None. If this option is selected, auxiliary group memberships are not queried at all. In the event that the relevant view's view policy cites the authorization provider as the group membership source and the user tries to access a file or directory within that view to which the user only has permission as a member of a the owning user's group, permission will not be granted.
Enable to use TLS (STARTTLS) to secure communication between VAST Cluster and the LDAP server.
When enabled, VAST Cluster connects to the standard port (port 389 for the domain controller, port 3268 for the Global Catalog) and performs a StartTLS operation as defined in RFC 4513.
If Use TLS is enabled, use this field to provide a certificate if you want the cluster to verify the LDAP server's TLS certificate. The remote LDAP server's TLS certificate will be verified against the certificate you provide. If the certificate you provide does not list the certificate authority (CA) of the server's certificate, the cluster will fail to establish a connection with the LDAP server.
If you choose to leave this field blank, the VAST Cluster's TLS client will not request the LDAP server's TLS certificate and will ignore any certificate received.
Regardless of this field's value, ensure that the LDAP server is not configured to request client certificates (
TLSVerifyClientshould be set to
never). Otherwise, connections will fail.
Click Advanced-attribute mappings to make sure that the correct object class names will be used to query provider's entries and ensure that the user authorization process will find users and groups on the provider.
Do the following:
Select a template from the Templates for advanced setting dropdown. This fills the attribute mapping fields with a base set of values before you make any custom modifications:
AD. Fills all the attribute mapping fields with RFC2307BIS-compliant values, typically used in Active Directory.
This value is required to enable SMB access to the cluster.
OpenLDAP. Fills all the attribute mapping fields with RFC2307-compliant values, used by OpenLDAP and other LDAP-based providers.
Custom. Presents you with mostly empty fields to fill with custom values.
In the Group base DN field, specify the entry in the AD directory tree to use as a starting point for group queries. By default, the Base DN is used.
Check that the values are set correctly for your provider, and make changes as needed. Consult the following table for a description of each value you need to specify:
Click Create or Update.
The LDAP client configuration is created/updated.
To connect to an LDAP server, use the following CLI commands.
For full CLI command syntax, including arguments, enter the command at the CLI prompt in the <command> <subcommand> format provided in the table, followed by ?.
To display details of a configured LDAP connection:
From the VAST Web UI, select the LDAP tab in the User Management page.
From the VAST CLI, run
ldap list. or
The state of the LDAP connection reflects the health status of the configured DCs as follows:
Connected: All DCs are connected.
Failed: All DCs have failed.
Degraded: Some DCs have failed and at least one DC is connected. The URIs of the failed DCs are reported by an alarm.