Syntax
Get-Catalog [[-Name] <String[]>] [-Org <Org[]>] [-MyOrgOnly] [-Server <CIServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet retrieves the specified cloud catalogs.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the names of the cloud catalogs you want to retrieve. | false | false | |
| Id | String[] | 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. | true | false | |
| InformationAction | ActionPreference | false | false | ||
| InformationVariable | String | false | false | ||
| MyOrgOnly | SwitchParameter | Indicates that you want to retrieve catalogs only from the organization which is currently connected. | false | false | |
| Org | Org[] | Specifies the organizations from which you want to retrieve catalogs. | false | true (ByValue) | |
| PipelineVariable | String | false | false | ||
| Server | CIServer[] | Specifies the cloud servers 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 Connect-CIServer. | false | false |
Return Type
Zero or more Catalog objectsNotes
Examples
-------------- 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.