Set-SCStorageFileServer
Set-SCStorageFileServer
Adds or removes a storage file share from VMM management.
Syntax
Parameter Set: Default
Set-SCStorageFileServer [-StorageFileServer] <StorageFileServer> [-Description <String> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RemoveStorageFileShareFromManagement <StorageFileShare[]> ] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: EnableFileShareManagement
Set-SCStorageFileServer [-StorageFileServer] <StorageFileServer> -AddStorageFileShareToManagement <StorageFileShare[]> [-Description <String> ] [-JobVariable <String> ] [-PROTipID <Guid> ] [-RemoveStorageFileShareFromManagement <StorageFileShare[]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Set-SCStorageFileServer adds or removes a storage file share from Virtual Machine Manager (VMM) management.
Parameters
-AddStorageFileShareToManagement<StorageFileShare[]>
Enables management of the specified storage file share through VMM.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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 |
-RemoveStorageFileShareFromManagement<StorageFileShare[]>
Removes the specified storage file share from VMM management.
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 |
-StorageFileServer<StorageFileServer>
Specifies a storage file server object.
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
1: Add a storage file share to VMM management.
The first command gets the storage file server objet named FileServer01 and stores the object in the $FileServer variable.
The second command gets the storage file share object named FileShare01 and stores the object in the $FileShare variable.
The last command brings FileShare01 under VMM management.
PS C:\> $FileServer = Get-SCStorageFileServer -Name "FileServer01.Contoso.com"
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> Set-SCStorageFileServer -StorageFileServer $FileServer -AddStorageFileShareToManagement $FileShare
2: Remove a storage file share from VMM management.
The first command gets the storage file server objet named FileServer01 and stores the object in the $FileServer variable.
The second command gets the storage file share object named FileShare01 and stores the object in the $FileShare variable.
The last command removes FileShare01 from VMM management.
PS C:\> $FileServer = Get-SCStorageFileServer -Name "FileServer01.Contoso.com"
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> Set-SCStorageFileServer -StorageFileServer $FileServer -RemoveStorageFileShareFromManagement $FileShare