Set-VsanFileShare Command | Vmware PowerCLI Reference

Set-VsanFileShare

This cmdlet modifies the configuration of a specified vSAN file share.

Syntax

Set-VsanFileShare
-FileShare < VsanFileShare[] >
[-FileShareNetworkPermission < VsanFileShareNetworkPermission[] > ]
[-Force ]
[-HardQuotaGB < Decimal > ]
[-Name < String > ]
[-RemoveLabel < String[] > ]
[-Server < VIServer[] > ]
[-SetLabel < Hashtable > ]
[-SoftQuotaGB < Decimal > ]
[-StoragePolicy < SpbmStoragePolicy > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 FileShare VsanFileShare[] named
  • pipeline
  • wildcards
 Specifies the list of vSAN file shares you want to update.
optional FileShareNetworkPermission VsanFileShareNetworkPermission[] named
Specifies the new file share network permission settings of the vSAN file share.
optional Force SwitchParameter named
Indicates that you want to remove the vSAN file share (for example, the file share whose ManagingEntity is the Cloud Native Storage (CNS) service).
optional HardQuotaGB Decimal named
Specifies the new hard quota in GB of the vSAN file share.
optional Name String named
Specifies the new name of the vSAN file share.
optional RemoveLabel String[] named
Specifies the label key that you want to remove from the vSAN file share. If a specified label key does not exist in the vSAN file share, the deletion of this label is ignored.
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.
optional SetLabel Hashtable named
Specifies the newly added or updated labels of the vSAN file share. If the label key does not exist in file share, it is added with the provided value. If the label key exists in file share, the value of the key is updated.
optional SoftQuotaGB Decimal named
Specifies the new soft quota in GB of the vSAN file share.
optional StoragePolicy SpbmStoragePolicy named
  • wildcards
 Specifies the new storage policy of the vSAN file share.

Output

VMware.VimAutomation.Storage.Types.V1.Vsan.FileService.VsanFileShare

Examples

Example 1 

Set-VsanFileShare -FileShare $fileShare -Name "NewName" -SoftQuotaGB 20

Renames the $fileShare vSAN file share to "NewName" and sets the soft quota to 20 GB.

Related Commands

VsanFileServerIpConfig

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

VsanFileServiceDomain

This cmdlet retrieves vSAN file service domains in a vSAN cluster.

This cmdlet creates a file service domain in a vSAN cluster.

This cmdlet removes the specified vSAN file service domain from the vSAN clusters.

This cmdlet modifies the settings of the given vSAN file domains.

VsanFileServiceOvf

This cmdlet downloads a file service OVF file of the specified URL into the OVF repository in vSphere.

VsanFileServiceOvfInfo

This cmdlet retrieves a vSAN file service OVF information.

VsanFileShare

This cmdlet retrieves vSAN file shares based on the name or ID filter.

This cmdlet creates a new vSAN file share in a specified file service domain.

This cmdlet removes vSAN file shares.

This cmdlet modifies the configuration of a specified vSAN file share.

VsanFileShareNetworkPermission

New-VsanFileShareNetworkPermission -IPSetOrSubnet &#60string&#62 -VsanFileShareAccessPermission &#60VsanFileShareAccessType&#62 [-AllowSquashRoot] [-WhatIf] [-Confirm] [&#60CommonParameters&#62]

VsanFileShareSnapshot

This cmdlet retrieves vSAN file share snapshots based on the name or other filters.

This cmdlet creates a vSAN file share snapshot for the specified vSAN file share.

This cmdlet removes vSAN file share snapshots.