Set-CnsVolume Command | Vmware PowerCLI Reference

Set-CnsVolume

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

Syntax

Set-CnsVolume
-CnsVolume < CnsVolume[] >
-CnsVolumeMetadata < CnsVolumeMetadata >
[-ProgressAction < ActionPreference > ]
[-RunAsync ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 CnsVolume CnsVolume[] named
  • pipeline
  • wildcards
 Specifies the CNS volumes you want to update.
required
 CnsVolumeMetadata CnsVolumeMetadata named
  • pipeline
 Specifies the metadata for the CNS volume.
optional ProgressAction ActionPreference named
optional RunAsync SwitchParameter named
optional Server VIServer[] named
  • wildcards
 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 

Set-CnsVolume -CnsVolume $cnsVolume -CnsVolumeMetadata $cnsVolumeMetadata

Updates the $cnsVolumeMetadata CNS volume metadata to the $cnsVolume CNS volume.

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 <CnsVolume> -VM <VirtualMachine> [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Remove-CnsVolumeAttachment -CnsVolume <CnsVolume> -VM <VirtualMachine> [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

CnsVolumeMetadata

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