Get-CIVApp

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

Syntax

[-Name  <String[]>]
[-Org  <Org[]>]
[-OrgVdc  <OrgVdc[]>]
[-OrgVdcNetwork  <OrgNetworkBase[]>]
[-Owner  <CIUser[]>]
[-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
  • wildcards
  • pipeline
  • Specifies the organizations for which you want to retrieve vApps.
    optional
    OrgVdc
    OrgVdc[] named
  • wildcards
  • pipeline
  • 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
  • wildcards
  • pipeline
  • Specifies the owners of the cloud vApps you want to retrieve.
    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.

    -Id  <String[]>
    [-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
    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

    Feedback

    Was this page helpful?