vSphere PowerCLI Reference

Get-VApp

Synopsis

This cmdlet retrieves vApps.

Syntax

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

Related Commands

Online version
Export-VApp
Import-VApp
New-VApp
Remove-VApp
Set-VApp
Start-VApp
Stop-VApp
Move-VApp

Detailed Description

This cmdlet retrieves vApps.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the vApps that you want to retrieve.falsefalse
IdString[]Specifies the IDs of the vApps that you want to retrieve.truefalse
LocationVIContainer[]Specifies Folder, Cluster, Datacenter, VMHost, and ResourcePool objects you want to search for vApps.falsetrue (ByValue)
NoRecursionSwitchParameterIndicates that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.falsefalse
TagTag[]Returns only the vApps that are associated with any of the specified tags.falsefalse

Return Type

Zero or more VApp objects

Notes

Examples

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

Get-ResourcePool MyResourcePool1 | Get-VApp -NoRecursion

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


Copyright © 1998 - 2014 VMware, Inc. All rights reserved.