activedirectory modify

Prev Next

This command makes the cluster join or leave an Active Directory domain, and also lets you modify SMB-related access settings.

Usage
activedirectory modify  --id ID
                        --admin-username USERNAME
                       [--admin-passwd PASSWORD]
                       [--join|--leave]
                       [--allow-smb|--disallow-smb]
                       [--enable-ntlm|--disable-ntlm]
Required Parameters

--id ID

Identifies the Active Directory configuration. To obtain the ID of an Active Directory configuration record, run activedirectory list.

--admin-username USERNAME

Specify an Active Directory admin user with permission to join the Active Directory domain.

Options

--admin-passwd PASSWORD

Specify the password for the specified user. If not supplied, you are prompted for the password.

Note

VAST Cluster does not store this password.

--join

Include this option to join the Active Directory domain.

--leave

Include this option to leave the Active Directory domain.

--allow-smb

When this option is specified, VAST Cluster uses this Active Directory provider to authenticate and authorize clients accessing the cluster via the SMB storage protocol.

Tip

Before allowing use of this Active Directory provider for SMB access, leave the cluster's joined Active Directory domain. After SMB is allowed, rejoin the domain.

--disallow-smb

Disables use of this Active Directory provider for SMB client access.

Tip

Before disabling use of this Active Directory provider for SMB access, leave the cluster's joined Active Directory domain. After SMB is disallowed, rejoin the domain.

--enable-ntlm

When this option is specified, SMB clients accessing the cluster are allowed to use NTLM authentication to get authenticated via this Active Directory provider. This is the default behavior.

Note

NTLM authentication is not FIPS-compliant.

Tip

Before enabling NTLM, leave the cluster's joined Active Directory domain. After NTLM is enabled, rejoin the domain.

--disable-ntlm

Prohibits use of NTLM authentication on this Active Directory provider.

Tip

Before disabling NTLM, leave the cluster's joined Active Directory domain. After NTLM is disabled, rejoin the domain.

Example

This example shows the cluster joining to an Active Directory domain.

vcli: admin> activedirectory modify --id 1 --join --admin-username myuser
Are you sure you want to modify the Active directory? [y/N] y
Enter admin password:
Password:

Waiting ...

[2020-03-31 10:18:39] waiting for active directory AD enabled state to change to True ...\

[2020-03-31 10:19:45] modify active directory completed successfully .../