Set-SCStorageFileShare
Set-SCStorageFileShare
Modifies a storage file share.
Syntax
Parameter Set: Default
Set-SCStorageFileShare [-StorageFileShare] <StorageFileShare> [-Description <String> ] [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-StorageClassification <StorageClassification> ] [ <CommonParameters>]
Detailed Description
The Set-SCStorageFileShare cmdlet modifies a storage file share.
Parameters
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StorageClassification<StorageClassification>
Specifies a storage classification object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StorageFileShare<StorageFileShare>
Specifies a storage file share.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Update the storage classification for a storage file share
The first command gets the storage file share object named FileShare01, and then stores the object in the $FileShare variable.
The second command gets the storage classification object named StorageClassification02, and then stores the object in the $StorageClass variable.
The last command changes the storage classification on FileShare01 to StorageClassification02.
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> $StorageClass = Get-SCStorageClassification -Name "StorageClassification02"
PS C:\> Set-SCStorageFileShare -StorageFileShare $FileShare -StorageClassification $StorageClass