Articles in this section

ldap modify

Sara Levy
  • Updated
Follow

This command modifies an existing LDAP connection.

Usage
ldap modify [--id ID]
            [--urls URI]
            [--port PORT]
            [--binddn BINDDN]
            [--bindpw BINDPW]
            [--basedn BASE_DN]
            [--group-searchbase GROUP_BASE_DN]
            [--method simple|anonymous]
            [--gid-number ATTRIBUTE_NAME]
            [--uid ATTRIBUTE_NAME]
            [--uid-number ATTRIBUTE_NAME]
            [--member-uid ATTRIBUTE_NAME]
            [--match-user ATTRIBUTE_NAME]
            [--use-tls]
            [--no-tls]
            [--query-groups-mode COMPATIBLE|RFC2307BIS_ONLY|RFC2307_ONLY|NONE]
            [--username-property-name ATTRIBUTE_NAME]
            [--user-login-name ATTRIBUTE_NAME]
            [--group-login-name ATTRIBUTE_NAME]
            [--posix-templates AD|Open_LDAP]
Options

--id ID

Specifies the LDAP configuration record to modify by ID.

--urls URI_LIST

Sets the URIs of the remote LDAP server's domain controllers (DCs) and their priority order.

Specify URI_LIST as a comma separated list of URIs in the format <scheme>://<address>. The order of listing defines the priority order. The DC with highest priority that has a good health status is used.

Examples:

  • --urls ldap://company-ad.com

  • --urls ldap://company-ad.com,ldap://company-ad2.com

  • --urls ldap://192.0.2.0,ldap://192.0.2.1,ldap://192.0.2.2

--port PORT

Sets the port of the remote LDAP server. Typical value: 389.

--binddn BINDDN

Sets the bind DN for authenticating to the LDAP server. The bind DN specifies the user with which VAST Cluster authenticates to the LDAP directory.

The format is a comma separated list of components. Each component is an attribute=value pair defining an object in the directory tree. The first component is a cn attribute component specifying the user object, 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

  • o: organization

  • c: country

  • dc: domain

For example, cn=admin,ou=users,dc=mydomain,dc=local specifies user 'admin' located in the 'users' container under the domain 'mydomain.local'.

--bindpw BINDPW

Sets the password used with the Bind DN to authenticate to the LDAP server.

This password must be set if method is set to simple.

--basedn BASE_DN

Specifies the entry in the LDAP directory tree to use as a starting point for user queries.

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.

Specify BASE_DN as 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

  • o: organization

  • c: country

  • dc: domain

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: --basedn ou=users,dc=mydomain,dc=local

--group-searchbase GROUP_BASE_DN

(From VAST Cluster 3.0.1) Sets the entry in the LDAP directory tree to use as a starting point for group queries. See Base DN.

--method simple|anonymous

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. Set also Bind DN and Bind password.

--gid-number ATTRIBUTE_NAME

The attribute of a group entry that contains the GID number of a group.

Default: gidNumber

Example for Active Directory: --gid-number gidnumber

--uid ATTRIBUTE_NAME

The attribute of a user entry that contains the user name.

Default: uid

Example for Active Directory: --uid sAMAccountname

--uid-number ATTRIBUTE_NAME

The attribute of a user entry that contains the UID number.

Default: uidNumber

--member-uid ATTRIBUTE_NAME

The attribute of the group entry that contains names of group members.

Example for Active Directory: --member-uid memberUID

--match-user ATTRIBUTE_NAME

Use this option to specify which attribute to use for matching users across providers during user refresh and user authentication. When querying a provider for a user that matches a user that was already retrieved from another provider, a user entry that contains a matching value in this attribute will be considered the same user as the user previously retrieved.

use-tls

Enables TLS to secure communication between VAST Cluster and the LDAP server.

Important

The VAST Cluster TLS client is configured with the TLS_REQCERT configuration parameter set to never, which means it does not request the server's TLS certificate and ignores any certificate received. On the TLS server, make sure that TLS_REQCERT is not set to demand since VAST Cluster cannot connect to a server with TLS_REQCERT set to demand.

Verification of the server's TLS certificate will be added in a future release.

no-tls

Disables TLS secure communication between VAST Cluster and the LDAP server.

--query-groups-mode COMPATIBLE|RFC2307BIS_ONLY|RFC2307_ONLY|NONE

The mode for querying a user's auxiliary group memberships, when the auth provider is set as the source for group membership 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 members 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.

--username-property-name ATTRIBUTE

Overrides 'name' as the attribute to use for querying users in VMS user-initated user queries.

--user-login-name ATTRIBUTE_NAME

Specifies the attribute used to query AD for the user login name in NFS ID mapping. Applicable only with AD and NFSv4.1.

For example: --user-login-name sAMAccountname

--group-login-name ATTRIBUTE_NAME

Specifies the attribute used to query AD for the group login name in NFS ID mapping. Applicable only with AD and NFSv4.1.

For example: --group-login-name sAMAccountname

--posix-templates AD|Open_LDAP

Sets the object classes that define user and group entries to a preset template for Active Directory or Open LDAP standard.
Example
vcli: admin> ldap modify --no-tls

Related articles

Comments

0 comments

Article is closed for comments.