Unregister-SCStorageFileShare
Unregister-SCStorageFileShare
Unregisters a storage file share from a virtual machine host, cluster, or library server.
Syntax
Parameter Set: UnregisterFromHost
Unregister-SCStorageFileShare [-StorageFileShare] <StorageFileShare> -VMHost <Host> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RemovePermissionsFromShare] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: UnregisterFromCluster
Unregister-SCStorageFileShare [-StorageFileShare] <StorageFileShare> -VMHostCluster <HostCluster> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RemovePermissionsFromShare] [-RunAsynchronously] [ <CommonParameters>]
Parameter Set: UnregisterFromLibrary
Unregister-SCStorageFileShare [-StorageFileShare] <StorageFileShare> -LibraryServer <LibraryServer> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RemovePermissionsFromShare] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Unregister-SCStorageFileShare cmdlet unregisters a storage file share from a virtual machine host, cluster, or library server.
Parameters
-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 |
-LibraryServer<LibraryServer>
Specifies a VMM library server object.
Aliases |
none |
Required? |
true |
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 |
-RemovePermissionsFromShare
Indicates that permissions are removed from the file share.
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 |
-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 |
-VMHost<Host>
Specifies a virtual machine host object. VMM supports Hyper-V hosts, VMware ESX hosts, and Citrix XenServer hosts.
For more information about each type of host, type Get-Help Add-SCVMHost -detailed
. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHostCluster<HostCluster>
Specifies a VMM host cluster object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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: Unregister a storage file share from a library server
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 VMM library server object named LibraryServer01, and then stores the object in the $LibServer variable.
The last command unregisters FileShare01 from LibraryServer01.
PS C:\> $FileShare = Get-SCStorageFileShare -Name "FileShare01"
PS C:\> $LibServer = Get-SCLibraryServer -Computername "LibraryServer01.Contoso.com"
PS C:\> Unregister-SCStorageFileShare -StorageFileShare $FileShare -LibraryServer $LibServer