New-SCVMTemplate

Syntax

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-VMMServer <ServerConnection>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-Generation <Int32>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxAdministratorSSHKey <SSHKey>]
   [-LinuxAdministratorSSHKeyString <String>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-Shielded \<Boolean\>]
   [-DeploymentTypeNano \<Boolean\>]
   [-NoCustomization]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-AutomaticCriticalErrorAction <UInt16>]
   [-AutomaticCriticalErrorActionTimeout <Int32>]
   [-CheckpointType <CheckpointType>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   -JobGroup <Guid>
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-Generation <Int32>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxAdministratorSSHKey <SSHKey>]
   [-LinuxAdministratorSSHKeyString <String>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-Shielded \<Boolean\>]
   [-DeploymentTypeNano \<Boolean\>]
   -VirtualHardDisk <StandaloneVirtualHardDisk>
   [-NoCustomization]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-AutomaticCriticalErrorAction <UInt16>]
   [-AutomaticCriticalErrorActionTimeout <Int32>]
   [-CheckpointType <CheckpointType>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxAdministratorSSHKey <SSHKey>]
   [-LinuxAdministratorSSHKeyString <String>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-DeploymentTypeNano \<Boolean\>]
   -VMTemplate <Template>
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxAdministratorSSHKey <SSHKey>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-DeploymentTypeNano \<Boolean\>]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxAdministratorSSHKeyString <String>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-DeploymentTypeNano \<Boolean\>]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

New-SCVMTemplate
   [-HighlyAvailable \<Boolean\>]
   [-DRProtectionRequired \<Boolean\>]
   [-ApplicationProfile <ApplicationProfile>]
   [-SQLProfile <SQLProfile>]
   [-GuiRunOnceCommands <String[]>]
   [-MergeAnswerFile \<Boolean\>]
   [-AnswerFile <Script>]
   [-OperatingSystem <OperatingSystem>]
   [-LinuxDomainName <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-ReplicationGroup <ReplicationGroup>]
   [-DeploymentTypeNano \<Boolean\>]
   -VM <VM>
   [-BootVirtualHardDisk <VirtualHardDisk>]
   [-SkipRearm]
   [-LibraryServer <LibraryServer>]
   [-SharePath <String>]
   [-NoCustomization]
   [-Name] <String>
   [-Description <String>]
   [-Owner <String>]
   [-UserRole <UserRole>]
   [-HardwareProfile <HardwareProfile>]
   [-GuestOSProfile <GuestOSProfile>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled \<Boolean\>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled \<Boolean\>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPURelativeWeight <Int32>]
   [-CapabilityProfile <CapabilityProfile>]
   [-HAVMPriority <UInt32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-CPUReserve <UInt16>]
   [-CPUMaximumPercent <Int32>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired \<Boolean\>]
   [-SecureBootEnabled \<Boolean\>]
   [-SecureBootTemplate <String>]
   [-FullName <String>]
   [-OrganizationName <String>]
   [-ComputerName <String>]
   [-ProductKey <String>]
   [-LocalAdministratorCredential <VMMCredential>]
   [-TimeZone <Int32>]
   [-RemoveServerFeatures]
   [-Domain <String>]
   [-DomainJoinCredential <VMMCredential>]
   [-Workgroup <String>]
   [-AutoLogonCredential <RunAsAccount>]
   [-AutoLogonCount <UInt32>]
   [-DisableAutoLogon]
   [-UnattendSettings <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-UpdateManagementProfile <AzureProfile>]
   [-DomainJoinOrganizationalUnit <String>]
   [-RemoveDomainJoinOrganizationalUnit]
   [-JobGroup <Guid>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

Description

The New-SCVMTemplate cmdlet creates a virtual machine template that administrators or self-service users can use to create virtual machines managed by Virtual Machine Manager (VMM). A template stores hardware configuration and guest operating system information so that a specific template can be used repeatedly to create new virtual machines. The New-SCVMTemplate cmdlet stores the new template object in the VMM library.

You can create a template based on an existing virtual hard disk, an existing template, or from a virtual machine currently deployed on a virtual machine host. If you specify no parameters, VMM creates a default template object.

VMM Template Requirements

This section describes the requirements for creating a template in VMM.

• Template from VHD. If you create a template from a virtual hard disk (VHD), the VHD must meet the following requirements:

  • Operating system. You must install a supported Windows operating system on the virtual hard disk before you use it to create the template. For information about supported operating systems, see Operating Systems Compatibility for System Center Technical Preview in the TechNet library at https://technet.microsoft.com/en-us/library/dn997307(v=sc.16).aspx.

• SysPrep. You must run the System Preparation tool (Sysprep.exe) on the VHD to ensure that every copy of the operating system is unique when you distribute it to multiple virtual machines. You can find Sysprep.exe installed on your Windows Server 2008 or later computer at its default location: C:\Windows\System32\sysprep.

• Local Administrator Password. The local Administrator password of the guest operating system on a VHD that will be used to create a new template must be blank before you run Sysprep.exe on the virtual hard disk. A blank local Administrator password is required to enable you to have the option to specify the local Administrator password when you customize the guest operating system on the template.

• Template from a Virtual Machine. If you create a template from a virtual machine, the virtual machine will be destroyed during the process of converting it to a template. If you want to keep the virtual machine and also use it to create a template, you can clone the virtual machine before you create the template. For information about how to clone a virtual machine, see New-SCVirtualMachine.

• Template for Self-Service Users. If a self-service user role includes permission to use a template, the self-service user cannot change any hardware profile settings. The only settings that a self-service user can change when using a template to create a virtual machine are computer name and, if the user has appropriate privileges, password and product ID number.

VMM Support for Customizable or Non-Customizable Templates

If you specify the NoCustomization parameter with the New-SCVMTemplate cmdlet, you do not need to add a guest operating system profile to the template as you create the template. Without a guest operating system profile, VMM will not require Sysprep to run within the guest operating system when a virtual machine that is created by using this template is deployed on a host.

One possible scenario is that you have a manually sysprepped virtual hard disk that contains a non-Windows operating system (or that contains an operating system that VMM cannot automatically sysprep) and have embedded an answer file in that virtual hard disk that contains the appropriate settings for that operating system. You can use the New-SCVMTemplate cmdlet to create a template from this virtual hard disk and specify that the template does not allow customization of the guest operating system. To do so, use the NoCustomization parameter when you create the new template.

In another scenario, you might import a VMware-based template that contains a Windows-based operating system into VMM. By default, VMM imports a VMware-based template as customizable if VMM knows how to customize the guest operating system. Otherwise, the template is imported as non-customizable (this is true, for example, for Linux guest operating systems). If you want to create a non-customizable Windows-based template from this imported, customizable VMware-based template, you can use New-SCVMTemplate to create a new template, point to the disks that are attached to the imported template, and then specify the NoCustomization parameter on the new template.

Examples

Example 1: Create a virtual machine template from a virtual hard disk

PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "64-bit Edition of Windows Server 2008 R2 Datacenter"}
PS C:\> $VHD = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "VHD01.vhd" -and $_.LibraryServer.Name -eq "LibServer01.Contoso.com" }
PS C:\> New-SCVMTemplate -Name "VMTemplate01" -VirtualHardDisk $VHD -OperatingSystem $OS -NoCustomization

The first command gets the specified operating system object (64-bit edition of Windows Server 2008 R2 Datacenter) and stores the object in the $OS variable.

The second command gets the virtual hard disk object named VHD01 from the VMM library on LibServer01 and stores the object in the $VHD variable.

The last command creates a virtual machine template named VMTemplate01 from VHD01, and specifies the name of the operating system. No customization is made to the operating system.

Note: This example assumes that VHD01 is a SysPrepped virtual hard disk on which the 64-bit edition of the Windows Server 2008 R2 Datacenter operating system is installed. You can install virtualization guest services on the virtual machine, or VMM will install them automatically when the virtual machine is deployed on a Windows-based host.

Example 2: Create a virtual machine template from an existing virtual machine

PS C:\> $LibraryServer = Get-SCLibraryServer | where {$_.Name -eq "LibServer01.Contoso.com"}
PS C:\> $VM = Get-SCVirtualMachine -Name "VM01" | where {$_.VMHost.Name -eq "VMHost02.Contoso.com"}
PS C:\> $OperatingSystem = Get-SCOperatingSystem | where {$_.Name -eq "64-bit Edition of Windows Server 2008 R2 Enterprise"}
PS C:\> New-SCVMTemplate -Name "VMTemplate02" -RunAsynchronously -VM $VM -Owner "Contoso\ReneeLo" -LibraryServer $LibraryServer -SharePath "\\LibServer01.Contoso.com\MSSCVMMLibrary" -OperatingSystem $OperatingSystem -NoCustomization

The first command gets the library server object named LibServer01 and stores the object in the $LibraryServer variable.

The second command gets the virtual machine object named VM01 deployed on VMHost02 and stores the object in the $VM variable.

Note: VM01, which is the virtual machine that will be converted to a template, will be destroyed during the conversion process. If you want to retain the virtual machine used to create a template, you can use the New-SCVirtualMachine cmdlet to clone the virtual machine before you create the template.

The third command gets the specified operating system object (Windows Server 2008 R2 Enterprise) and stores the object in the $OS variable.

The last command creates a virtual machine template named VMTemplate02 from virtual machine VM01. It specifies the owner of the new template, the library server and share where you want to store the new template, and the name of the operating system, without any customization to the operating system. The RunAsynchronously parameter returns control to the shell immediately before the command completes.

Example 3: Create a virtual machine template from a virtual hard disk with specified characteristics

PS C:\> $JobGroupId01 = [Guid]::NewGuid().ToString()
PS C:\> $LogNet = Get-SCLogicalNetwork -Name "LogicalNetwork01"
PS C:\> New-SCVirtualNetworkAdapter -JobGroup $JobGroupID01 -MACAddressType Dynamic -LogicalNetwork $LogNet
PS C:\> New-SCVirtualSCSIAdapter -JobGroup $JobGroupID01 -AdapterID 6 -Shared $False
PS C:\> New-SCVirtualDVDDrive -JobGroup $JobGroupID01 -Bus 1 -LUN 0
PS C:\> New-SCHardwareProfile -Name "TempHWProfile" -Owner "Contoso\ReneeLo" -Description "Temporary hardware profile used to create a VM Template" -MemoryMB 512 -JobGroup $JobGroupID01
PS C:\> $JobGroupId02 = [Guid]::NewGuid().ToString()
PS C:\> $VHD = Get-SCVirtualHardDisk | where {$_.Location -eq "\\VMHost01Share\VHDs\Template.vhd"} | where {$_.HostName -eq "VMHost01.Contoso.com"}
PS C:\> New-SCVirtualDiskDrive -IDE -Bus 0 -LUN 0 -JobGroup $JobGroupID02 -VirtualHardDisk $VHD
PS C:\> $HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "TempHWProfile" }
PS C:\> $OS = Get-SCOperatingSystem | where {$_.Name -eq "64-bit Edition of Windows Server 2008 R2 Enterprise"}
PS C:\> New-SCVMTemplate -Name "NewTemplate03" -Owner "Contoso\ReneeLo" -HardwareProfile $HWProfile -JobGroup $JobGroupID02 -ComputerName "*" -JoinWorkgroup "WORKGROUP" -OperatingSystem $OS -RunAsynchronously

The first command generates a globally unique identifier (GUID) and stores the GUID string in variable $JobGroupID01. The job group ID functions as an identifier that groups subsequent commands that include $JobGroupID01 into a single job group.

The second command gets the logical network object named LogicalNetwork01 and stores the object in the $LogNet variable.

The third command creates a virtual network adapter and uses the JobGroup parameter to indicate that the network adapter is not created until just before the New-SCHardwareProfile cmdlet runs. The New-SCVirtualNetworkAdapter cmdlet sets the MAC address type to dynamic and specifies that the new virtual network adapter will connect to the logical network stored in $LogNet.

The fourth command creates a virtual SCSI adapter and uses the JobGroup parameter to indicate that the SCSI adapter is not created until just before the New-SCHardwareProfile cmdlet runs. The New-SCVirtualScsiAdapter cmdlet sets the adapter ID to 6 and sets the Shared parameter to $False so that the adapter is not shared, as would be necessary if you wanted to use it in guest clustering.

The fifth command creates a virtual DVD drive and uses the JobGroup parameter to specify that the DVD drive is not created until just before the New-SCHardwareProfile cmdlet runs. The New-SCVirtualDVDDrive cmdlet specifies Bus 1 and LUN 0 to attach the virtual DVD drive to Secondary Channel (0) on the IDE bus.

The sixth command creates a hardware profile named TempHWProfile, sets the owner to Contoso\ReneeLo, specifies a description and that the amount of memory on the host that a virtual machine created by using this template will use is 512 MB. The New-SCHardwareProfile cmdlet uses the JobGroup parameter to specify that all preceding commands that include variable $JobGroupID01 will run just before New-SCHardwareProfile creates the new hardware profile. After New-SCVirtualNetworkAdapter, New-SCVirtualSCSIAdapter, and New-SCVirtualDVDDrive run, the resulting objects that are created are automatically associated with the new hardware profile.

The seventh command generates a new GUID and stores it in $JobGroupID02. This job group ID will be used to identify any subsequent commands that include this ID and will delay running those commands until just before the last command that specifies $JobGroupID02 runs.

The eighth command uses the Get-SCVirtualHardDisk cmdlet to get the virtual hard disk object named Template.vhd, VHDs on VMHost01 and stores the object in the $VHD variable.

The ninth command creates a new virtual disk drive and attaches the virtual hard disk stored in $VHD (Template.vhd) to this new virtual disk drive. The command specifies Bus 0 and LUN 0 on the IDE Bus so that Template.vhd will be attached to the first slot (0) of the Primary Channel (0) on the IDE bus of the new virtual disk drive. The command uses the JobGroup parameter to specify that the new virtual disk drive is not created until just before the New-SCVMTemplate cmdlet runs in the last command.

The tenth command gets the hardware profile object that represents the hardware profile named TempHWProfile from the VMM library and stores the object in the $HWProfile variable.

The eleventh command gets the specified operating system object (64-bit Edition of Windows Server 2008 R2 Enterprise) and stores the object in the $OS variable.

The last command creates a virtual machine template named NewTemplate03, sets the owner to Contoso\ReneeLo, specifies that this template will use the hardware profile named TempHWProfile, sets the computer name to be randomly generated (indicated by the asterisk *), and specifies that any virtual machine created by using this template will be joined to the workgroup called WORKGROUP. The New-SCVMTemplate cmdlet uses the JobGroup parameter to specify that all preceding commands that include variable $JobGroupID02 run before New-SCVMTemplate creates the new template. After Add-SCVirtualHardDisk runs, the resulting virtual hard disk object that is created is automatically associated with the new template.

Example 4: Create a virtual machine template with the DRProtectionRequired parameter set to $True

PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "Windows Server 2016"}
PS C:\> $VHDX = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "VHDX01.vhdx" -and $_.LibraryServer.Name -eq "LibServer01.Contoso.com" }
PS C:\> New-SCVMTemplate -Name "VMTemplate04" -VirtualHardDisk $VHDX -OperatingSystem $OS -DRProtectionRequired $True

The first command gets the operating system named Windows Server 2016 and stores it in the $OS variable.

The second command gets the virtual hard disk object named VHDX01 from the VMM library and stores the object in the $VHDX variable.

The last command creates a virtual machine template named VMTemplate04 that requires DR protection for the virtual machines created from this template.

Example 5: Create a customizable Linux virtual machine template from a virtual hard disk

PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "CentOS Linux 6 (64 bit)"}
PS C:\> $VHD = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "LinuxVHD01.vhd" -and $_.LibraryServer.Name -eq "LibServer01.Contoso.com" }
PS C:\> New-SCVMTemplate -Name "LinuxVMTemplate01" -VirtualHardDisk $VHD -OperatingSystem $OS

The first command gets the specified operating system object (CentOS Linux 6 (64 bit)) and stores the object in the $OS variable.

The second command gets the virtual hard disk object named LinuxVHD01 from the VMM library on LibServer01 and stores the object in the $VHD variable.

The last command creates a virtual machine template named LinuxVMTemplate01 from LinuxVHD01 and specifies the name of the operating system.

Example 6: Create a virtual machine template with an azure profile for azure update management service

PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "Windows Server 2019 Datacenter"}
PS C:\> $VHD = Get-SCVirtualHardDisk -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "VHD01.vhd" -and $_.LibraryServer.Name -eq "LibServer01.Contoso.com" }
PS C:\> $azureProfile = Get-SCAzureProfile -VMMServer "VMMServer01.Contoso.com" | where { $_.Name -eq "AzUpdateMgmtProfile"}
PS C:\> New-SCVMTemplate -Name "VMTemplate01" -VirtualHardDisk $VHD -OperatingSystem $OS -NoCustomization -UpdateManagementProfile $azureProfile

The first command gets the specified operating system object and stores the object in the $OS variable.

The second command gets the virtual hard disk object named VHD01 from the VMM library on LibServer01 and stores the object in the $VHD variable.

The third commandlet gets the azure profile object named AzUpdateMgmtProfile from the VMM library and stores the object in the $azureProfile variable.

The last command creates a virtual machine template named VMTemplate01 from VHD01 with azure profile and specifies the name of the operating system. No customization is made to the operating system.

Note: This example assumes that VHD01 is a SysPrepped virtual hard disk on which the Windows Server 2019 Datacenter operating system is installed. You can install virtualization guest services on the virtual machine, or VMM will install them automatically when the virtual machine is deployed on a Windows-based host.

Parameters

-AnswerFile

-ApplicationProfile

-AutoLogonCount

-AutoLogonCredential

-AutomaticCriticalErrorAction

-AutomaticCriticalErrorActionTimeout

-BootVirtualHardDisk

-CapabilityProfile

-CheckpointType

-ComputerName

-CPUCount

-CPUMaximumPercent

-CPUPerVirtualNumaNodeMaximum

-CPURelativeWeight

-CPUReserve

-CPUType

-DeploymentTypeNano

-Description

-DisableAutoLogon

-Domain

-DomainJoinCredential

-DomainJoinOrganizationalUnit

-DRProtectionRequired

-DynamicMemoryBufferPercentage

-DynamicMemoryEnabled

-DynamicMemoryMaximumMB

-DynamicMemoryMinimumMB

-EnableNestedVirtualization

-FullName

-Generation

-GuestOSProfile

-GuiRunOnceCommands

-HardwareProfile

-HAVMPriority

-HighlyAvailable

-JobGroup

-JobVariable

-LibraryServer

-LinuxAdministratorSSHKey

-LinuxAdministratorSSHKeyString

-LinuxDomainName

-LocalAdministratorCredential

-MemoryMB

-MemoryPerVirtualNumaNodeMaximumMB

-MemoryWeight

-MergeAnswerFile

-MonitorMaximumCount

-MonitorMaximumResolution

-Name

-NoCustomization

-NumaIsolationRequired

-OperatingSystem

-OrganizationName

-Owner

-ProductKey

-ProtectionProvider

-PROTipID

-RecoveryPointObjective

-RemoveDomainJoinOrganizationalUnit

-RemoveServerFeatures

-ReplicationGroup

-RunAsynchronously

-SecureBootEnabled

-SecureBootTemplate

-SharePath

-Shielded

-SkipRearm

-SQLProfile

-TimeZone

-UnattendSettings

-UpdateManagementProfile

-UserRole

-VirtualHardDisk

-VirtualNumaNodesPerSocketMaximum

-VirtualVideoAdapterEnabled

-VM

-VMMServer

-VMTemplate

-Workgroup

Outputs

Template

This cmdlet returns a Template object.

Related Links

• Get-SCLibraryServer
• Get-SCLogicalNetwork
• Get-SCOperatingSystem
• Get-SCVirtualHardDisk
• Get-SCVirtualMachine
• Get-SCVMTemplate
• New-SCHardwareProfile
• New-SCVirtualDiskDrive
• New-SCVirtualDVDDrive
• New-SCVirtualNetworkAdapter
• New-SCVirtualScsiAdapter
• Remove-SCVMTemplate
• Set-SCVMTemplate