< Back

Get-VApp

Sun Jan 19, 2020 6:53 pm

NAME Get-VApp



SYNOPSIS

This cmdlet retrieves vApps.





SYNTAX

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



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

[<CommonParameters>]





DESCRIPTION

This cmdlet retrieves vApps.





PARAMETERS

-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.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Location <VIContainer[]>

Specifies Folder, Cluster, Datacenter, VMHost, and ResourcePool objects you want to search for vApps.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the vApps that you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-NoRecursion [<SwitchParameter>]

Indicates that you want to disable the recursive behavior of the command.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Tag <Tag[]>

Returns only the vApps that are associated with any of the specified tags.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more VApp objects







NOTES









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



Get-ResourcePool MyResourcePool1 | Get-VApp -NoRecursion



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... -VApp.html

Export-VApp

Import-VApp

New-VApp

Remove-VApp

Set-VApp

Start-VApp

Stop-VApp

Move-VApp