Share via

Get-SCVMTemplate

  • Reference
Module:
VirtualMachineManager

Gets virtual machine template objects from the VMM library.

Syntax

Get-SCVMTemplate
   [-VMMServer <ServerConnection>]
   [-ComputerTierTemplate <ComputerTierTemplate>]
   [-All]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCVMTemplate
   [-VMMServer <ServerConnection>]
   [-ComputerTierTemplate <ComputerTierTemplate>]
   [[-Name] <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]
Get-SCVMTemplate
   [-VMMServer <ServerConnection>]
   [-ComputerTierTemplate <ComputerTierTemplate>]
   [-ID <Guid>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Get-SCVMTemplate cmdlet gets virtual machine template objects from the Virtual Machine Manager (VMM) library.

For information about how virtual machine templates are used to create new virtual machines, type Get-Help New-Template -Detailed.

Examples

Example 1: Get all templates stored in the library

PS C:\> Get-SCVMTemplate -VMMServer "VMMServer01.Contoso.com"

This command gets all template objects from the VMM library on VMMServer01, and then displays information about these templates.

Example 2: Get all templates stored in the library that have a similar name

PS C:\> Get-SCVMTemplate -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -like "Windows Server 2008*" }

This command gets all template objects from the VMM library on VMMServer01 whose name begins with "Windows Server 2008," and then displays information about these templates.

Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerTierTemplate

Specifies a computer tier template object.

Type:ComputerTierTemplate
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the name of a VMM object.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Type:UserRole
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

Template

This cmdlet returns a Template object.