Skip to main content

vserver show

Contributors
Suggest changes
PDFs

Display Vservers

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

Description

The vserver show command displays the following information:

  • Vserver name

  • Vserver type (data , admin , node or system - detailed view only)

  • Vserver subtype (default , dp-destination , sync-source , and sync-destination - detailed view only)

  • Vserver universal unique identifier (detailed view only)

  • Root volume name

  • Aggregate on which the root volume is located

  • Associated NIS domain

  • Root volume security style (unix for UNIX mode bits, ntfs for CIFS ACLs, mixed for both (detailed view only)

  • LDAP client

  • Language (detailed view only)

  • Snapshot policy (detailed view only)

  • Comment text (detailed view only)

  • Quota policy (detailed view only)

  • Aggregate list (detailed view only)

  • Maximum Volumes (detailed view only)

  • Qos-policy-group (detailed view only)

  • Config-lock (detailed view only)

  • Admin state (running , stopped , starting , stopping , initializing , or deleting )

  • Operational state (running , or stopped )

  • Operational state stopped reason (sync-destination-and-switchover-not-done , or cluster-reboot-done , or admin-state-stopped )

  • Allowed Protocols (nfs , cifs , fcp , iscsi , nvme , ndmp - detailed view only)

  • Disallowed Protocols (nfs , cifs , fcp , iscsi , nvme , ndmp - detailed view only)

  • IPspace to which the Vserver belongs (detailed view only)

  • Caching policy

Parameters

{ [-fields <fieldname>,…​]

If you specify the -fields <fieldname>, …​ parameter, the command output also includes the specified field or fields. You can use '-fields ?' to display the fields to specify.

| [-protocols ]

If this optional parameter is specified, the command displays the allowed and disallowed set of protocols for the Vserver(s).

| [-instance ] }

If you specify the -instance parameter, the command displays detailed information about all fields.

[-vserver <vserver>] - Vserver

If this parameter is specified, the command displays detailed information about the specified Vserver.

[-type <vserver type>] - Vserver Type

If this parameter is specified, the command displays information only about the Vserver or Vservers that have the specified Vserver type. Types include admin for the cluster-wide management Vserver, system for cluster-level communications in an IPspace, data for data serving Vserver, and node for node management Vserver.

[-subtype <vserver subtype>] - Vserver Subtype

If this parameter is specified, the command displays information only about the Vserver or Vservers that have the specified Vserver subtype. Types include:

  • default for default data Vserver
    *
    and

  • dp-destination for Data Protection destination Vserver.

  • sync-source for MetroCluster source Vserver,

  • sync-destination for MetroCluster destination Vserver.

[-uuid <UUID>] - Vserver UUID

If this parameter is specified, the command displays information only about the Vserver that match the specified UUID.

[-rootvolume <volume name>] - Root Volume

If this parameter is specified, the command displays information only about the Vserver or Vservers that have the specified root volume.

[-aggregate <aggregate name>] - Aggregate

If this parameter is specified, the command displays information only about the Vserver or Vservers that have their root volumes contained by the specified aggregate.

[-nisdomain <nis domain>] - NIS Domain

If this parameter is specified, the command displays information only about the Vserver or Vservers that use the specified NIS domain.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that have the specified root-volume security style.

[-ldap-client <text>] - LDAP Client

If this parameter is specified, the command displays information only about the Vserver or Vservers that use the specified LDAP client.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that use the specified language. To determine the available languages, enter "`vserver show-language?` " at the clustershell command prompt and at the Vserver prompt.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that have the specified Snapshot policy.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified data services.

[-comment <text>] - Comment

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified comment.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that use the specified quota policy.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers to which the specified aggregate(s) are assigned for use.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers on which the specified maximum volume count is configured.

[-admin-state {running|stopped|starting|stopping}] - Vserver Admin State

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified admin-state.

[-operational-state {running|stopped}] - Vserver Operational State

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified operational-state. This field determines the state of the Vserver LIFs. New LIFs created on a Vserver, which is in running state, will be operationally up and the LIFs created on a Vserver, which is in stopped state, will be operationally down.

[-operational-state-stopped-reason {sync destination and switchover is not done|cluster reboot is done|admin state stopped| dp destination not started}] - Vserver Operational State Stopped Reason

If this parameter is specified, the command displays information only about the Vserver or Vservers that are operationally stopped due to the specified reason. This field indicates the reason for the operational-state of the Vserver being stopped

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

If this parameter is specified, the command displays information only about the Vserver or Vservers on which the specified protocols are allowed to run.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers on which the specified protocols are disallowed to run.

[-is-repository {true|false}] - Is Vserver with Infinite Volume

If this parameter is no longer supported.

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

Display the Vservers that match the specified qos-policy-group.

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

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

Display the Vservers that match the specified caching-policy.

A caching policy defines the caching behavior of this Vserver at the Flash Cache level. 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.

[-config-lock {true|false}] - Config Lock

This parameter specifies if the Vserver is locked or unlocked for modification. If the config-lock is set to true, then modifying the Vserver's configuration is not allowed.

[-ipspace <IPspace>] - IPspace Name

If this parameter is specified, the command displays information only about the Vservers that are assigned to the specified IPspace.

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

This optionally specifies whether the Vserver show operation can be executed in the background. If nothing is specified, by default the Vserver show 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 as 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 the 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 evaluation mode on the volumes in the Vserver.

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

This parameter specifies whether analytics is automatically enabled for the volumes in the Vserver.

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

This parameter specifies whether activity tracking is automatically enabled for the volumes in the Vserver.

[-storage-allocated {<integer>[KB|MB|GB|TB|PB]}] - Total Size of the Volumes

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for storage allocated.

[-storage-available {<integer>[KB|MB|GB|TB|PB]}] - Available Size

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for storage available.

[-storage-used-percentage <percent>] - Used Percent

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for used storage percentage.

[-number-of-volumes-in-recovery-queue <integer>] - Number of Volumes in Recovery Queue

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for number of volumes in recovery queue.

[-total-volume-size-in-recovery-queue {<integer>[KB|MB|GB|TB|PB]}] - Storage Space in Recovery Queue Volumes

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for total volume size in recovery queue.

[-storage-limit-threshold-exceeded {true|false}] - Max Storage Alert Threshold Exceeded

If this parameter is specified, the command displays the information only about the Vserver or Vservers whether that exceeded the value specified in the storage-limit-threshold-alert.

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

If this parameter is specified, the command displays the information only about the Vserver or Vservers that match the specified value for storage limit.

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

If this parameter is specified, the command display the information only about the Vserver or Vservers that match the specified value for storage limit threshold alert.

[-qos-adaptive-policy-group-template <text>] - QoS Adaptive Policy Group Template

Display the Vservers with a template that matches the specified qos-adaptive-policy-group. This optionally specifies if volumes created or moved into this Vserver will be assigned the specified QoS adaptive policy group, if they do not already have a policy group or adaptive policy group assigned to them. This adaptive policy group defines measurable service level objectives (SLOs) and Service Level Agreements (SLAs) that adjust based on the volume allocated space or used space.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_from_learning_to_enabled.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_minimum_incoming_data.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_duration_without_new_file_extension.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_minimum_learning_period.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_minimum_file_count.

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

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for anti_ransomware_auto_switch_minimum_file_extension.

[-storage-reserved {<integer>[KB|MB|GB|TB|PB]}] - Storage Reserved for In-flight Volume Operations

If this parameter is specified, the command displays information only about the Vserver or Vservers that match the specified value for storage reserved.

Examples

The following example displays information about all Vservers.

cluster1::> vserver show

non mcc setup:
                  Admin    Operational   Root
Vserver      Type    Subtype        state    state      Volume  Aggregate
-----------   ------- --------------- ----------- ----------- ----------- ---------
cluster      admin   -          -    -           -    -
node1      node    -          -    -           -    -
vs0        data    default        running  running      root_vs1  aggr0
vs1        data    dp-destination   stopped  stopped      -    -

4 entries were displayed.

mcc setup:

cluster1::> vserver show
                   Admin   Operational Root
Vserver      Type    Subtype         state   state       Volume    Aggregate
----------    ------- ---------------   ------- ----------- ----------- ---------
cluster      admin   -        -    -       -      -
node1      node    -        -    -       -      -
vs2           data    sync-source    running  running   rv         data_aggr
vs3-mc      data    sync-destination  running  stopped  -      -

4 entries were displayed.