Skip to main content
A newer release of this product is available.

volume show

Contributors
Suggest changes
PDFs

Display a list of volumes

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

Description

The volume show command displays information about volumes. The command output depends on the parameter or parameters specified with the command. If no parameters are specified, the command displays the following information about all volumes:

  • Vserver name

  • Volume name

  • Aggregate name

  • State (online, offline, restricted, or mixed)

  • Type (RW for read-write or DP for data-protection)

  • Size

  • Available size

  • Percentage of space used

To display detailed information about a single volume, run the command with the -vserver and -volume parameters. The detailed view provides all of the information in the previous list and the following additional information:

  • Name ordinal

  • Volume data set ID

  • Volume master data set ID

  • Volume style (trad or flex)

  • FlexCache Endpoint Type (none or cache or origin)

  • Whether the volume is a Cluster volume or Node volume

  • Export policy name

  • User ID

  • Group ID

  • Security style (unix, ntfs, mixed or unified)

  • UNIX permissions

  • Junction path

  • Junction path source

  • Whether the junction path is active

  • Parent volume name

  • Vserver root volume

  • Comment

  • Filesystem size

  • Total user-visible size

  • Used size

  • Used percentage

  • Volume nearly full threshold percent

  • Volume full threshold percent

  • Autosize enabled

  • Maximum autosize

  • Minimum autosize

  • Autosize grow threshold percent

  • Autosize shrink threshold percent

  • Autosize mode

  • Total files

  • Files used

  • Expected available size

  • Over provisioned size

  • Snapshot reserve available size

  • Logical used size

  • Logical used percent

  • Logical available size

  • Active filesystem logical used size

  • Snapshot copy logical used size

  • Use logical space reporting

  • Use logical space enforcement

  • Maximum directory size

  • Space guarantee style

  • Whether a space guarantee is in effect

  • Space SLO type (none, thick or semi-thick)

  • Whether space SLO is in effect

  • Whether minimum readahead is enabled

  • Whether access time update is enabled

  • Whether Snapshot directory access is enabled

  • Percentage of space reserved for Snapshot copies

  • Percentage of Snapshot copy space used

  • Snapshot policy name

  • Creation time

  • If the filesystem size is fixed

  • Overwrite reserve

  • Fractional reserve

  • Which space management strategy to try first

  • Language

  • Whether there's one data volume per member aggregate

  • Concurrency level

  • Optimization policy

  • Whether the volume is a clone

  • Volume UUID

  • Whether failover is enabled

  • Failover state

  • (DEPRECATED)-Extent option

  • Read reallocation option

  • Consistency state

  • Whether volume is quiesced on disk

  • Whether volume is quiesced in memory

  • Whether volume contains shared or compressed data

  • Space saved by storage efficiency

  • Percentage of space saved by storage efficiency

  • Space saved by deduplication

  • Percentage of space saved by deduplication

  • Space shared by deduplication

  • Space saved by compression

  • Percentage of space saved by compression

  • Volume Size Used by Snapshot Copies

  • Caching policy

  • FlexGroup master data set ID

  • FlexGroup index

  • FlexGroup UUID

  • Maximum size of the FlexGroup constituent

  • Whether the volume has FlexGroup enabled

  • Whether a FlexGroup is Qtree enabled

  • Whether the volume is the destination of a move that is currently in cutover

  • List of the aggregates used by the FlexGroup

  • List of the nodes used by the FlexGroup

  • SnapLock Type

  • Is in pre-commit phase of Copy-Free Transition

  • Application that the volume belongs to

  • File system analytics state of the volume

  • File system analytics scan progress percentage

  • Activity tracking state of the volume

  • Application UUID

  • Whether the volume's total number of files is set to the highest possible value

To display detailed information about all volumes, run the command with the -instance parameter.

You can specify additional parameters to display information that matches only those parameters. For example, to display information only about data-protection volumes, run the command with the -type DP parameter.

Parameters

{ [-fields <fieldname>,…​]

This specifies the fields that need to be displayed. The fields Vserver and policy are the default fields (see example).

| [-encryption ]

If this parameter is specified, the command displays the following information:

  • Vserver name

  • Volume name

  • Aggregate name

  • Volume state

  • Encryption state

| [-junction ]

If this parameter is specified, the command displays the following information:

  • Vserver name

  • Volume name

  • Whether the volume's junction is active

  • Junction path

  • Junction path source (if the volume is a mirror)

| [-settings ] (privilege: advanced)

If this parameter is specified, the command displays the following information:

  • Vserver name

  • Volume name

  • Whether minimum readahead is enabled on the volume

  • Whether the access time is updated on inodes when a file on the volume is read

  • Whether clients have access to .snapshot directories

  • Whether automatic Snapshot copies are enabled on the volume

| [-instance ] }

If this parameter is specified, the command displays information about all entries.

[-vserver <vserver name>] - Vserver Name

If this parameter and the -volume parameter are specified, the command displays detailed information about the specified volume. If this parameter is specified by itself, the command displays information about volumes on the specified Vserver.

[-volume <volume name>] - Volume Name

If this parameter and the -vserver parameter are specified, the command displays detailed information about the specified volume. If this parameter is specified by itself, the command displays information about all volumes matching the specified name.

[-aggregate <aggregate name>] - Aggregate Name

If this parameter is specified, the command displays information only about the volume or volumes that are located on the specified storage aggregate. This field is displayed as "-" for FlexGroups.

[-aggr-list <aggregate name>,…​] - List of Aggregates for FlexGroup Constituents

If this parameter is specified, the command displays information only about the FlexGroup or FlexGroups that are located on the specified list of storage aggregates. This parameter applies to FlexGroups only.

[-encryption-type {none|volume|aggregate}] - Encryption Type

If this parameter is specified, the command displays information about the type of encryption key used for encrypting the volume. The possible values are none , volume , and aggregate . The value none is used for non-encrypted volumes, the value volume is used for volumes encrypted with NVE (NetApp Volume Encryption) and aggregate is used for volumes encrypted with NAE (NetApp Aggregate Encryption).

[-nodes {<nodename>|local}] - List of Nodes Hosting the Volume

If this parameter is specified, the command displays information only about the FlexGroup or FlexGroups that are located on the specified list of storage systems. This parameter applies to FlexGroups only.

[-size {<integer>[KB|MB|GB|TB|PB]}] - Volume Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified size. Size is the maximum amount of space a volume can consume from its associated aggregate(s), including user data, metadata, Snapshot copies, and Snapshot reserve. Note that for volumes without a -space-guarantee of volume , the ability to fill the volume to this maximum size depends on the space available in the associated aggregate or aggregates.

[-name-ordinal <text>] - Name Ordinal (privilege: advanced)

If this parameter is specified, it denotes the ordinal assignment used in relation to this volume's name. Ordinals are used to disambiguate volumes that have the same base name on the same controller. A value of "0" indicates that the base volume name is unique on the controller. A value greater than zero indicates that the volume's base name is used by two or more volumes on the same controller, and that appending "(n)" to this volume's name uniquely identifies it on this controller.

[-dsid <integer>] - Volume Data Set ID

If this parameter is specified, the command displays information only about the volume or volumes that match the specified data set ID. This field is displayed as "-" for FlexGroups.

[-msid <integer>] - Volume Master Data Set ID

If this parameter is specified, the command displays information only about the volume or volumes that match the specified master data set ID.

[-state {online|restricted|offline|force-online|force-offline|mixed}] - Volume State

If this parameter is specified, the command displays information only about the volume or volumes that have the specified state. The mixed state only applies to FlexGroups. If the state of a FlexGroup is mixed , that indicates that not all of the constituents are in the same state. If this is the case use the "volume show -is-constituent true" command to find out which constituents are not in the proper state.

[-volume-style <flex>] - Volume Style

If this parameter is specified, the command displays information only about the volumes that have the specified style. Possible values are flex for FlexVol volumes.

[-volume-style-extended {flexvol|flexgroup|flexgroup-constituent}] - Extended Volume Style

If this parameter is specified, the command displays information only about the volumes that are configured with the specified extended style. Possible values are flexvol for FlexVol volumes, flexgroup for FlexGroups and flexgroup-constituent for FlexGroup constituents.

[-flexcache-endpoint-type {none|cache|origin}] - FlexCache Endpoint Type

If this parameter is specified, the command displays information only about the volumes that are of the specified flexcache-endpoint-type. Possible values are none for volumes that are not part of a FlexCache relationship, cache for FlexCache volumes and origin for origin of FlexCache volumes.

[-is-cluster-volume {true|false}] - Is Cluster-Mode Volume

If this parameter is specified, the command displays information only about cluster volumes (true) or node root volumes and other node scoped volumes (false).

[-is-constituent {true|false}] - Is Constituent Volume

If this parameter is specified, the command displays information only about volumes that either are or are not constituents of a FlexGroup, depending on the value provided.

[-constituent-count <integer>] - Number of Constituent Volumes

The number of constituents in the FlexGroup volume. This parameter applies to FlexGroups only.

[-policy <text>] - Export Policy

If this parameter is specified, the command displays information only about the volume or volumes that use the specified export policy.

[-user <user name>] - User ID

If this parameter is specified, the command displays information only about the volume or volumes whose root is owned by the specified user.

[-group <group name>] - Group ID

If this parameter is specified, the command displays information only about the volume or volumes whose root is owned by the specified group.

[-security-style <security style>] - Security Style

If this parameter is specified, the command displays information only about the volume or volumes that have the specified security style (unix for UNIX mode bits, ntfs for CIFS ACLs, mixed for both styles or unified for Unified UNIX, NFS and CIFS permissions).

[-unix-permissions <unix perm>] - UNIX Permissions

If this parameter is specified, the command displays information only about the volume or volumes whose default UNIX permissions match the specified permissions. Specify UNIX permissions either as a four-digit octal value (for example, 0700) or in the style of the UNIX ls command (for example, -rwxr-x---). For information on UNIX permissions, see the UNIX or Linux documentation.

[-junction-path <junction path>] - Junction Path

If this parameter is specified, the command displays information only about the volume or volumes that have the specified junction path.

[-junction-path-source {RW_volume|LS_mirror}] - Junction Path Source

If this parameter is specified, the command displays information only about the volume or volumes that have the specified junction path source.

[-junction-active {true|false}] - Junction Active

If this parameter is specified, the command displays information only about the volume or volumes whose junction paths have the specified status.

[-junction-parent <volume name>] - Junction Parent Volume

If this parameter is specified, the command displays information only about the volume or volumes that have the specified parent volume.

[-vsroot {true|false}] - Vserver Root Volume (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that match the specified setting; that is, whether they are the root volumes for their Vservers.

[-comment <text>] - Comment

If this parameter is specified, the command displays information only about the volume or volumes that match the specified comment text.

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

If this parameter is specified, the command displays information only about the volume or volumes that have the specified available size. Available is the amount of free space currently available to be used by this volume. For a volume with a -space-guarantee of type volume , available is always -total minus -used . For volumes that do not have a -space-guarantee of type volume , available could be reduced if the volume’s associated aggregate or aggregates are space constrained.

[-filesystem-size {<integer>[KB|MB|GB|TB|PB]}] - Filesystem Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified filesystem size. Filesystem size is the same as the volume’s -size unless the volume is or was a physical replica destination. In this case, the file system size corresponds to the -size of the source volume, until -filesys-size-fixed is set to false .

[-total {<integer>[KB|MB|GB|TB|PB]}] - Total User-Visible Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified total size. Total is the total space available for user data and file system metadata. It does not include the Snapshot reserve.

[-used {<integer>[KB|MB|GB|TB|PB]}] - Used Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified used size. Used is the amount of space occupied by user data and file system metadata. It includes Snapshot spill (the amount of space by which Snapshot copies exceed Snapshot reserve). It does not include the Snapshot reserve.

[-percent-used <percent>] - Used Percentage

If this parameter is specified, the command displays information only about the volume or volumes that have the specified percentage of used space. This row is based on a value of used space that includes the space used by Snapshot copies or the Snapshot reserve (whichever is greater) in relation to the current volume size.

[-space-nearly-full-threshold-percent <percent>] - Volume Nearly Full Threshold Percent

If this parameter is specified, the command displays information only about the volume or volumes that have the specified nearly full threshold percent.

[-space-full-threshold-percent <percent>] - Volume Full Threshold Percent

If this parameter is specified, the command displays information only about the volume or volumes that have the specified full threshold percent.

[-max-autosize {<integer>[KB|MB|GB|TB|PB]}] - Maximum Autosize

If this parameter is specified, the command displays information only about the volume or volumes that have the specified maximum automatic size.

[-min-autosize {<integer>[KB|MB|GB|TB|PB]}] - Minimum Autosize

If this parameter is specified, the command displays information only about the volume or volumes that have the specified minimum automatic size. This field is displayed as "-" for FlexGroups.

[-autosize-grow-threshold-percent <percent>] - Autosize Grow Threshold Percentage

If this parameter is specified, the command displays information only about the volume or volumes that have the specified automatic grow used space threshold percentage. This field is displayed as "-" for FlexGroups.

[-autosize-shrink-threshold-percent <percent>] - Autosize Shrink Threshold Percentage

If this parameter is specified, the command displays information only about the volume or volumes that have the specified automatic shrink used space threshold percentage. This field is displayed as "-" for FlexGroups.

[-autosize-mode {off|grow|grow_shrink}] - Autosize Mode

If this parameter is specified, the command displays information only about the volume or volumes that have the specified automatic sizing mode setting. This field is displayed as "-" for FlexGroups.

[-files <integer>] - Total Files (for user-visible data)

If this parameter is specified, the command displays information only about the volume or volumes that have the specified number of files.

[-files-used <integer>] - Files Used (for user-visible data)

If this parameter is specified, the command displays information only about the volume or volumes that have the specifies number of files used.

[-files-set-maximum {true|false}] - Set Total Files (for user-visible data) to the Highest Value that the Volume can Hold (privilege: advanced)

If this parameter is specified, the command displays information about whether the volume's total number of files is set to the highest value that the volume can hold.

[-maxdir-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum Directory Size (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that have the specified maximum directory size.

[-space-guarantee-enabled {true|false}] - Space Guarantee in Effect

If this parameter is specified, the command displays information only about the volume or volumes that have the specified space-guarantee setting. If the value of -space-guarantee is none , the value of -space-guarantee-enabled is always true . In other words, because there is no guarantee, the guarantee is always in effect. If the value of -space-guarantee is volume , the value of -space-guarantee-enabled can be true or false , depending on whether the guaranteed amount of space was available when the volume was mounted.

[-is-space-slo-enabled {true|false}] - Space SLO in Effect

If this parameter is specified, the command displays information only about the volume or volumes that have their space-slo setting in effect or not, depending on the value specified for this parameter. If the value of space-slo is none , the space SLO is always considered to be in effect. If the value of space-slo is semi-thick or thick , the space SLO may be in effect depending on whether the required amount of space was available when the volume was mounted.

[-space-slo {none|thick|semi-thick}] - Space SLO

If this parameter is specified, the command displays information only about the volume or volumes that have the specified space-slo setting. The space SLO setting is the Service Level Objective for space management for the volume.

[-s, -space-guarantee {none|volume}] - Space Guarantee Style

If this parameter is specified, the command displays information only about the volume or volumes that have the specified space guarantee style. If the value of -space-guarantee is none , the value of -space-guarantee-enabled is always true . In other words, because there is no guarantee, the guarantee is always in effect. If the value of -space-guarantee is volume , the value of -space-guarantee-enabled can be true or false , depending on whether the guaranteed amount of space was available when the volume was mounted.

[-fractional-reserve <percent>] - Fractional Reserve

If this parameter is specified, the command displays information only about the volume or volumes that have the specified fractional-reserve setting.

[-type {RW|DP}] - Volume Type

If this parameter is specified, the command displays information only about the volume or volumes of the specified volume type (RW for read-write or DP for data-protection).

[-min-readahead {true|false}] - Minimum Read Ahead (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that have the specified minimum-readahead setting.

[-atime-update {true|false}] - Access Time Update Enabled (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that have the specified access-time update setting.

[-snapdir-access {true|false}] - Snapshot Directory Access Enabled

If this parameter is specified, the command displays information only about the volume or volumes that have the specified Snapshot-copy access setting.

[-percent-snapshot-space <percent>] - Space Reserved for Snapshot Copies

If this parameter is specified, the command displays information only about the volume or volumes that have the specified percentage of space reserved for Snapshot copies.

[-snapshot-space-used <percent_no_limit>] - Snapshot Reserve Used

If this parameter is specified, the command displays information only about the volume or volumes that have the specified used percentage of the reserve for Snapshot copies.

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

If this parameter is specified, the command displays information only about the volume or volumes that use the specified Snapshot policy.

[-create-time <Date>] - Creation Time

If this parameter is specified, the command displays information only about the volume or volumes that have the specified creation time.

[-language <Language code>] - Language

If this parameter is specified, the command displays information only about the volume or volumes that store data in the specified language. To determine the available languages, enter volume show-language`?` at the clustershell command prompt.

[-clone-volume {true|false}] - Clone Volume

If this parameter is specified, the command displays information only about volumes that are clones (true) or not clones (false).

[-node {<nodename>|local}] - Node name

If this parameter is specified, the command displays information only the volume or volumes that are located on the specified storage system. This field is displayed as "-" for FlexGroups.

[-clone-parent-vserver <vserver name>] - Clone Parent Vserver Name

If this parameter is specified, the command displays information only about the volumes with a matching FlexClone parent Vserver name.

[-clone-parent-name <volume name>] - FlexClone Parent Volume

If this parameter is specified, the command displays information only about the volumes with a matching FlexClone parent volume name.

[-uuid <UUID>] - UUID of the Volume (privilege: advanced)

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

[-nvfail {on|off}] - NVFAIL Option

If this parameter is specified, the command displays information only about volumes for which failover is enabled (on) or disabled (off).

[-in-nvfailed-state {true|false}] - Volume's NVFAIL State

If this parameter is specified, the command displays information only about volumes which are in the failed over state (true) or not (false). This field is only available when the volume is online.

[-dr-force-nvfail {on|off}] - Force NVFAIL on MetroCluster Switchover

If this parameter is specified, the command displays information only about volumes for which dr-force-nvfail is enabled (on) or disabled (off).

[-filesys-size-fixed {true|false}] - Is File System Size Fixed

If this parameter is specified, the command displays information only about the volume or volumes that have the specified filesys-size-fixed setting.

[-extent-enabled {off|on|space-optimized}] - (DEPRECATED)-Extent Option
Note This parameter has been deprecated and may be removed in a future release of Data ONTAP.

If this parameter is specified, the command displays information only about volumes that have extents enabled (on), not enabled (off) or space optimized (space-optimized).

[-overwrite-reserve {<integer>[KB|MB|GB|TB|PB]}] - Reserved Space for Overwrites

If this parameter is specified, the command displays information only about the volume or volumes that have the specified overwrite-reserve setting.

[-space-mgmt-try-first {volume_grow|snap_delete}] - Primary Space Management Strategy

If this parameter is specified, the command displays information only about the volume or volumes that have the specified space-mgmt-try-first setting. Possible values are volume_grow and snap_delete . This field is displayed as "-" for FlexGroups.

[-read-realloc {off|on|space-optimized}] - Read Reallocation Option

If this parameter is specified, the command displays information only about volumes that have read reallocation enabled (on), not enabled (off) or space optimized (space-optimized).

[-sched-snap-name {create-time|ordinal}] - Naming Scheme for Automatic Snapshot Copies

If this parameter is specified, the command displays information only about the volume or volumes that have the specified automatic Snapshot-copy naming convention.

[-is-inconsistent {true|false}] - Inconsistency in the File System

If this parameter is specified, the command displays information only about volumes that are inconsistent (true) or consistent (false) in the file system.

[-is-quiesced-on-disk {true|false}] - Is Volume Quiesced (On-Disk)

If this parameter is specified, the command displays information only about volumes that are quiesced (true) or not quiesced (false) on disk.

[-is-quiesced-in-memory {true|false}] - Is Volume Quiesced (In-Memory)

If this parameter is specified, the command displays information only about volumes that are quiesced (true) or not quiesced (false) in memory.

[-transition-state <state>] - Transition Operation State (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that match the specified transition state.

[-transition-behavior {data-move|data-protection|none}] - Transition Behavior (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that match the specified transition behavior. Possible values are:

  • data-move: Volumes that are being moved from a system operating in 7-Mode.

  • data-protection: Volumes that are being replicated from a system operating in 7-Mode for disaster recovery.

  • none: Volumes that are not part of transition.

[-is-copied-for-transition {true|false}] - Copied for Transition (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that match the specified value based on whether the volume is copied for transition or not.

[-is-transitioned {true|false}] - Transitioned (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that match the specified value based on whether the volume is transitioned or not.

[-is-sis-volume {true|false}] - Volume Contains Shared or Compressed Data

If this parameter is specified, the command displays information only about those volumes that match the specified storage efficiency setting.

[-sis-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by Storage Efficiency

If this parameter is specified, the command displays information only about those volumes that have the specified amount of space saved by the storage efficiency technology.

[-sis-space-saved-percent <percent>] - Percentage Saved by Storage Efficiency

If this parameter is specified, the command displays information only about those volumes that have the specified percentage of space saved by the storage efficiency technology.

[-dedupe-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by Deduplication

If this parameter is specified, the command displays information only about those volumes that have the specified amount of space saved due to deduplication.

[-dedupe-space-saved-percent <percent>] - Percentage Saved by Deduplication

If this parameter is specified, the command displays information only about those volumes that have the specified percentage of space saved due to deduplication.

[-dedupe-space-shared {<integer>[KB|MB|GB|TB|PB]}] - Space Shared by Deduplication

If this parameter is specified, the command displays information only about those volumes that have the specified amount of shared space due to deduplication.

[-compression-space-saved {<integer>[KB|MB|GB|TB|PB]}] - Space Saved by Compression

If this parameter is specified, the command displays information only about those volumes that have the specified amount of space saved due to compression.

[-compression-space-saved-percent <percent>] - Percentage Space Saved by Compression

If this parameter is specified, the command displays information only about those volumes that have the specified percentage of space saved due to compression.

[-size-used-by-snapshots {<integer>[KB|MB|GB|TB|PB]}] - Volume Size Used by Snapshot Copies

If this parameter is specified, the command displays information about those volumes that have the specified volume size used by Snapshot copies.

[-block-type {64-bit|extent|32-bit}] - Block Type

If this parameter is specified, the command displays information about only the volumes with the specified indirect block format. Possible values are 32-bit to display 32-bit volumes and 64-bit to display 64-bit volumes.

[-is-moving {true|false}] - Is Volume Moving

If this parameter is specified, the command displays information only about volumes that are moving (true) or not moving (false).

[-hybrid-cache-eligibility {read|read-write|none}] - Flash Pool Caching Eligibility

If this parameter is specified, the command displays information only about the volume or volumes with the specified Flash Pool caching attributes. Possible caching attributes are:

  • 'read' …​ Indicates that the volume cannot participate in write caching.

  • 'read-write' …​ Indicates that the volume can participate in read and write caching.

[-hybrid-cache-write-caching-ineligibility-reason <text>] - Flash Pool Write Caching Ineligibility Reason

If this parameter is specified, the command displays information only about the volume or volumes which are ineligible to participate in write caching due to the specified reason.

[-constituent-role <Constituent Roles>] - Constituent Volume Role

If this parameter is specified, the command displays information only about the constituent volume or volumes that are of the specified role. This parameter applies to FlexGroups only.

[-is-cft-precommit {true|false}] - Is in the precommit phase of Copy-Free Transition (privilege: advanced)

If this parameter is specified with the true value, it displays information only about the volumes that are in the precommit phase of a Copy-Free Transition workflow.

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

If this parameter is specified, the command displays information only about volumes that match the specified QoS policy group.

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

If this parameter is specified, the command displays information only about volumes that match the specified QoS adaptive policy group.

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

If this parameter is specified, the command displays the volumes that match the specified caching policy.

A caching policy defines how the system caches a volume's data in a Flash Pool aggregate. Both metada and user data are eligible for caching. 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.

  • noread-random_write - Write caches all randomly overwritten user data blocks. It does not do any read caching.

  • meta-random_write - Read caches all metadata and write caches randomly overwritten user data blocks.

  • random_read_write-random_write - Read caches all metadata, randomly read and randomly written user data blocks. It also write caches randomly overwritten user data blocks.

  • all_read-random_write - Read caches all metadata, randomly read and sequentially read user data blocks. It also write caches randomly overwritten user data blocks.

  • all_read_random_write-random_write - Read caches all metadata, randomly read, sequentially read, and randomly written user data. It also write caches randomly overwritten user data blocks.

  • all-random_write - Read caches all data blocks read and written. It also write caches randomly overwritten user data blocks.

Note that in a caching-policy name, a hyphen (-) separates read and write policies. Default caching-policy is auto.

[-cache-retention-priority {normal|low|high}] - Cache Retention Priority (privilege: advanced)

If this parameter is specified, the command displays the volumes that match the specified cache retention priority policy.

A cache retention priority defines how long the blocks of a volume will be cached in flash pool once they become cold.The available cache retention priority are:

  • low - Cache the cold blocks for the lowest time.

  • normal - Cache the cold blocks for the default time.

  • high - Cache the cold blocks for the highest time.

[-is-volume-in-cutover {true|false}] - Is Volume Move in Cutover Phase

If this parameter is specified, the command displays information only about volumes that are in the cutover phase (true) or not in the cutover phase (false) of a volume move. This field is displayed as "-" for FlexGroups.

[-snapshot-count <integer>] - Number of Snapshot Copies in the Volume

If this parameter is specified, the command displays information only about the volumes that have the specified number of Snapshot copies.

[-vbn-bad-present {true|false}] - VBN_BAD may be present in the active filesystem

If this parameter is specified, the command displays information only about volumes that may have VBN_BAD present in its active filesystem (true) or do not have VBN_BAD present in its active filesystem (false).

[-is-autobalance-eligible {true|false}] - Is Eligible for Auto Balance Aggregate (privilege: advanced)

If this parameter is specified, the command displays information only about the volume or volumes that are eligible for consideration by the Auto Balance Aggregate feature.

[-is-vol-on-hybrid-aggr {true|false}] - Is Volume on a hybrid aggregate

If this parameter is specified, the command displays information only about volumes associated with a Flash Pool aggregate (true) or not (false). This field is displayed as "-" for FlexGroups.

[-physical-used {<integer>[KB|MB|GB|TB|PB]}] - Total Physical Used Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified physical used size. This differs from total-used space by the space that is reserved for future writes. The value includes blocks in use by Snapshot copies.

[-physical-used-percent <percent_no_limit>] - Physical Used Percentage

If this parameter is specified, the command displays information only about the volume or volumes that have the specified physical used percent based on volume size including the space reserved for Snapshot copies.

[-flexgroup-msid <integer>] - FlexGroup Master Data Set ID (privilege: advanced)

If this parameter is specified, the command displays information only about the FlexGroup or FlexGroup constituents that have the specified FlexGroup master data-set ID. This parameter applies to FlexGroups and FlexGroup constituents only.

[-flexgroup-index <integer>] - FlexGroup Index (privilege: advanced)

If this parameter is specified, the command displays information only about the FlexGroup constituents that have the specified FlexGroup index. This parameter applies to FlexGroup constituents only.

[-flexgroup-uuid <UUID>] - UUID of the FlexGroup (privilege: advanced)

If this parameter is specified, the command displays information only about the FlexGroup or FlexGroup constituents that have the specified FlexGroup UUID. This parameter applies to FlexGroups and FlexGroup constituents only.

[-flexgroup-name <volume name>] - FlexGroup Name

If this parameter is specified, the command displays information only about the volumes that have the specified FlexGroup name. This parameter only applies to FlexGroup volumes and FlexGroup constituents.

[-max-constituent-size {<integer>[KB|MB|GB|TB|PB]}] - Maximum size of a FlexGroup Constituent (privilege: advanced)

If this parameter is specified, the command displays information only about the FlexGroup or FlexGroups that have the specified maximum constituent size. This parameter applies to FlexGroups only.

[-inofile-version <integer>] - Inofile Version (privilege: advanced)

If this parameter is specified, the command displays information only about the volumes whose inode files are at the specified version.

[-is-flexgroup {true|false}] - Is Volume a FlexGroup

If this parameter is specified, the command displays information only about the volume or volumes that are either FlexGroups or not, depending on the value provided.

[-is-qtree-caching-enabled {true|false}] - Is Qtree Caching Support Enabled (privilege: advanced)

If this parameter is specified, the command displays information only about the FlexGroups and origins of FlexCache volumes with Qtree caching enabled or disabled, depending on the value provided.

[-is-move-destination-in-cutover {true|false}] - Is the Volume a Target of a Move Which Is Currently in Cutover (privilege: advanced)

If this parameter is specified, the command displays whether or not the volume is a move destination that is currently in cutover.

[-snaplock-type {non-snaplock|compliance|enterprise}] - SnapLock Type

If this parameter is specified, the command displays information only about volumes that match the specified snaplock-type.

[-vserver-dr-protection {protected|unprotected}] - Vserver DR Protection

If this parameter is specified, the command displays information only about the volumes having the specified Vserver Snapmirror protection.

[-has-optimized-sparse-directories {true|false}] - Volume Has Sparse Directories in an Optimized Format (privilege: advanced)

If this parameter is specified, the command displays information only about volumes that have sparse directories in an optimized format.

[-encrypt {true|false}] - Enable or Disable Encryption

If this parameter is specified, the command displays information only about the volumes that are encrypted (true) or not encrypted (false).

[-is-encrypted {true|false}] - Is Volume Encrypted

If this parameter is specified, the command displays information only about the volumes that are encrypted (true) or unencrypted (false).

[-encryption-state {none|full|partial|converting_to_encrypted|converting_to_plaintext|rekeying}] - Encryption State

If this parameter is specified, the command displays information only about the volumes that have the specified encryption state. The possible values are none , full , partial , converting_to_encrypted , converting_to_plaintext , and rekeying . The value partial is used for FlexGroups, which indicates that some constituents are encrypted and some are not.

[-key-id <text>] - Encryption Key ID

If this parameter is specified, the command displays information only about the volume whose encryption key-id matches the specified key-id.

[-key-creation-time <MM/DD/YYYY HH:MM:SS>] - Encryption Key Creation Time

If this parameter is specified, the command displays information only about volumes having an encryption key with a creation time that matches, is greater than or less than the provided key-creation-time value. For example, the volume show -key-creation-time >1/1/2022 13:12:11 command will show all volumes that have an encryption key created later than 1/1/2022 13:12:11

[-application <text>] - Application

Selects the volumes that are part of an application that matches the parameter value.

[-is-protocol-access-fenced {true|false}] - Is Fenced for Protocol Access

If this parameter is specified, the command displays information only about the volumes that are fenced for protocol access. Only FlexGroup constituents and volumes in SnapMirror Synchronous relationships can be fenced for protocol access.

[-protocol-access-fenced-by {none|coordinated_snaprestore|coordinated_redirection|snapmirror_synchronous|vserver_migrate}] - Protocol Access Fence Owner

This field indicates the owner of the protocol access fence when the volume's protocol access is fenced. Only FlexGroup constituents and volumes in SnapMirror Synchronous relationships can be fenced for protocol access.

[-single-instance-data-logging {off|on}] - Is SIDL enabled

If this parameter is specified, the command displays whether Single Instance Data Logging feature is enabled on the specified volume.

[-over-provisioned {<integer>[KB|MB|GB|TB|PB]}] - Over Provisioned Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified size not available in the aggregate. This applies only for a 'none' guaranteed volume when it's unused size exceeds available space in the aggregate. This value is always zero for 'volume' guaranteed volumes.

[-snapshot-reserve-available {<integer>[KB|MB|GB|TB|PB]}] - Available Snapshot Reserve Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified size available for Snapshot copies within the Snapshot reserve. This value is zero if Snapshot spill is present. For 'none' guaranteed volumes, this may get reduced due to less available space in the aggregate.

[-logical-used {<integer>[KB|MB|GB|TB|PB]}] - Logical Used Size

If this parameter is specified, the command displays information only about the volume or volumes that have the specified logical used size. This value includes all the space saved by the storage efficiency features along with the physically used space. This does not include Snapshot reserve but does consider Snapshot spill.

[-logical-used-percent <percent_no_limit>] - Logical Used Percentage

If this parameter is specified, the command displays information only about the volume or volumes that have the specified logical used percentage.

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

If this parameter is specified, the command displays information only about the volume or volumes that have the specified logical available size. This value is the amount of free space currently available considering space saved by the storage efficiency features as being used. This does not include Snapshot reserve.

[-logical-used-by-afs {<integer>[KB|MB|GB|TB|PB]}] - Logical Size Used by Active Filesystem

If this parameter is specified, the command displays information only about the volume or volumes that have the specified logical size used by the active file system. This value differs from logical-used by the amount of Snapshot spill that exceeds Snapshot reserve. This parameter is not supported on FlexGroups.

[-logical-used-by-snapshots {<integer>[KB|MB|GB|TB|PB]}] - Logical Size Used by All Snapshots

If this parameter is specified, the command displays information only about the volume or volumes that have the specified logical size used across all Snapshot copies. This value differs from size-used-by-snapshots by the space saved by the storage efficiency features across the Snapshot copies. This parameter is not supported on FlexGroups.

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

If this parameter is specified, the command displays information only about the volumes that have logical space reporting enabled or disabled as specified. 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

If this parameter is specified, the command displays information only about the volumes that have logical space enforcement enabled or disabled as specified. 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.

[-tiering-policy <Tiering Policy>] - Volume Tiering Policy

If this parameter is specified, the command displays information only about the volumes whose tiering policy matches the specified value. Tiering policies determine whether the user data blocks of a volume in a FabricPool will be tiered to the cloud tier when they become cold. FabricPool combines Flash (performance tier) with an object store (cloud tier) into a single aggregate. The temperature of a volume block increases if it is accessed frequently and decreases when it is not.

The available tiering policies are:

  • snapshot-only - Only the volume Snapshot copies not associated with the active file system are tiered to the cloud tier.

  • auto - Both Snapshot copy data and active file system user data are tiered to the cloud tier.

  • none - No volume blocks are tiered to the cloud tier.

  • all - Both Snapshot copy data and active file system user data are tiered to the cloud tier as soon as possible without waiting for a cooling period. On DP volumes all transferred user data blocks start in the cloud tier.

[-cloud-retrieval-policy {default|on-read|never|promote}] - Volume Cloud Retrieval Policy (privilege: advanced)

This optional parameter specifies the cloud retrieval policy for the volume. This policy determines which tiered out blocks to retrieve from the capacity tier to the performance tier.

The available cloud retrieval policies are:

  • default - This policy retrieves tiered data based on the underlying tiering policy. If the tiering policy is 'auto', tiered data is retrieved only for random client driven data reads. If the tiering policy is 'none' or 'snapshot-only', tiered data is retrieved for random and sequential client driven data reads. If the tiering policy is 'all', tiered data is not retrieved.

  • on-read - This policy retrieves tiered data for all client driven data reads.

  • never - This policy never retrieves tiered data.

  • promote - This policy retrieves all eligible tiered data automatically during the next scheduled scan. It is only supported when the tiering policy is 'none' or 'snapshot-only'. If the tiering policy is 'snapshot-only', the only data brought back is the data in the AFS. Data that is only in a snapshot copy stays in the cloud.

[-tiering-minimum-cooling-days <integer>] - Volume Tiering Minimum Cooling Days (privilege: advanced)

This parameter displays the minimum number of days that user data blocks of the volume must be cooled before they can be considered cold and tiered out to the cloud tier. For volumes hosted on FabricPools, this parameter is used for tiering purposes and does not affect the reporting of inactive data. For volumes hosted on non-FabricPools, this parameter affects the cooling window used for reporting inactive data. The default minimum cooling period for the snapshot-only policy is 2 days and for the auto policy is 31 days.

[-performance-tier-inactive-user-data {<integer>[KB|MB|GB|TB|PB]}] - Performance Tier Inactive User Data

If this parameter is specified, the command displays the amount of inactive user data stored in the performance tier that could be tiered out to a cloud tier if the volume is in a FabricPool and for which the auto tiering policy has been specified. For more information see the tiering-policy parameter.

[-performance-tier-inactive-user-data-percent <percent>] - Performance Tier Inactive User Data Percent

If this parameter is specified, the command displays the percentage of inactive user data in the performance tier.

[-tiering-object-tags <text>,…​] - Tags to be Associated with Objects Stored on a FabricPool

This optional parameter specifies the tiering object tags to be assoicated with objects stored on a FabricPool.

[-needs-object-retagging {true|false}] - Does the Object Tagging Scanner Need to Run on This Volume

This optional parameter specifies if an object tagging scanner needs to run again for the volume.

[-is-analytics-supported {true|false}] - Is File System Analytics Supported

If this parameter is specified, the command displays information only about volumes that are supported (true) or not supported (false). This field indicates whether or not file system analytics is supported on the volume. If file system analytics is not supported, the reason will be specified in the analytics_unsupported_reason field.

[-analytics-unsupported-reason <text>] - Reason File System Analytics is not Supported

If this parameter is specified, the command displays information only about volumes that are not supported with the specified reason. If file system analytics is not supported on the volume, this field provides the reason why.

[-analytics-state <Analytics State>] - File System Analytics State

If this parameter is specified, the command displays information only about volumes with file system analytics on , off or initializing . If this value is on , ONTAP collects extra file system analytics information for all directories on the volume. There will be a slight impact to I/O performance to collect this information. If this value is off , file system analytics information is not collected and not available to be viewed. If this value is initializing , that means file system analytics was recently turned on, and the initialization scan to gather information for all existing files and directories is currently running.

[-analytics-scan-progress <percent>] - File System Analytics Scan Progress

If this parameter is specified, the command displays information only about the volume or volumes that have the specified file system analytics progress percentage. This value will only be set if a file system analytics initialization scan is in progress.

[-activity-tracking-state <Activity Tracking State>] - Activity Tracking State

If this parameter is specified, the command displays information only about volumes with volume activity tracking on or off . If this value is on , ONTAP tracks volume activity in real time to provide a more detailed view. There will be a slight impact to I/O performance to collect this information. If this value is off , activity is not tracked and not available to be viewed.

[-is-activity-tracking-supported {true|false}] - Is Activity Tracking Supported

If this parameter is specified, the command displays information only about volumes that are supported (true) or not supported (false). This field indicates whether or not volume activity tracking is supported on the volume. If volume activity tracking is not supported, the reason will be specified in the activity_tracking_unsupported_reason field.

[-activity-tracking-unsupported-reason <text>] - Reason Activity Tracking Is Not Supported

If this parameter is specified, the command displays information only about volumes that are not supported with the specified reason. If volume activity tracking is not supported on the volume, this field provides the reason why.

[-is-smbc-master {true|false}] - Is SMBC Master

If this parameter is specified, it displays if the volume is acting as a SnapMirror Business Continuity (SMBC) master.

[-is-smbc-failover-capable {true|false}] - Is SMBC Failover Capable

This parameter specifies if volume is capable of SMBC failover.

[-smbc-consensus {Awaiting-consensus|Consensus|No-consensus}] - SMBC Consensus

This parameter specifies the SMBC consensus value.

Consensus indicated if cluster has to serve IO. Possible consensus values:

  • Consensus Awaiting: Allow IO

  • Consensus: Allow IO

  • No consensus: Do not allow IO

[-anti-ransomware-state {disabled|enabled|dry-run|paused|dry-run-paused|enable-paused|disable-in-progress}] - Anti-ransomware State

If this parameter is specified, the command displays information only about the volumes that have the specified Anti-ransomware-state. The possible values are disabled , enabled , dry-run , dry-run-paused , enable-paused or disable-in-progress . The value disabled is used for volumes which do not have Anti-ransomware feature enabled. The value is enabled when Anti-ransomware feature is enabled on the volume. If the value is dry-run , the volume is in Anti-ransomware evaluation mode. The value is dry-run-paused when the Anti-ransomware feature is paused from evaluation mode on the volume. The value is enable-paused when the Anti-ransomware feature is paused on the volume. The value is disable-in-progress when disable work is in progress on the volume.

[-atime-update-period <integer>] - Access Time Update Period (Seconds) (privilege: advanced)

"If this parameter is specified, the command displays information only about volumes that match the specified value for the atime update period."

Examples

The following example displays information about all volumes on the Vserver named vs1:

cluster1::> volume show -vserver vs1
Vserver   Volume       Aggregate    State      Type       Size  Available Used%
--------- ------------ ------------ ---------- ---- ---------- ---------- -----
vs1       vol1         aggr1        online     RW          2GB      1.9GB    5%
vs1       vol1_dr      aggr0_dp     online     DP        200GB    160.0GB   20%
vs1       vol2         aggr0        online     RW        150GB    110.3GB   26%
vs1       vol2_dr      aggr0_dp     online     DP        150GB    110.3GB   26%
vs1       vol3         aggr1        online     RW        150GB    120.0GB   20%
vs1       vol3_dr      aggr1_dp     online     DP        150GB    120.0GB   20%
vs1       vol4         aggr1        online     RW        200GB    159.8GB   20%
vs1       vol4_dr      aggr1_dp     online     DP        200GB    159.8GB   20%
vs1       vol5         aggr2        online     RW        200GB    102.3GB   48%
vs1       vol5_dr      aggr2_dp     online     DP        200GB    102.3GB   48%
vs1       vol6         aggr2        online     RW        150GB    117.2GB   21%
vs1       vol6_dr      aggr2_dp     online     DP        150GB    117.2GB   21%
vs1       vol7         aggr3        online     RW        150GB    118.5GB   20%
vs1       vol7_dr      aggr3_dp     online     DP        150GB    118.5GB   20%
vs1       vol8         aggr3        online     RW        150GB    90.03GB   39%
vs1       vol8_dr      aggr3_dp     online     DP        150GB    90.03GB   39%
vs1       vol9         aggr4        online     RW        150GB    43.67GB   70%
vs1       vol9_dr      aggr4_dp     online     DP        150GB    43.67GB   70%
vs1       vol10        aggr4        online     RW        150GB    108.7GB   27%
vs1       vol10_dr     aggr4_dp     online     DP        150GB    108.7GB   27%
vs1       vol11        aggr5        online     RW        250GB    45.65GB   81%
vs1       vol11_dr     aggr5_dp     online     DP   250GB    45.65GB   81%
22 entries were displayed.

The following example displays detailed information about a volume named vol1 on an SVM named vs1:

cluster1::*> volume show -vserver vs1 -volume vol1
Vserver Name: vs1
                                       Volume Name: vol1
                                    Aggregate Name: aggr1
                                       Volume Size: 30MB
                                Volume Data Set ID: 1026
                         Volume Master Data Set ID: 2147484674
                                      Volume State: online
                                       Volume Type: RW
                                      Volume Style: flex
                                 Is Cluster Volume: true
                             Is Constituent Volume: false
                                     Export Policy: default
                                           User ID: root
                                          Group ID: daemon
                                    Security Style: mixed
                                  Unix Permissions: ---rwx------
                                     Junction Path: -
                              Junction Path Source: -
                                   Junction Active: -
                            Junction Parent Volume: -
                                           Comment:
                                    Available Size: 23.20MB
                                   Filesystem Size: 30MB
                           Total User-Visible Size: 28.50MB
                                         Used Size: 5.30MB
                                   Used Percentage: 22%
              Volume Nearly Full Threshold Percent: 95%
                     Volume Full Threshold Percent: 98%
              Maximum Autosize (for flexvols only): 8.40GB
                                  Minimum Autosize: 30MB
                Autosize Grow Threshold Percentage: 85%
              Autosize Shrink Threshold Percentage: 50%
                                     Autosize Mode: off
              Autosize Enabled (for flexvols only): false
               Total Files (for user-visible data): 217894
                Files Used (for user-visible data): 98
                             Space Guarantee Style: volume
                         Space Guarantee In Effect: true
                 Snapshot Directory Access Enabled: true
                Space Reserved for Snapshot Copies: 5%
                             Snapshot Reserve Used: 98%
                                   Snapshot Policy: default
                                     Creation Time: Mon Jul 08 10:54:32 2013
                                          Language: C.UTF-8
                                      Clone Volume: false
                                         Node name: cluster-1-01
                                     NVFAIL Option: off
           Force NVFAIL on MetroCluster Switchover: off
                         Is File System Size Fixed: false
                                     Extent Option: off
                     Reserved Space for Overwrites: 0B
                                Fractional Reserve: 100%
                 Primary Space Management Strategy: volume_grow
                          Read Reallocation Option: space-optimized
                  Inconsistency in the File System: false
                      Is Volume Quiesced (On-Disk): false
                    Is Volume Quiesced (In-Memory): false
                        Transition Operation State: none
                             Copied for Transition: false
                                      Transitioned: true
         Volume Contains Shared or Compressed Data: false
                                 Efficiency Policy: default
                     UUID of the Efficiency Policy: b0f36cd7-e7bc-11e2-9994-123478563412
                 Space Saved by Storage Efficiency: 0B
            Percentage Saved by Storage Efficiency: 0%
                      Space Saved by Deduplication: 0B
                 Percentage Saved by Deduplication: 0%
                     Space Shared by Deduplication: 0B
                        Space Saved by Compression: 0B
             Percentage Space Saved by Compression: 0%
               Volume Size Used by Snapshot Copies: 1.48MB
                                        Block Type: 64-bit
                                  Is Volume Moving: false
                    Flash Pool Caching Eligibility: read-write
     Flash Pool Write Caching Ineligibility Reason: -
                        Managed By Storage Service: -
                               Enable Object Store: -
                           Constituent Volume Role: -
                                  Is cft precommit: false
                             QoS Policy Group Name: -
                               Caching Policy Name: auto
                   Is Volume Move in Cutover Phase: false
           Number of Snapshot Copies in the Volume: 10
   VBN_BAD may be present in the active filesystem: false
            Is Eligible for Auto Balance Aggregate: -
                  Is Volume on a hybrid aggregate: false
                         Total Physical Used Size: 4.55MB
                         Physical Used Percentage: 14%
                     FlexGroup Master Data Set ID: -
                                  FlexGroup Index: -
                            UUID of the FlexGroup: -
          Maximum size of a FlexGroup Constituent: -
                                  Inofile Version: 3
                                    List of Nodes: -
                              Is Volume Flexgroup: false
                                    SnapLock Type: -
                            Vserver DR Protection: -
                                          Healthy: true
                                 Unhealthy Reason:
                    Is Fenced for Protocol Access: false
                      Protocol Access Fence Owner: -
                                   Is SMBC Master: false
                         Is SMBC Failover Capable: false
                                   SMBC Consensus: -