Articles in this section

ldap modify

Sara Levy
  • Updated
Follow

This command modifies an existing LDAP connection.

Usage

ldap modify --id ID
            [--urls URI_LIST]
            [--enable-auto-discovery|--disable-auto-discovery]
            [--enable-use-ldaps|--disable-use-ldaps]
            [--port PORT]
            [--binddn BIND_DN]
            [--bindpw BIND_PASSWORD]
            [--basedn BASE_DN]
            [--group-searchbase GROUP_BASE_DN]
            [--query-groups-mode COMPATIBLE|RFC2307BIS_ONLY|RFC2307_ONLY|NONE]
            [--method anonymous|simple]
            [--domain-name DOMAIN_NAME]
            [--use-tls|--no-tls]
            [--vms-auth|--no-vms-auth]
            [--advanced-settings-templates AD|Open_LDAP]
            [--posix-attributes-source JOINED_DOMAIN|ALL_DOMAINS|SPECIFIC_DOMAINS|GC]
            [--domains-with-posix-attributes DOMAINS]
            [--enable-query-posix-attributes-from-gc|--disable-query-posix-attributes-from-gc]
            [--gid-number ATTRIBUTE_NAME]
            [--uid ATTRIBUTE_NAME]
            [--uid-number ATTRIBUTE_NAME]
            [--member-uid ATTRIBUTE_NAME]
            [--posix-account ATTRIBUTE_NAME]
            [--posix-group ATTRIBUTE_NAME]
            [--match-user ATTRIBUTE_NAME]
            [--username-property-name ATTRIBUTE_NAME]
            [--user-login-name ATTRIBUTE_NAME]
            [--group-login-name ATTRIBUTE_NAME]
            [--mail-property-name ATTRIBUTE_NAME]
            [--uid-member-value-property-name ATTRIBUTE_NAME]

Notice

--posix-attributes-source and --domains-with-posix-attributes are available starting with VAST Cluster 4.6.0-SP5.

Notice

--enable-query-posix-attributes-from-gc and --disable-query-posix-attributes-from-gc are deprecated starting with VAST Cluster 4.6.0-SP5.

Required Parameters

--id ID

Identifies the LDAP configuration record to modify.

Options

--urls URI_LIST

If AD domain auto-discovery is disabled, 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 ldaps://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

--enable-auto-discovery

Enables Active Directory domain auto-discovery.

When auto-discovery is enabled, VAST Cluster automatically discovers and queries all domains and domain controllers in the Active Directory forest.

--disable-auto-discovery

Disables Active Directory domain auto-discovery.

When auto-discovery is disabled, the LDAP URI (--urls) and search base DN (--basedn) must be specified manually. VAST Cluster contacts only the domain controller configured using the --urls option and does not process requests from users in other domains in the Active Directory forest.

--enable-use-ldaps

Enables use of LDAP over TLS (LDAPS) for AD domain auto-discovery.

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.

--disable-use-ldaps

Disables use of LDAP over TLS (LDAPS) for AD domain auto-discovery.

--port PORT

Sets the port of the remote LDAP server. Recommended values: 389 for LDAP (with or without TLS), 636 for LDAPS.

--binddn BIND_DN

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.

You can specify any user account that has read access to the domain.

This bind DN must be set if --method simple is specified.

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 BIND_PASSWORD

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

This password must be set if --method simple is specified.

--basedn BASE_DN

If AD auto-discovery is disabled, specifies 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 on --group-searchbase.

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

Sets the entry in the LDAP directory tree to use as a starting point for group queries. If not specified, the base DN is used.

--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.

--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. If this method is specified, you have to set the bind DN on --binddn and password on --bindpw.

--domain-name DOMAIN_NAME

Sets the fully qualified domain name (FQDN) of the domain to join.

For example: --domain-name company-ad.com

--use-tls

Enables 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.

Important

Use VAST Web UI to provide a TLS certificate.

--no-tls

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

--vms-auth

If this option is specified, the LDAP configuration being created will be the one used for VMS authentication.

Note

Only two LDAP configurations are allowed, one with Active Directory (AD) and the other without AD.

--no-vms-auth

If this option is specified, the LDAP configuration being created will not be used for VMS authentication. This is the default setting.

--advanced-settings-templates AD|Open_LDAP

Sets the object classes that define user and group entries to preset values as defined in the template for Active Directory or Open LDAP standard.

To enable SMB client connection to the cluster, map LDAP attributes to the AD schema by specifying --advanced-settings-templates AD.

--posix-attributes-source JOINED_DOMAIN|ALL_DOMAINS| SPECIFIC_DOMAINS|GC

Determines domains from which VAST Cluster queries POSIX attributes. Options include:

  • JOINED_DOMAIN. The domain which VAST Cluster has joined.

  • ALL_DOMAINS. All domains in the Active Directory forest.

  • SPECIFIC_DOMAINS. One or more domains specified on the --domains-with-posix-attributes option.

  • GC. All domains included in the Active Directory global catalog. When this option is enabled, the global catalog must be configured with POSIX attributes.

Notice

This option is available starting with VAST Cluster 4.6.0-SP5.

--domains-with-posix-attributes DOMAINS

Provides a comma-separated list of the specific domains when --posix-attributes-source SPECIFIC_DOMAINS is specified.

For example: ad.example.com,domain.com

Notice

This option is available starting with VAST Cluster 4.6.0-SP5.

--enable-query-posix-attributes-from-gc

Notice

This option is deprecated starting with VAST Cluster 4.6.0-SP5. Use --posix-attributes-source instead.

Enables querying for POSIX attributes of users or groups from non-joined domains in the AD global catalog.

When this option is specified, the AD global catalog must be configured with POSIX attributes.

--disable-query-posix-attributes-from-gc

Notice

This option is deprecated starting with VAST Cluster 4.6.0-SP5. Use --posix-attributes-source instead.

Disables querying for POSIX attributes of users or groups from non-joined domains in the AD global catalog. This is the default setting.

Attribute Mapping Options

If your LDAP server uses attributes that differ from the default RFC2307-compliant attribute set that is used to query the LDAP server, these options map those attributes to the attribute names used on the server you are connecting the cluster to. This is typically needed for Active Directory.

Example: uid=cn --posix-account user --posix-group group

--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 gidNnumber

--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 member

--posix-account ATTRIBUTE_NAME

The object class that defines a user entry.

--posix-group ATTRIBUTE_NAME

The object class that defines a group entry.

--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.

Example: --match-user sAMAccountName

--username-property-name ATTRIBUTE_NAME

Overrides 'name' as the attribute to use for querying users in VMS user-initiated 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

--mail-property-name ATTRIBUTE_NAME

Specifies the attribute to use for the user's email address.

--uid-member-value-property-name ATTRIBUTE_NAME

Specifies the attribute which represents the value of the LDAP group's member property.

Example

vcli: admin> ldap modify --no-tls

Related articles

Comments

0 comments

Article is closed for comments.