Remove-SCLibraryShare

Article
01/03/2016

Remove-SCLibraryShare

Removes a library share from VMM but does not delete the share from the Windows file system.

Syntax

Parameter Set: Default
Remove-SCLibraryShare [-LibraryShare] <LibraryShare> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-SCLibraryShare cmdlet removes a library share from the Virtual Machine Manager (VMM) library. This cmdlet does not remove any shares or files from the file system on the computer.

This cmdlet returns the object upon success, with the property MarkedForDeletion set to $True, or returns an error message upon failure.

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

-LibraryShare<LibraryShare>

Specifies a VMM library share object.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-PROTipID<Guid]>

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
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

The first command gets the library share object named AllVHDs on LibraryServer01 from the VMM library on VMMServer01, and then stores the object in the $LibShare variable.

The second command removes the library share object and all library objects in this share from the VMM library. This command does not delete the share or its contents from the file system on the library server.

PS C:\> $LibShare = Get-SCLibraryShare -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.name -eq "LibraryServer01.Contoso.com" -and $_.Name -eq "AllVHDs" }
PS C:\> Remove-SCLibraryShare -LibraryShare $LibShare

The first command gets all library share objects on LibraryServer01 whose name includes the string vhd from the VMM library on VMMServer01, and then stores these share objects in the $LibShares variable, which is an object array.

The second command passes each library share object in $LibShares to Remove-SCLibraryShare by using the pipeline operator. The cmdlet removes each of the library share objects and all objects in the share from the VMM library. It does not delete the corresponding shares or their contents from the file system on the library server.

PS C:\> $LibShares = Get-SCLibraryShare -VMMServer "VMMServer01.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -match "vhd" }
PS C:\> $LibShares | Remove-SCLibraryShare

Partager via

Remove-SCLibraryShare