This command modifies a tenant.
Usage
tenant modify --id ID
[--enable-privileged-domain-user-restore-access]|[--disable-privileged-domain-user-restore-access]
[--enable-privileged-domain-group-backup-access]|[--disable-privileged-domain-group-backup-access]
[--enable-privileged-domain-group-restore-access]|[--disable-privileged-domain-group-restore-access]
[--privileged-domain-user-logon-name]
[--privileged-domain-group-sid SID]
[--local-administrators-group-name NAME]
[--default-others-share-level-perm FULL|READ|CHANGE]
[--trash-gid TRASH_GID]
[--client-ip-ranges IP_RANGES]
[--posix-primary-provider AD|LDAP|NIS]
[--login-name-primary-provider AD|LDAP|NIS]
[--ad-provider-id ID]
[--detach-ad-provider]
[--ldap-provider-id ID]
[--detach-ldap-provider]
[--nis-provider-id ID]
[--detach-nis-provider]
[--enable-use-smb-native|--disable-use-smb-native]
[--enable-require-smb-signing|--disable-require-smb-signing]
[--enable-nfs-v4.2]|[--disable-nfs-v4.2]
[--local-provider-id ID]
[--preferred-owning-group PROTOCOL_BASED|POSIX_GID]
[--allowed-delegations READ|WRITE|READ_WRITE|NONE]
[--enable-grant-unrequested-delegations-by-default|--disable-grant-unrequested-delegations-by-default]
[--smb-encryption-state OFF|AVAILABLE|DESIRED|REQUIRED]
[--max-views MAX]
[--capacity-rules CAPACITY_RULES]
[--static-limits STATIC_LIMITS|--reset-static-limits]
Required Parameters
| Specifies which tenant to modify. |
Options
| Enables the privileged SMB user. |
| Disables the privileged SMB user. |
| Enables the privileged SMB group. |
| Disables the privileged SMB group. |
| Enables read and write control access for the privileged SMB user group. Members of the group can perform backup and restore operations on all files and directories, without requiring read or write access to the specific files and directories. |
| Disables write control access for the SMB privileged user group. If enabled (see |
| An optional custom user name for the SMB or NFSv4.1 privileged user. If not set, the user name is 'vastadmin' in the cluster's joined domain'. |
| Specify a custom group SID in order to have a working SMB or NFSv4.1 privileged group with backup operator privileges. If not set, the SMB privileged group is set to the Backup Operators domain group (S-1-5-32-551), which, due to a known issue, does not receive backup operator privileges. |
| Specify a custom name for the privileged SMB group. If not specified, the privileged SMB group name is Backup Operators. |
| Sets the default 'Everyone' Group SMB share-level permission for the tenant. This default permission affects all views in which share-level ACL is disabled. For more information about SMB share-level permissions, see Share-Level ACLs. Possible values:
|
| If you want to allow access to the trash folder for non-root NFSv3 users serviced by the tenant, specify this option and provide the GID of the user group that you want to use for this purpose as By default, the operation of moving files into the trash folder is supported for the root user only. |
| Specifies an array of ranges of client IPs to be served by the tenant. Specify For example: See Overview of Tenants for more information about dedicating virtual IP pools to tenants and associating client IPs to a tenant. |
| Specifies one provider to take precedence over other providers in case of any conflicts between attribute values when user information is retrieved from the providers. Applicable if more than one provider is enabled (see |
| Determines which authorization provider is the primary provider for the user’s login name. Applicable if more than one provider is enabled (see |
| Specify up to one Active Directory configuration by its ID in order to enable it for the tenant. Providers configured on the cluster are available for you to select up to one of each type (Active Directory, LDAP and NIS), subject to combination restrictions per tenant described in Authorization Providers in VAST Cluster. |
| Detaches a previously connected Active Directory provider from the tenant. |
| Specify up to one LDAP server configuration by its ID in order to enable it for the tenant. Providers configured on the cluster are available for you to select up to one of each type (Active Directory, LDAP and NIS), subject to combination restrictions per tenant described in Authorization Providers in VAST Cluster. |
| Detaches a previously connected LDAP provider from the tenant. |
| Specify up to one NIS configuration by its ID in order to enable it for the tenant. Providers configured on the cluster are available for you to select up to one of each type (Active Directory, LDAP and NIS), subject to combination restrictions per tenant described in Authorization Providers in VAST Cluster. |
| Detaches a previously connected NIS provider from the tenant. |
| When this option is specified, VAST Cluster authorizes client access by using user and group information supplied via Kerberos or NTLM authentication, rather than by querying that user in Active Directory. For more information, see Authentication for SMB Access. |
| Disables use of Kerberos or NTLM authentication to authorize SMB client access. This is the default setting.
|
| When specified, SMB clients are required to sign SMB requests. SMB requests with missing or invalid signatures are not accepted. |
| When specified, SMB clients are not required to sign SMB requests. |
| Enables support of NFS version 4.2 for this tenant.
|
| Disables support of NFS version 4.2 for this tenant. |
| Specifies a local provider with which the tenant is associated. |
| Controls the way VAST Cluster sets the owning group when creating files on a view controlled with the SMB and Mixed Last Wins security flavor:
|
| Enables/disables SMB encryption for the tenant, and also sets the encryption protection level:
|
| Set the maximum number of views the tenant can have to MAX. A value of 0 indicates unlimited views. Default: 0 |
NFSv4 File Delegation Options
| Enables NFSv4 file delegations for the tenant and specifies the type of NFSv4 file delegations that the cluster can grant to a client opening a file: read, write, or both. A value of Valid values: |
| If specified, the cluster grants the allowed delegations even when the client does not explicitly request a delegation. This is the default behavior. |
| If specified, the cluster does not grant the allowed delegations to clients that do not explicitly request a delegation. |
Capacity and Performance Limits (QoS)
Note
With VAST Cluster 5.4, block protocol operations are not subject to tenant's capacity and performance limitations.
| Enables and sets capacity limits for the tenant. Specify
For example:
|
| Enables and sets static performance limits for the tenant. Specify
For example:
|
| Disables static performance limits for the tenant. |
Example
vcli: admin> tenant modify --id 3 --client-ip-ranges 10.10.10.1,10.10.10.9 10.10.10.200,10.10.10.240 --detach-ad-provider --ldap-provider-id 2