Get-Catalog
This cmdlet retrieves the specified cloud catalogs.
Syntax
[-MyOrgOnly
]
[-Name
< String[] > ]
[-Org
< Org[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< CIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | MyOrgOnly | SwitchParameter | named |
|
Indicates that you want to retrieve catalogs only from the organization which is currently connected. |
| optional | Name | String[] | named |
|
Specifies the names of the cloud catalogs you want to retrieve. |
| optional | Org | Org[] | named |
|
Specifies the organizations from which you want to retrieve catalogs. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. |
-Id
< String[] >
[-ProgressAction
< ActionPreference > ]
[-Server
< CIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Specifies the IDs of the cloud catalogs you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. |
Output
VMware.VimAutomation.Cloud.Types.V1.CatalogExamples
Example 1
Get-Catalog
Gets all visible catalogs for the current user.
Example 2
Get-Catalog -Name "MyCatalog1"
Gets an existing catalog named "MyCatalog".
Example 3
Get-Catalog -ID $catalogId
Gets a catalog with a given ID.
Example 4
Get-Org -Name "Organization1" | Get-Catalog
Gets all visible catalogs for an organization.
Example 5
Connect-CIServer $ip -Name $nonSysAdminUser -Pass $pass Get-Catalog -MyOrgOnly
Gets all catalogs from my organization.
Related Commands
Catalog
This cmdlet retrieves the specified cloud catalogs.