PowerCLI Reference

Get-Template

Synopsis

This cmdlet retrieves the virtual machine templates available on a vCenter Server system.

Syntax

Get-Template [[-Name] <String[]>] [-Datastore <StorageResource[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]

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

Related Commands

Online Version
New-Template
Remove-Template
Set-Template

Detailed Description

This cmdlet retrieves the virtual machine templates available on a vCenter Server system. The cmdlet returns a set of templates that correspond to the filter criteria defined by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the virtual machine templates you want to retrieve.falseFalse
DatastoreStorageResource[]Filters templates by the datastores or datastore clusters that they are stored on.falseTrue (ByValue)
IdString[]Specifies the IDs of the virtual machine 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.
trueFalse
LocationVIContainer[]Specifies the vSphere container objects (such as folders, datacenters, and clusters) you want to search for templates.falseTrue (ByValue)
NoRecursionSwitchParameterIndicates that you want to disable the recursive behavior of the command.falseFalse
ServerVIServer[]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.falseFalse

Return Type

Zero or more Template objects

Notes

Examples

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

Get-Template -Name Web* -Location Datacenter

Retrieves all virtual machine templates in the Datacenter datacenter, whose names start with "Web".


Copyright © VMware, Inc. All rights reserved.