Get-CIVAppTemplate Command | Vmware PowerCLI Reference

Get-CIVAppTemplate

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

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
optional Catalog Catalog[] named
  • pipeline
  • wildcards
 Specifies the catalog from which you want to retrieve vApp templates.
optional Name String[] named
  • wildcards
 Specifies the names of the vApp templates you want to retrieve.
optional Owner CIUser[] named
  • pipeline
  • wildcards
 Specifies the owners of the vApp templates you want to retrieve.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
  • wildcards
 Specifies the cloud servers 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-CIServer.
Get-CIVAppTemplate
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
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.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
  • wildcards
 Specifies the cloud servers 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-CIServer.

Output

VMware.VimAutomation.Cloud.Types.V1.CIVAppTemplate

Examples

Example 1 

Get-CIVAppTemplate

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.

Related Commands

CIVApp

This cmdlet retrieves virtual appliances in the cloud.

This cmdlet imports a virtual machine from the underlying vSphere to the cloud.

This cmdlet creates a new vApp.

This cmdlet removes vApps from the cloud.

This cmdlet restarts the specified vApp.

This cmdlet modifies the configuration of the specified vApps in the cloud.

This cmdlet starts the specified vApp.

This cmdlet stops the specified vApp.

This cmdlet suspends the specified vApp.

CIVAppGuest

This cmdlet restarts the guest operating systems of all virtual machines in the specified vApp.

This cmdlet shuts down the guest operating systems of all virtual machines in the specified vApp.

CIVAppNetwork

This cmdlet retrieves the vApp networks available on a vCloud Director server.

This cmdlet creates a new vApp network.

This cmdlet removes the specified vApp networks if they are not in use.

This cmdlet modifies the configuration of the specified vApp networks.

CIVAppStartRule

This cmdlet retrieves the start rules for virtual machines in a specified vApp.

This cmdlet modifies the start rules for virtual machines in the specified vApp.

CIVAppTemplate

This cmdlet retrieves vApp templates.

This cmdlet imports a virtual machine or an OVF package from vCenter Server to vCloud Director as a vApp template.

This cmdlet creates a new vApp template.

This cmdlet removes the specified vApp template.

This cmdlet modifies the configuration of the specified vApp template.