PowerCLI Reference



This cmdlet retrieves vApp templates.


Get-CIVAppTemplate [[-Name] <String[]>] [-Catalog <Catalog[]>] [-Owner <CIUser[]>] [-Server <CIServer[]>] [<CommonParameters>]

Get-CIVAppTemplate -Id <String[]> [-Server <CIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves vApp templates. You can filter the list of the returned templates by name, ID, catalog, and owner.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the vApp templates you want to retrieve.falseFalse
CatalogCatalog[]Specifies the catalog from which you want to retrieve vApp templates.falseTrue (ByValue)
IdString[]Specifies the IDs of the virtual appliance templates 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.
OwnerCIUser[]Specifies the owners of the vApp templates you want to retrieve.falseTrue (ByValue)
ServerCIServer[]Specifies the cloud servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer.falseFalse

Return Type

Zero or more CIVAppTemplate objects



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


Gets a list of all virtual appliance templates visible to you.

-------------------------- Example 2 --------------------------

Get-CIVAppTemplate -Name VAppTemplate

Gets the virtual appliance template named VAppTemplate.

-------------------------- Example 3 --------------------------

Get-CIVAppTemplate -ID vAppTempalteId

Get a vAppTemplate by Id.

-------------------------- Example 4 --------------------------

Get-Catalog Catalog1 | Get-CIVAppTemplate

Gets all virtual appliance templates in the catalog named Catalog1.

Copyright © VMware, Inc. All rights reserved.