Skip to main content

vserver create

Contributors
Suggest changes
PDFs

Create a Vserver

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

Description

The vserver create command creates a Vserver.

Parameters

-vserver <vserver> - Vserver

This specifies the name of the Vserver that is to be created. Use a fully qualified domain name (FQDN) - for example, "data.example.com" - for the Vserver to ensure unique Vserver names across cluster leagues.

Note Maximum number of characters supported is 47, and 41 for a Vserver with subtype "sync-source". "all" is a reserved name and must not be used as a Vserver name.
[-subtype <vserver subtype>] - Vserver Subtype

This specifies the subtype of the Vserver being created. Possible values are:

  • default - For default data Vservers

  • dp-destination - For Data Protection destination Vservers

  • sync-source - For MetroCluster source Vservers

  • sync-destination - For MetroCluster destination Vservers

[-rootvolume <volume name>] - Root Volume

This parameter optionally specifies the name of the Vserver's root volume, which is created when the Vserver is created. The default name is vserverName_root . The size of the Vserver's root volume is 1GB

[-aggregate <aggregate name>] - Aggregate

This parameter optionally specifies the storage aggregate that holds the Vserver's root volume. Selection of the aggregate is based on the Vserver setup algorithm.

  • Creating a root volume on the SnapLock aggregate is not supported.

  • Creating a root volume of sync-source Vserver on the unmirrored aggregate is not supported.

[-rootvolume-security-style <security style>] - Root Volume Security Style

This parameter optionally specifies the security style for the Vserver's root volume. Possible values include unix (for UNIX mode bits), ntfs (for CIFS ACLs), and mixed (for mixed NFS and CIFS access). The default value is unix . Regardless of the security style, both NFS and CIFS clients can read from and write to the root volume.

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

This optionally 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 optionally specifies the Snapshot policy for new volumes created on the Vserver. If no value is specified, the default Snapshot policy is used. You can use the -snapshot-policy parameter on the volume create or volume modify commands to set the Snapshot policy on a specific volume, regardless of its Vserver's Snapshot policy setting.

[-data-services <LIF Service Name>,…​] - Data Services

This optionally specifies the data services for new network interfaces created on the Vserver. If no value is specified, the default services list will be applied. This information will be used to construct the default service policies for this Vserver, which can be viewed using the network interface service-policy show command.

[-comment <text>] - Comment

This optionally specifies a comment for the Vserver.

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

This optionally specifies a quota policy for the Vserver.

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

[-ipspace <IPspace>] - IPspace Name

This optionally specifies the IPspace the Vserver will be assigned to. If left unspecified, the Vserver will be assigned to the default IPspace.

[-foreground {true|false}] - Foreground Process

This parameter optionally specifies whether the Vserver create operation can be executed in the background. If nothing is specified, by default the Vserver create operation is executed in the foreground.

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

This optionally specifies whether to report space logically on residing 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. 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 optionally specifies the default anti_ransomware state for volumes in the Vserver. The available anti_ransomware states for the volumes in the Vserver are:

  • disabled - Anti_ransomware protection is not enabled on the volumes in the Vserver.

  • dry-run - Anti_ransomware protection is in learning mode on the volumes in the Vserver.

Default anti-ransomware-default-volume-state is disabled .

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

This parameter specifies whether analytics is automatically enabled on volumes that will be created in the Vserver. The default value is false.

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

This parameter specifies whether activity tracking is automatically enabled on volumes that will be created in the Vserver. The default value is false.

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

This parameter specifies the maximum size limit for a Vserver. Default value is 0, which means no limit.

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

This parameter specifies when the "vserver.storage.threshold" event log message is generated. This is a percentage value of storage-limit. Default value is 90%.

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

This parameter optionally specifies whether anti-ransomware state of the volumes in this Vserver are automatically switched by the system from “learning” (dry-run) to “enabled” (active) state after sufficient learning. The default value is true .

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

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this Vserver from “learning” (dry-run) to “enabled” is that the volume should have sufficient data ingested to do the learning. This parameter optionally specifies the minimum amount of data (in percentage) to be written to a given volume during the learning period to automatically switch the anti-ransomware state from “learning” to “enabled”. The amount of data considered as ingested also includes the data that is deleted or overwritten after ingestion. The default value is 5%.

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

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this Vserver from “learning” (dry-run) to “enabled” is that no new file-extensions are observed in the volume in recent time. This parameter optionally specifies the recent time duration (in days) to be considered during which no new file-extension should be observed in a given volume to automatically switch the anti-ransomware state from ‘learning” to “enabled”. The default value is 3 days.

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

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this Vserver from “learning” (dry-run) to “enabled” is that the volume should be in “learning” state for sufficient time period. This parameter optionally specifies the minimum number of days a given volume should be in “learning” state to automatically switch the anti-ransomware state from “learning” to “enabled”. The default value is 10 days.

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

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this Vserver from “learning” (dry-run) to “enabled” is that the volume should have sufficient number of files created in “learning” state. This parameter optionally specifies the minimum number of new files to be created in a given volume in “learning” state to automatically switch the anti-ransomware state from “learning” to “enabled”. The default value is 200 .

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

One of the many conditions to be satisfied to automatically switch the anti-ransomware state of the volumes in this Vserver from “learning” (dry-run) to “enabled” is that the volume should have sufficient unique file extension count in “learning” state. This parameter optionally specifies the minimum number of unique file extension count in a given volume in “learning” state to automatically switch the anti-ransomware state from “learning” to “enabled”. The default value is 10 days.

Examples

The following example creates a Vserver named vs0.example.com in the IPspace ipspace123. The Vserver's root volume is named root_vs0 and is located on aggregate aggr0 . The Vserver uses NIS for network information, a file for name mapping information, and the language is U.S. English:

cluster1::> vserver create -vserver vs0.example.com -ipspace ipspace123 -rootvolume root_vs0 -aggregate aggr0
-language en_US.UTF-8 -rootvolume-security-style mixed

The following example creates a Vserver named vs1 using default values. The default name for the Vserver's root volume is vserverName_root and the Vserver is located on an aggregate selected on the basis of the Vserver setup algorithm. The default root volume's security style is set to unix .

cluster1::> vserver create -vserver vs1
    cluster1::> vserver show -vserver vs1 -fields rootvolume, rootvolume-security-style, aggregate
  vserver rootvolume aggregate rootvolume-security-style
  ------- ---------- --------- -------------------------
  vs1     vs1_root   aggr1     unix