vSphere PowerCLI Reference

Get-CIView

Synopsis

Returns cloud views by Id.

Syntax

Get-CIView [-CIObject] <CIObject[]> [-Server <CIServer[]>] [<CommonParameters>]
Get-CIView -Id <String[]> [-ViewLevel <CIViewLevel>] [-Server <CIServer[]>] [<CommonParameters>]
Get-CIView [-ViewLevel <CIViewLevel>] -SearchResult <CISearchResult[]> [<CommonParameters>]

Related Commands

Online version

Detailed Description

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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
CIObjectCIObject[]Specify cloud objects to get their views.truetrue (ByValue)
IdString[]Specify the Ids of the view object you want to retrieve.truefalse
SearchResultCISearchResult[]Specify a CISearchResult object to get the corresponding view.truetrue (ByValue)
ServerCIServer[]Specify 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.falsefalse
ViewLevelCIViewLevelSpecify 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.falsefalse

Return Type

View

Notes

Examples

-------------- 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.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.