Syntax
Get-CIVApp [[-Name] <String[]>] [-Server <CIServer[]>] [-Org <Org[]>] [-OrgVdcNetwork <OrgNetworkBase[]>] [-OrgVdc <OrgVdc[]>] [-Owner <CIUser[]>] [-Status <CIVAppStatus[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet retrieves virtual appliances in the cloud. You cannot use the ID parameter with the other cmdlet parameters.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the names of the vApps you want to retrieve. | false | false | |
| Id | String[] | Specifies the IDs of the vApps 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 | ||
| Org | Org[] | Specifies the organizations for which you want to retrieve vApps. | false | true (ByValue) | |
| OrgVdc | OrgVdc[] | Specifies the organization vDCs for which you want to retrieve vApps. | false | true (ByValue) | |
| OrgVdcNetwork | OrgNetworkBase[] | Specifies the organization vDC networks for which you want to retrieve vApps. | false | true (ByValue) | |
| Owner | CIUser[] | Specifies the owners of the cloud vApps you want to retrieve. | 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 | |
| Status | CIVAppStatus[] | Specifies the status of the vApps you want to retrieve. | false | false |
Return Type
Zero or more CIVApp objectsNotes
Examples
-------------- Example 1 --------------
Get-CIVApp
Gets all visible VApps for the current user.
-------------- Example 2 --------------
Get-CIVApp -Name "MyVApp1"
Gets a single VApp named "MyVApp1".
-------------- Example 3 --------------
Get-CIVApp -ID $CloudVAppId
Gets a VApp with a given ID.
-------------- Example 4 --------------
$myOrg = Get-Org -Name "Organization1" Get-CIVApp -Org $myOrg
Gets all visible VApps within an organization.
-------------- Example 5 --------------
Get-OrgNetwork -Name "OrgNetwork1" | Get-CIVApp
Gets all visible VApps within an organization's network.
-------------- Example 6 --------------
Get-OrgVdc -Name "OrgVdc1" | Get-CIVApp
Gets all visible VApps within an organization virtual datacenter using a pipeline syntax.
-------------- Example 7 --------------
Get-CIUser -Name "CloudUserOrg1Admin1" | Get-CIVApp
Gets VApp by its owner using a pipeline syntax.
-------------- Example 8 --------------
Get-CIVApp -Status "PoweredOn"
Gets all VApps by their state.