Get-VApp

This cmdlet retrieves vApps.

Syntax

[-Location  <VIContainer[]>]
[-Name  <String[]>]
[-NoRecursion]
[-Server  <VIServer[]>]
[-Tag  <Tag[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Location
VIContainer[] named
  • wildcards
  • pipeline
  • Specifies Folder, Cluster, Datacenter, VMHost, and ResourcePool objects you want to search for vApps.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the vApps that you want to retrieve.
    optional
    NoRecursion
    SwitchParameter named Indicates that you want to deactivate the recursive behavior of the command.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems 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-VIServer.
    optional
    Tag
    Tag[] named Returns only the vApps that are associated with any of the specified tags.

    -Id  <String[]>
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Id
    String[] named
  • wildcards
  • Specifies the IDs of the vApps that 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
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems 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-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Inventory.VApp

    Examples


    Example 1

    Get-ResourcePool MyResourcePool1 | Get-VApp -NoRecursion

    Retrieves all the vApps in the ResourcePool resource pool with no recursion.

    Related Commands

    Feedback

    Was this page helpful?