Read-SCLibraryShare
Read-SCLibraryShare
Updates the state and metadata of VMM library objects stored in a library share.
Syntax
Parameter Set: Default
Read-SCLibraryShare [-LibraryShare] <LibraryShare> [-JobVariable <String> ] [-Path <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Read-SCLibraryShare cmdlet updates the state and metadata of all Virtual Machine Manager (VMM) library objects stored in the specified library share. This update also finds new library files on the specified library share as well as new child shared folders under the specified library share.
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 |
-Path<String>
Specifies the destination path for the operation.
Example formats:
Local: -Path "F:\"
UNC: -Path "\\Library\Templates"
Volume GUID: -Path "\\?\Volume{4703c1ea-8ae7-11db-b473-00123f7603e3}\"
VMware ESX: -Path "[storage1]\MyVMwareFolderForVMs\MyVM.vmx"
Citrix XenServer: -Path "Local storage[99b6212f-b63d-c676-25f9-d6c460992de7]"
Wildcards are supported for Get- cmdlets and when you specify the UNC path.
Example format:
UNC: -Path "\\VMHostServer\MyVMs\*VM*"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
<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.
- LibraryShare
Examples
Example 1: Update a specified library share
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 updates the state and metadata information for all library objects in the share stored in $LibShare, and then it adds any new library objects found in the share to 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:\> Read-SCLibraryShare -LibraryShare $LibShare
Example 2: Update multiple library shares
The first command gets the library share objects on LibraryServer01 with the string vhd in their names, and then stores the objects in the $LibShares variable.
The second command updates the information for all library shares stored in $LibShares, and then it adds any new library objects found in these shares to the VMM library.
PS C:\> $LibShares = Get-SCLibraryShare -VMMServer "VMMServer1.Contoso.com" | where { $_.LibraryServer.Name -eq "LibraryServer01.Contoso.com" -and $_.Name -match "vhd" }
PS C:\> $LibShares | Read-SCLibraryShare
Example 3: Update a specific subdirectory on a library share
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 updates the state and metadata information for all library objects in the specified subdirectory on the library share that is stored in $LibShare, and then it adds any new library objects found in the share to 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:\> Read-SCLibraryShare -LibraryShare $LibShare -Path "Production\WebFrontEnd"