Share via

Remove-SCLibraryShare

  • Reference
Module:
VirtualMachineManager

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

Syntax

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

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.

Examples

Example 1: Remove a library share object from the VMM library

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 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 but does not delete the share or its contents from the file system on the library server.

Example 2: Remove multiple library share objects from the VMM library

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

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 (an object array).

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LibraryShare

Specifies a VMM library share object.

Type:LibraryShare
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False