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

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the vApps that you want to retrieve.	false	false
Id	String[]	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.	true	false
Location	VIContainer[]	Specifies Folder, Cluster, Datacenter, VMHost, and ResourcePool objects you want to search for vApps.	false	true (ByValue)
NoRecursion	SwitchParameter	Indicates that you want to disable the recursive behavior of the command.	false	false
Server	VIServer[]	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.	false	false
Tag	Tag[]	Returns only the vApps that are associated with any of the specified tags.	false	false

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.