Get-CnsVolume
This cmdlet retrieves CNS volume based on the name or ID filter.
Syntax
[-CnsVolumeType
<CnsVolumeType[]>]
[-Datastore <Datastore[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
[-Datastore <Datastore[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
CnsVolumeType[] | named |
|
Specifies the type of the CNS volume. If not specified, all types are queried. | optional |
|
Datastore[] | named |
|
Specifies the datastore in which the CNS volume resides. | optional |
|
String[] | named |
|
Filters the retrieved vSAN file share by name. | optional |
|
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. |
-Id
<String[]>
[-Server <VIServer[]>]
[CommonParameters]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Filters the retrieved vSAN file share by ID. | optional |
|
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 modifies the Cloud Native Storage (CNS) volume metadata of a specified CNS volume.
This cmdlet removes the specified Cloud Native Storage (CNS) volumes.
This cmdlet creates a Cloud Native Storage (CNS) volume.
CnsVolumeAttachment
Remove-CnsVolumeAttachment -CnsVolume -VM [-Server ] [-RunAsync] [-WhatIf] [-Confirm] []
New-CnsVolumeAttachment -CnsVolume -VM [-Server ] [-RunAsync] [-WhatIf] [-Confirm] []
CnsVolumeMetadata
This cmdlet creates a Cloud Native Storage (CNS) volume metadata at the client side.
