powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-CIView



NAME
Get-CIView

SYNOPSIS
Returns cloud views by Id.

SYNTAX
Get-CIView [-CIObject] [-Server ] []

Get-CIView -Id [-ViewLevel ] [-Server ] []

Get-CIView [-ViewLevel ] -SearchResult []


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 pres
ent in the CISearchResult objects.
If an Id is specified, the result view is determined by the ViewType parameter. If ViewType is not passed, the cmdl
et returns the most complete representation of the object visible to the user by using the following priority: Exte
nsion, Admin, User.


PARAMETERS
-CIObject
Specify cloud objects to get their views.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Server
Specify the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the comm
and runs on the default servers. For more information about default servers, see the description of Connect-CIS
erver.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Id
Specify the Ids of the view object you want to retrieve.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ViewLevel
Specify 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 explici
tly requests the exact abstraction you want to retrieve.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-SearchResult
Specify a CISearchResult object to get the corresponding view.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
View


NOTES




-------------- Example 1 --------------

C:\PS>$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 --------------

C:\PS>$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 --------------

C:\PS>$Org = Get-Org -Name Organization1 | Get-CIView


Gets a cloud organization view from the result returned by the Get-Org cmdlet.





-------------- Example 4 --------------

C:\PS>$userCatalog = Get-CIView -Id $catalog.Id -ViewLevel User


Gets the User cloud representation of the catalog.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-CIView.html