Get-CIVMTemplate Command | Vmware PowerCLI Reference

Get-CIVMTemplate

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

Syntax

Get-CIVMTemplate
-Catalog < Catalog[] >
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Catalog Catalog[] named
  • pipeline
  • wildcards
 Specifies the catalogs from which you want to retrieve cloud virtual machine templates.
optional Name String[] named
  • wildcards
 Specifies the names of the cloud virtual machine templates you want to retrieve.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
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-CIVMTemplate
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Specifies the IDs of the cloud 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 ProgressAction ActionPreference named
optional Server CIServer[] named
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-CIVMTemplate
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < CIServer[] > ]
[-VAppTemplate < CIVAppTemplate[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
  • wildcards
 Specifies the names of the cloud virtual machine templates you want to retrieve.
optional ProgressAction ActionPreference named
optional Server CIServer[] named
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.
optional VAppTemplate CIVAppTemplate[] named
  • pipeline
  • wildcards
 Specifies the vApp templates from which you want to retrieve cloud virtual machine templates.

Output

VMware.VimAutomation.Cloud.Types.V1.CIVMTemplate

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".

Related Commands

CIVM

This cmdlet retrieves virtual machines in the cloud.

This cmdlet creates a new cloud virtual machine.

This cmdlet resets the specified virtual machine.

This cmdlet powers on the specified virtual machine.

This cmdlet powers off the specified virtual machine.

This cmdlet suspends the specified virtual machine.

CIVMGuest

This cmdlet restarts the guest operating system of the specified virtual machine.

This cmdlet shuts down the guest operating system of the specified virtual machine.

CIVMTemplate

This cmdlet retrieves the virtual machine templates in the cloud.