Skip to main content

vserver modify

Contributors
Suggest changes
PDFs

Modify a Vserver

Availability: This command is available to cluster administrators at the admin privilege level.

Description

The vserver modify command modifies the attributes of a specified Vserver. If the Vserver subtype is of type dp-destination , then only the -aggr-list parameter can be modified.

Parameters

-vserver <vserver> - Vserver

This specifies the Vserver that is to be modified.

[-language <Language code>] - Default Volume Language Code

This optional parameter specifies the default language encoding setting for the Vserver and its volumes. The recommended format is to append .UTF-8 for the language encoding values. For example, for the en_US language, the recommended format is en_US.UTF-8 . The default setting is C.UTF-8 .

[-snapshot-policy <snapshot policy>] - Snapshot Policy

This optional parameter specifies the snapshot policy for new volumes created on the Vserver. Changing the snapshot policy for a Vserver will not change the snapshot policy for the existing volumes within the Vserver and it will only be applicable for the new volumes that will be created later. You can use the -snapshot-policy parameter with the volume create or volume modify commands to set the snapshot policy on a specific volume, regardless of its Vserver's snapshot policy setting.

[-comment <text>] - Comment

This optional parameter specifies a comment for the Vserver.

[-quota-policy <text>] - Quota Policy

This optional parameter specifies a quota policy to be used for all volumes associated with a Vserver. You can create and configure multiple, different quota policies, but each Vserver must have one and only one associated quota policy.

[-aggr-list <aggregate name>,…​] - List of Aggregates Assigned

This optional parameter specifies a confined list of aggregates on which volumes can be created for a Vserver by the Vserver administrator. But these aggregates do not become exclusive property of the Vserver, i.e. they might be assigned for use to other Vservers. If the value of this parameter is specified as "-", then the Vserver administrator cannot create any volumes for that Vserver. Note that the cluster administrator will still be able to create volumes on any aggregate and assign them to this Vserver.

[-max-volumes <integer_or_unlimited>] - Limit on Maximum Number of Volumes allowed

This optional parameter specifies the maximum number of volumes that can be created for the Vserver, including the root volume.

[-admin-state {running|stopped|starting|stopping|initializing|deleting}] - Vserver Admin State (privilege: advanced)

Use this parameter to set the admin state of the Vserver if the Vserver start or stop job fails. Possible values include running and stopped.

[-allowed-protocols {nfs|cifs|fcp|iscsi|ndmp|nvme|s3}] - Allowed Protocols

This optional parameter specifies the list of protocols to be allowed to run on the Vserver. When part of vserver-modify, this field should include the existing list along with the new protocol list to be added to prevent data disruptions. Possible values include nfs, cifs, fcp, iscsi, ndmp and nvme.

[-disallowed-protocols {nfs|cifs|fcp|iscsi|ndmp|nvme|s3}] - Disallowed Protocols

This optional parameter specifies the list of protocols to be disallowed to run on the Vserver. When part of vserver-modify, this field should include the existing list along with the new protocol list to be added to prevent data disruptions. Possible values include nfs, cifs, fcp, iscsi, ndmp and nvme.

[-qos-policy-group <text>] - QoS Policy Group

This optionally specifies which QoS policy group to apply to the Vserver. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a Vserver, the system will not monitor and control the traffic to it. To remove this Vserver from a policy group, enter the reserved keyword "none".

[-caching-policy <text>] - Caching Policy Name

This optionally specifies the caching policy to apply to the Vserver. A caching policy defines how the system caches this volume's data in Flash Cache modules. If a caching policy is not assigned to this Vserver, the system uses the default cluster-wide policy. The available caching policies are:

  • none - Does not cache any user data or metadata blocks.

  • auto - Read caches all metadata and randomly read user data blocks, and write caches all randomly overwritten user data blocks.

  • meta - Read caches only metadata blocks.

  • random_read - Read caches all metadata and randomly read user data blocks.

  • random_read_write - Read caches all metadata, randomly read and randomly written user data blocks.

  • all_read - Read caches all metadata, randomly read, and sequentially read user data blocks.

  • all_read_random_write - Read caches all metadata, randomly read, sequentially read, and randomly written user data.

  • all - Read caches all data blocks read and written. It does not do any write caching.

Default caching-policy is auto.

[-is-space-reporting-logical {true|false}] - Logical Space Reporting

This optionally specifies whether to report space logically on residing volumes which are created after this operation. Existing volumes will not be affected by modifying this value on an existing Vserver. To change whether space is reported logically for existing volumes, you will have to modify the setting on those volumes. When space is reported logically, ONTAP reports the volume space such that all the physical space saved by the storage efficiency features are also reported as used.

[-is-space-enforcement-logical {true|false}] - Logical Space Enforcement

This optionally specifies whether to perform logical space accounting on residing volumes which are created after this operation. Older volumes will continue to have old value. When space is enforced logically, ONTAP enforces volume settings such that all the physical space saved by the storage efficiency features will be calculated as used.

[-anti-ransomware-default-volume-state {disabled|dry-run}] - Default Anti_ransomware State of the Vserver's Volumes

This optional parameter specifies the default anti_ransomware state for the volumes in the Vserver. When this is dry_run, all the volumes created henceforth will by default have anti_ransomware state as dry-run. Similarly, when this is disabled, all the volumes created henceforth will by default have anti_ransomware state as disabled.

[-auto-enable-analytics {true|false}] - Enable Analytics on New Volumes

This optional parameter specifies whether analytics is automatically enabled for the volumes in the Vserver that is being modified. The default value is false.

[-auto-enable-activity-tracking {true|false}] - Enable Activity Tracking on New Volumes

This optional parameter specifies whether activity tracking is automatically enabled for the volumes in the Vserver that is being modified. The default value is false.

[-storage-limit {<integer>[KB|MB|GB|TB|PB]}] - Storage Limit

This parameter specifies the storage size limit for a Vserver. This parameter can be set to zero to disable storage-limit enforcement on a Vserver. Default value is 0.

[-storage-limit-threshold-alert <percent>] - Storage Limit Threshold Alert

This parameter specifies when the "vserver.storage.threshold" event log message is generated. This parameter can be set to zero to disable "vserver.storage.limit.threshold.exceeded" event log message. Default value is 90%.

[-anti-ransomware-auto-switch-from-learning-to-enabled {true|false}] - Anti-ransomware Auto-switch from Learning to Enabled

This optional parameter specifies whether anti-ransomware will be automatically enabled on the volumes in the Vserver that is being modified. The default value when creating a Vserver is true .

[-anti-ransomware-auto-switch-minimum-incoming-data-percent <percent>] - Anti-ransomware Auto-switch Minimum Incoming Data (in percentage)

This optional parameter specifies minimum incoming writes (in percentage) required to automatically enable anti-ransomware on volumes in the Vserver. The default value when creating a Vserver is 5%.

[-anti-ransomware-auto-switch-duration-without-new-file-extension <integer>] - Anti-ransomware Auto-switch Duration Without New File Extension (in Days)

This optional parameter specifies number of days without a new incoming extension to automatically enable anti-ransomware on volumes in the Vserver. The default value when creating a Vserver is 3 days.

[-anti-ransomware-auto-switch-minimum-learning-period <integer>] - Anti-ransomware Auto-switch Minimum Learning Period

This optional parameter specifies minimum number of days a volume in the Vserver must be in learning mode to automatically enable anti-ransomware. The default value when creating a Vserver is 10 days.

[-anti-ransomware-auto-switch-minimum-file-count <integer>] - Anti-ransomware Auto-switch Minimum File Count

This optional parameter specifies minimum number of new files created in volume to automatically enable anti-ransomware on volume in the vserver. The default value when creating a Vserver is 200 .

[-anti-ransomware-auto-switch-minimum-file-extension <integer>] - Anti-ransomware Auto-switch Minimum File Extension

This optional parameter specifies minimum number of new file extensions in a volume to automatically enable anti-ransomware on volume in the vserver. The default value when creating a Vserver is 10 .

Examples

The following example modifies the quota policy for a Vserver named vs0.example.com to pol1, specifies a snapshot policy named daily, adds the comment "Sales team access".

cluster1::> vserver modify -vserver vs0.example.com -snapshot-policy daily
    -comment "Sales team access" -quota-policy pol1