Syntax
Set-VsanFileShare [-FileShare] <VsanFileShare[]> [-Confirm] [-FileShareNetworkPermission <VsanFileShareNetworkPermission[]>] [-HardQuotaGB <Decimal>] [-SetLabel <Hashtable>] [-RemoveLabel <String[]>] [-Name <String>] [-Server <VIServer[]>] [-SoftQuotaGB <Decimal>] [-StoragePolicy <SpbmStoragePolicy>] [-WhatIf] [-Force] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the configuration of a specified vSAN file share.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| FileShare | VsanFileShare[] | Specifies the list of vSAN file shares you want to update. | true | True (ByValue) | |
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
| FileShareNetworkPermission | VsanFileShareNetworkPermission[] | Specifies the new file share network permission settings of the vSAN file share. | false | False | |
| Force | SwitchParameter | Indicates that you want to remove the vSAN file share (for example, the file share whose ManagingEntity is the Cloud Native Storage (CNS) service). | false | False | |
| HardQuotaGB | Decimal | Specifies the new hard quota in GB of the vSAN file share. | false | False | |
| Name | String | Specifies the new name of the vSAN file share. | false | False | |
| RemoveLabel | String[] | 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. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. | false | False | |
| SetLabel | Hashtable | 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. | false | False | |
| SoftQuotaGB | Decimal | Specifies the new soft quota in GB of the vSAN file share. | false | False | |
| StoragePolicy | SpbmStoragePolicy | Specifies the new storage policy of the vSAN file share. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
List of modified vSAN file share objects.Notes
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.