Syntax
Get-ContentLibrary [-Confirm] -Id <String[]> [-Server <VIServer[]>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet retrieves content libraries and returns a set of content libraries that correspond to the filter criteria defined by the cmdlet parameters.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Name | String[] | Specifies the names of the content libraries you want to retrieve. | false | False | |
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
Id | String[] | Specifies the IDs of the content libraries you want to retrieve. | true | False | |
Local | SwitchParameter | Specifies that you want to retrieve only the local content libraries. | false | False | |
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. | false | False | |
Subscribed | SwitchParameter | Specifies that you want to retrieve only the subscribed content libraries. | false | False | |
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more LocalContentLibrary or SubscribedContentLibrary objectsNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> Get-ContentLibrary
Retrieves all content libraries from the default connected servers.
-------------------------- Example 2 --------------------------
PS C:\> Get-ContentLibrary -Local
Returns all local content libraries from the default connected servers.
-------------------------- Example 2 --------------------------
PS C:\> Get-ContentLibrary -Name 'Local*'
Retrieves all content libraries whose name starts with 'Local' from the default connected servers.