Set-VsanFileShare
This cmdlet modifies the configuration of a specified vSAN file share.
Syntax
-FileShare
<VsanFileShare[]>
[-FileShareNetworkPermission <VsanFileShareNetworkPermission[]>]
[-Force]
[-HardQuotaGB <Decimal>]
[-Name <String>]
[-RemoveLabel <String[]>]
[-Server <VIServer[]>]
[-SetLabel <Hashtable>]
[-SoftQuotaGB <Decimal>]
[-StoragePolicy <SpbmStoragePolicy>]
[CommonParameters]
[-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 |
|
VsanFileShare[] | named |
|
Specifies the list of vSAN file shares you want to update. | optional |
|
VsanFileShareNetworkPermission[] | named |
|
Specifies the new file share network permission settings of the vSAN file share. | optional |
|
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 |
|
Decimal | named |
|
Specifies the new hard quota in GB of the vSAN file share. | optional |
|
String | named |
|
Specifies the new name of the vSAN file share. | optional |
|
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 |
|
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. | optional |
|
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 |
|
Decimal | named |
|
Specifies the new soft quota in GB of the vSAN file share. | optional |
|
SpbmStoragePolicy | named |
|
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 modifies the settings of the given vSAN file domains.
This cmdlet removes the specified vSAN file service domain from the vSAN clusters.
This cmdlet creates a file service domain in a vSAN cluster.
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 modifies the configuration of a specified vSAN file share.
This cmdlet removes vSAN file shares.
This cmdlet creates a new vSAN file share in a specified file service domain.
VsanFileShareNetworkPermission
New-VsanFileShareNetworkPermission -IPSetOrSubnet -VsanFileShareAccessPermission [-AllowSquashRoot] [-WhatIf] [-Confirm] []
VsanFileShareSnapshot
This cmdlet retrieves vSAN file share snapshots based on the name or other filters.
This cmdlet removes vSAN file share snapshots.
This cmdlet creates a vSAN file share snapshot for the specified vSAN file share.
