Get-CIVApp Command | Vmware PowerCLI Reference

Get-CIVApp

This cmdlet retrieves virtual appliances in the cloud. You cannot use the ID parameter with the other cmdlet parameters.

Syntax

Get-CIVApp
[-Name < String[] > ]
[-Org < Org[] > ]
[-OrgVdc < OrgVdc[] > ]
[-OrgVdcNetwork < OrgNetworkBase[] > ]
[-Owner < CIUser[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[-Status < CIVAppStatus[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
  • wildcards
 Specifies the names of the vApps you want to retrieve.
optional Org Org[] named
  • pipeline
  • wildcards
 Specifies the organizations for which you want to retrieve vApps.
optional OrgVdc OrgVdc[] named
  • pipeline
  • wildcards
 Specifies the organization vDCs for which you want to retrieve vApps.
optional OrgVdcNetwork OrgNetworkBase[] named
  • pipeline
 Specifies the organization vDC networks for which you want to retrieve vApps.
optional Owner CIUser[] named
  • pipeline
  • wildcards
 Specifies the owners of the cloud vApps you want to retrieve.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
  • wildcards
 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 Status CIVAppStatus[] named
  • wildcards
 Specifies the status of the vApps you want to retrieve.
Get-CIVApp
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
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.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
  • wildcards
 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.

Output

VMware.VimAutomation.Cloud.Types.V1.CIVApp

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.

Related Commands

CIVApp

This cmdlet retrieves virtual appliances in the cloud.

This cmdlet imports a virtual machine from the underlying vSphere to the cloud.

This cmdlet creates a new vApp.

This cmdlet removes vApps from the cloud.

This cmdlet restarts the specified vApp.

This cmdlet modifies the configuration of the specified vApps in the cloud.

This cmdlet starts the specified vApp.

This cmdlet stops the specified vApp.

This cmdlet suspends the specified vApp.

CIVAppGuest

This cmdlet restarts the guest operating systems of all virtual machines in the specified vApp.

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

CIVAppNetwork

This cmdlet retrieves the vApp networks available on a vCloud Director server.

This cmdlet creates a new vApp network.

This cmdlet removes the specified vApp networks if they are not in use.

This cmdlet modifies the configuration of the specified vApp networks.

CIVAppStartRule

This cmdlet retrieves the start rules for virtual machines in a specified vApp.

This cmdlet modifies the start rules for virtual machines in the specified vApp.

CIVAppTemplate

This cmdlet retrieves vApp templates.

This cmdlet imports a virtual machine or an OVF package from vCenter Server to vCloud Director as a vApp template.

This cmdlet creates a new vApp template.

This cmdlet removes the specified vApp template.

This cmdlet modifies the configuration of the specified vApp template.