vSphere PowerCLI Reference

Get-CIVMTemplate

Synopsis

This cmdlet retrieves the virtual machine templates in the cloud.

Syntax

Get-CIVMTemplate [-VAppTemplate <CIVAppTemplate[]>] [[-Name] <String[]>] [-Server <CIServer[]>] [<CommonParameters>]
Get-CIVMTemplate -Id <String[]> [-Server <CIServer[]>] [<CommonParameters>]
Get-CIVMTemplate -Catalog <Catalog[]> [[-Name] <String[]>] [-Server <CIServer[]>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves the virtual machine templates in the cloud and filters them by the provided parameters.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the cloud virtual machine templates you want to retrieve.falsefalse
CatalogCatalog[]Specifies the catalogs from which you want to retrieve cloud virtual machine templates.truetrue (ByValue)
IdString[]Specifies the IDs of the cloud virtual machine templates you want to retrieve.truefalse
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
VAppTemplateCIVAppTemplate[]Specifies the vApp templates from which you want to retrieve cloud virtual machine templates.falsetrue (ByValue)

Return Type

Zero or more CIVMTemplate objects

Notes

Examples

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

Get-Catalog "myCatalog" | Get-CIVMTemplate

Retrieves all cloud virtual machine templates from a catalog named "myCatalog".

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

Get-CIVAppTemplate "myCIVAppTemplate" | Get-CIVMTemplate -Name "myVMTemplate"

Retrieves a cloud virtual machine template named "myVMTemplate" from a vApp template named "myCIVAppTemplate".


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