Get-CnsVolume Command | Vmware PowerCLI Reference

Get-CnsVolume

This cmdlet retrieves CNS volume based on the name or ID filter.

Syntax

Get-CnsVolume
[-CnsVolumeType < CnsVolumeType[] > ]
[-Datastore < Datastore[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional CnsVolumeType CnsVolumeType[] named
Specifies the type of the CNS volume. If not specified, all types are queried.
optional Datastore Datastore[] named
  • pipeline
  • wildcards
 Specifies the datastore in which the CNS volume resides.
optional Name String[] named
  • wildcards
 Filters the retrieved vSAN file share by name.
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
Get-CnsVolume
-Id < String[] >
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Filters the retrieved vSAN file share by ID.
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

Output

VMware.VimAutomation.Storage.Types.V1.Vsan.Cns.CnsVolume

Examples

Example 1 

Get-CnsVolume -FileServiceDomain $fileServiceDomain

Retrieves the vSAN file share which belongs to the $fileServiceDomain file service domain.

Example 2 

Get-CnsVolume -Datastore $datastore -Name "volume1"

Retrieves the CNS volume named "volume1" that resides in the $datastore datastore.

Related Commands

CnsContainerCluster

This cmdlet creates a vSAN file service IP configuration at the client side.

CnsKubernetesEntityMetadata

This cmdlet creates a Cloud Native Storage (CNS) Kubernetes entity metadata at a client side.

CnsKubernetesEntityReference

This cmdlet creates a Cloud Native Storage (CNS) Kubernetes entity reference at the client side.

CnsVolume

This cmdlet retrieves a Cloud Native Storage (CNS) volume based on the name or ID filter.

This cmdlet creates a Cloud Native Storage (CNS) volume.

This cmdlet removes the specified Cloud Native Storage (CNS) volumes.

This cmdlet modifies the Cloud Native Storage (CNS) volume metadata of a specified CNS volume.

CnsVolumeAttachment

New-CnsVolumeAttachment -CnsVolume &#60CnsVolume&#62 -VM &#60VirtualMachine&#62 [-Server &#60VIServer[]&#62] [-RunAsync] [-WhatIf] [-Confirm] [&#60CommonParameters&#62]

Remove-CnsVolumeAttachment -CnsVolume &#60CnsVolume&#62 -VM &#60VirtualMachine&#62 [-Server &#60VIServer[]&#62] [-RunAsync] [-WhatIf] [-Confirm] [&#60CommonParameters&#62]

CnsVolumeMetadata

This cmdlet creates a Cloud Native Storage (CNS) volume metadata at the client side.