Get-Template
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.
Syntax
[-Datastore
<StorageResource[]>]
[-Location <VIContainer[]>]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[CommonParameters]
[-Location <VIContainer[]>]
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
StorageResource[] | named |
|
Filters templates by the datastores or datastore clusters that they are stored on. | optional |
|
VIContainer[] | named |
|
Specifies the vSphere container objects (such as folders, datacenters, and VMHosts) you want to search for templates. | optional |
|
String[] | named |
|
Specifies the names of the virtual machine templates you want to retrieve. | optional |
|
SwitchParameter | named |
|
Indicates that you want to deactivate the recursive behavior of the command. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems 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-VIServer. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
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. | optional |
|
VIServer[] | named |
|
Specifies the vCenter Server systems 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-VIServer. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.Template
Examples
Example 1
Get-Template -Name Web* -Location Datacenter
Retrieves all virtual machine templates in the Datacenter datacenter, whose names start with "Web".
Related Commands
Template
This cmdlet retrieves the virtual machine templates available on a vCenter Server system.
This cmdlet moves virtual machine templates to another location.
This cmdlet modifies the specified virtual machine template.
This cmdlet removes the specified virtual machine templates from the inventory.
This cmdlet creates a new virtual machine template.
