Get-CIView
This cmdlet retrieves cloud views objects. The cmdlet converts CIObject to Cloud view object. Supports getting views from CISearchResult objects returned by the Search-Cloud cmdlet. An Id property must be present in the CISearchResult objects. If an Id is specified, the result view is determined by the ViewType parameter. If ViewType is not passed, the cmdlet returns the most complete representation of the object visible to the user by using the following priority: Extension, Admin, User.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
CIObject | CIObject[] | named |
|
Specifies cloud objects to retrieve their views. |
| 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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Specifies the IDs of the view object 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. |
| optional | ViewLevel | CIViewLevel | named |
|
Specifies a Cloud object representation to be retrieved by object ID. Cloud objects may have an Extension, Admin or User representation that can be retrieved when passing an object ID. Providing a ViewLevel parameter explicitly requests the exact abstraction you want to retrieve. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
SearchResult | CISearchResult[] | named |
|
Specifies a CISearchResult object to get the corresponding view. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | ViewLevel | CIViewLevel | named |
|
Specifies a Cloud object representation to be retrieved by object ID. Cloud objects may have an Extension, Admin or User representation that can be retrieved when passing an object ID. Providing a ViewLevel parameter explicitly requests the exact abstraction you want to retrieve. |
Output
VMware.VimAutomation.Cloud.Views.SchemaConvertableExamples
Example 1
$catalog = Search-Cloud -QueryType Catalog -Name Catalog1 | Get-CIView -ViewLevel Admin
Gets a cloud catalog Admin view using the search result returned by the Search-Cloud cmdlet.
Example 2
$catalogItem = Get-CIView -Id $catalog.CatalogItems.CatalogItem[0].Href
Gets the first catalog item view using the Href property from an already retrieved catalog items collection.
Example 3
$Org = Get-Org -Name Organization1 | Get-CIView
Gets a cloud organization view from the result returned by the Get-Org cmdlet.
Example 4
$userCatalog = Get-CIView -Id $catalog.Id -ViewLevel User
Gets the User cloud representation of the catalog.
Related Commands
CIView
This cmdlet retrieves cloud views by ID.