New-SCVMTemplate
New-SCVMTemplate
Creates a virtual machine template used to create virtual machines managed by VMM.
Syntax
Parameter Set: NewTemplateFromNothing
New-SCVMTemplate [-Name] <String> -JobGroup <Guid]> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-Generation <Int32> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobVariable <String> ] [-LinuxAdministratorSSHKey <SSHKey> ] [-LinuxAdministratorSSHKeyString <String> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NoCustomization] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-VMMServer <ServerConnection> ] [-Workgroup <String> ] [ <CommonParameters>]
Parameter Set: FromTemplate
New-SCVMTemplate [-Name] <String> -VMTemplate <Template> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-LinuxAdministratorSSHKey <SSHKey> ] [-LinuxAdministratorSSHKeyString <String> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-Workgroup <String> ] [ <CommonParameters>]
Parameter Set: FromVHD
New-SCVMTemplate [-Name] <String> -VirtualHardDisk <StandaloneVirtualHardDisk> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-Generation <Int32> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-LinuxAdministratorSSHKey <SSHKey> ] [-LinuxAdministratorSSHKeyString <String> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NoCustomization] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-Workgroup <String> ] [ <CommonParameters>]
Parameter Set: FromVM
New-SCVMTemplate [-Name] <String> -VM <VM> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-BootVirtualHardDisk <VirtualHardDisk> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-LibraryServer <LibraryServer> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NoCustomization] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SharePath <String> ] [-SkipRearm] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-Workgroup <String> ] [ <CommonParameters>]
Parameter Set: SSHKeyFile
New-SCVMTemplate [-Name] <String> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobVariable <String> ] [-LinuxAdministratorSSHKey <SSHKey> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-Workgroup <String> ] [ <CommonParameters>]
Parameter Set: SSHKeyString
New-SCVMTemplate [-Name] <String> [-AnswerFile <Script> ] [-ApplicationProfile <ApplicationProfile> ] [-AutoLogonCount <UInt32> ] [-AutoLogonCredential <RunAsAccount> ] [-CapabilityProfile <CapabilityProfile> ] [-ComputerName <String> ] [-CPUCount <Byte]> ] [-CPUMaximumPercent <Int32]> ] [-CPUPerVirtualNumaNodeMaximum <Byte]> ] [-CPURelativeWeight <Int32]> ] [-CPUReserve <UInt16]> ] [-CPUType <ProcessorType> ] [-Description <String> ] [-DisableAutoLogon] [-Domain <String> ] [-DomainJoinCredential <VMMCredential> ] [-DomainJoinOrganizationalUnit <String> ] [-DRProtectionRequired <Boolean> ] [-DynamicMemoryBufferPercentage <Int32]> ] [-DynamicMemoryEnabled <Boolean]> ] [-DynamicMemoryMaximumMB <Int32]> ] [-DynamicMemoryMinimumMB <Int32]> ] [-FullName <String> ] [-GuestOSProfile <GuestOSProfile> ] [-GuiRunOnceCommands <String[]> ] [-HardwareProfile <HardwareProfile> ] [-HAVMPriority <UInt32]> ] [-HighlyAvailable <Boolean> ] [-JobVariable <String> ] [-LinuxAdministratorSSHKeyString <String> ] [-LinuxDomainName <String> ] [-LocalAdministratorCredential <VMMCredential> ] [-MemoryMB <Int32]> ] [-MemoryPerVirtualNumaNodeMaximumMB <Int32]> ] [-MemoryWeight <Int32]> ] [-MergeAnswerFile <Boolean> ] [-MonitorMaximumCount <Int32]> ] [-MonitorMaximumResolution <String> ] [-NumaIsolationRequired <Boolean]> ] [-OperatingSystem <OperatingSystem> ] [-OrganizationName <String> ] [-Owner <String> ] [-ProductKey <String> ] [-ProtectionProvider <Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]> ] [-PROTipID <Guid]> ] [-RecoveryPointObjective <Int32]> ] [-RemoveDomainJoinOrganizationalUnit] [-RemoveServerFeatures] [-ReplicationGroup <Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup> ] [-RunAsynchronously] [-SQLProfile <SQLProfile> ] [-TimeZone <Int32]> ] [-UnattendSettings <Dictionary`2> ] [-UserRole <UserRole> ] [-VirtualNumaNodesPerSocketMaximum <Byte]> ] [-VirtualVideoAdapterEnabled <Boolean]> ] [-Workgroup <String> ] [ <CommonParameters>]
Detailed 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.
If you create a template from a virtual hard disk, the virtual hard disk 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 System Requirements for System Center 2012 - Virtual Machine Manager (https://go.microsoft.com/fwlink/?LinkID=209608) and System Requirements: VMM Management Server (https://go.microsoft.com/fwlink/?LinkID=316401) in the TechNet Library.
-- Sysprep. You must run the System Preparation tool (Sysprep.exe) on the virtual hard disk 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 virtual hard disk 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.
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.
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.
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.exe 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.
Parameters
-AnswerFile<Script>
Specifies a script object stored in the VMM library to use as an answer file. The name of the answer file script depends on the operating system that you want to install on a virtual machine:
-- Sysprep.inf. Windows XP, Windows Server 2000, or Windows Server 2003.
-- Unattend.xml. Windows Vista, Windows 7, or Windows Server 2008.
Aliases |
SysPrepFile |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ApplicationProfile<ApplicationProfile>
Specifies an application profile object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AutoLogonCount<UInt32>
Specifies the number of times that Windows should automatically log the administrator denoted in the Answer File on to the console session.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AutoLogonCredential<RunAsAccount>
Specifies the Run As account contained in the Answer File that Windows uses to log on to the console session when automatic administrator logon is enabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-BootVirtualHardDisk<VirtualHardDisk>
Specifies the virtual hard disk that contains the operating system file to use when you create a new template.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CapabilityProfile<CapabilityProfile>
Specifies a capability profile object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are:
-- FQDN
-- IPv4 or IPv6 address
-- NetBIOS name
NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPUCount<Byte]>
Specifies the number of CPUs on a virtual machine, on a hardware profile, or on a template. See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
-- Hyper-V. Up to four CPUs per virtual machine, depending on guest operating system.
-- VMware ESX. Up to four CPUs per virtual machine for any supported guest operating system, except for a virtual machine that runs Windows NT 4.0, which supports one CPU.
-- Citrix XenServer. Up to eight CPUs per virtual machine, depending on guest operating system.
Aliases |
ProcessorCount |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPUMaximumPercent<Int32]>
Specifies the highest percentage of the total resources of a single CPU on the host that can be used by a specific virtual machine at any given time.
Example format to specify 80 percent: -CPUMaximumPercent 80
Aliases |
CPUMax |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPUPerVirtualNumaNodeMaximum<Byte]>
Specifies the maximum number of CPUs allowed for each virtual NUMA node.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPURelativeWeight<Int32]>
Specifies the amount of CPU resources on a host that this virtual machine can use relative to other virtual machines on the same host. A virtual machine with a higher setting is allocated more CPU resources than a virtual machine with a lower setting. The range of relative values for each type of host are:
Hyper-V: 1 to 10000
VMware ESX: 2000 = High
1500 = Above Normal
1000 = Normal (default)
750 = Below Normal
500 = Low
1 to 1000000 = Custom
The VMware term for these values is shares.
Citrix XenServer: 1 to 65536, normal is 256
NOTE: See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
Aliases |
RelativeWeight |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPUReserve<UInt16]>
Specifies the minimum percentage of the resources of a single CPU on the host to allocate to a virtual machine. The percentage of CPU capacity that is available to the virtual machine is never less than this percentage.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CPUType<ProcessorType>
Specifies the type of CPU for a virtual machine. To retrieve a list of all CPU types that are available for use in virtual machines in a VMM environment, type Get-SCCPUType.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
States a description for the specified object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DisableAutoLogon
Indicates that this cmdlet disables automatic administrator logon.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Domain<String>
Specifies a fully qualified domain name (FQDN) for an Active Directory domain.
Example format: -Domain "Domain01.Corp.Contoso.com"
Aliases |
JoinDomain |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DomainJoinCredential<VMMCredential>
Specifies the user name and password of an account with permission to join a computer to the domain. A limited rights account should be used for joining physical or virtual computers to the domain.
Example format for a Windows PowerShell credential:
$DomainJoinCredential = Get-Credential -Domain "ThisDomain.Corp.Contoso.com" -DomainJoinCredential $DomainJoinCredential
Example format for a Run As account:
$DomainJoinCredential = Get-SCRunAsAccount -Name "RunAsAcct01" -Domain "ThisDomain.Corp.Contoso.com" -DomainJoinCredential $DomainJoinCredential
NOTE: You can use the DomainJoinCredential parameter to specify credentials on a VMHostProfile for joining a physical host computer to the domain, or to specify credentials on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine for joining a virtual machine to the domain.
Aliases |
JoinDomainCredential |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DomainJoinOrganizationalUnit<String>
Specifies the organizational unit to which the computer is joined during an unattended mini-setup.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DRProtectionRequired<Boolean>
This parameter is reserved for future use.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DynamicMemoryBufferPercentage<Int32]>
Specifies the percentage of memory above a virtual machine current memory allocation which the host should try to reserve as a buffer. The default value is 20.
Example format: -DynamicMemoryBufferPercentage 20
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DynamicMemoryEnabled<Boolean]>
Indicates whether to enable dynamic memory for virtual machines. You can enable dynamic memory directly on a virtual machine, or on a template or hardware profile that you use to create virtual machines. The default value is $False.
REQUIRED: You can enable dynamic memory for a virtual machine only if that virtual machine is deployed on a host running Windows Server 2008 SP1 or later or if the virtual machine is stored in a library in a stopped state. Hardware changes to a stored virtual machine can only be made if the virtual machine does not have snapshots. Enabling dynamic memory on a virtual machine stored in a library will limit placement of that machine to hosts running Windows Server 2008 SP1 or later.
Example format: -DynamicMemoryEnabled $True
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DynamicMemoryMaximumMB<Int32]>
Specifies the maximum amount of memory that can be allocated to a virtual machine if dynamic memory is enabled. The default value is 65536.
REQUIRED: You can enable dynamic memory for a virtual machine only if that virtual machine is deployed on a host running Windows Server 2008 R2 SP1 or later or if the virtual machine is stored in a library in a stopped state. Hardware changes to a stored virtual machine can only be made if the virtual machine does not have snapshots. Enabling dynamic memory on a virtual machine stored in a library will limit placement of that machine to hosts running Windows Server 2008 R2 SP1 or later.
Example format: -DynamicMemoryMaximumMB 1024
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DynamicMemoryMinimumMB<Int32]>
Specifies the minimum amount of memory that can be allocated to a virtual machine if dynamic memory is enabled. The default value is 65536.
REQUIRED: You can enable dynamic memory for a virtual machine only if that virtual machine is deployed on a host running Windows Server 2008 R2 SP1 or later or if the virtual machine is stored in a library in a stopped state. Hardware changes to a stored virtual machine can only be made if the virtual machine does not have snapshots. Enabling dynamic memory on a virtual machine stored in a library will limit placement of that machine to hosts running Windows Server 2008 R2 SP1 or later.
Example format: -DynamicMemoryMinimumMB 1024
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FullName<String>
Specifies the name of the person in whose name a virtual machine is registered.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Generation<Int32>
Indicates the generation of virtual machine that is created.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GuestOSProfile<GuestOSProfile>
Specifies a guest operating system profile object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-GuiRunOnceCommands<String[]>
Specifies one or more commands to add to the [GuiRunOnce] section of an unattended answer file such as Unattend.xml. Use single quotes around each string enclosed in double quotes.
Example format:
-GuiRunOnceCommands '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"', '"C:\APF\APFPostSysPrepCopy.cmd PARAMS1"'
For information about how Windows PowerShell uses quotes, type Get-Help about_Quoting_Rules.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HardwareProfile<HardwareProfile>
Specifies a hardware profile object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HAVMPriority<UInt32]>
Specifies the virtual machine priority. Virtual machines are started in priority order up to the limits of a host cluster node. Valid input for this parameter is a numerical representation of the priority:
3000 = High
2000 = Medium
1000 = Low
0 - Virtual machine does not restart automatically.
Example format: -HAVMPriority 2000
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-HighlyAvailable<Boolean>
Indicates whether a virtual machine is placed on a Hyper-V host that is part of a host cluster. Configure this setting on a virtual machine, or on a template or hardware profile that you use to create virtual machines.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobGroup<Guid]>
Specifies an identifier for a series of commands that will run as a set just before the final command that includes the same job group identifier runs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LibraryServer<LibraryServer>
Specifies a VMM library server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LinuxAdministratorSSHKey<SSHKey>
Specifies the public key file for a Linux SSH Key.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LinuxAdministratorSSHKeyString<String>
Specifies, as a string, a Linux administrator SSH key.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LinuxDomainName<String>
Specifies a fully qualified domain name (FQDN) to be used in conjunction with Linux operating system specialization.
Example format: -LinuxDomainName "Domain01.Corp.Contoso.com"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LocalAdministratorCredential<VMMCredential>
Specifies the user name and password for the Local Administrator account (or Linux root account in the case of a Linux-compatible Guest Operating System profile).
Specifying credentials on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine overrides any existing Administrator password.
Aliases |
AdminPasswordCredential |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MemoryMB<Int32]>
Specifies, in megabytes (MB), the amount of random access memory (RAM) on the host that is allocated to a virtual machine. The default value is 512 MB. For a virtual machine on which dynamic memory is enabled on a host running Windows Server 2008 R2 SP1 or later, use MemoryMB to specify the startup memory value. The maximum host memory assignable to a virtual machine is:
-- Hyper-V: Up to 65536 MB RAM per virtual machine.
-- VMware ESX Server 3.0.x: Up to 16384 MB RAM per virtual machine.
-- VMware ESX Server 3.5.x: Up to 65532 MB RAM per virtual machine.
-- Citrix XenServer: Up to 32265 MB RAM per virtual machine.
Example format: -MemoryMB 1024
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MemoryPerVirtualNumaNodeMaximumMB<Int32]>
Specifies the maximum amount of memory, in MB, that each virtual NUMA node is allowed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MemoryWeight<Int32]>
Indicates the priority in allocating memory to a virtual machine, relative to other virtual machines on the same host. A virtual machine with a higher setting is allocated more memory resources than a virtual machine with a lower setting. For a host running Windows Server 2008 R2 SP1 or later:
5000 = Normal
10000 = High
0 = Low
1 to 10000 = Custom
NOTE: See the examples for a specific cmdlet to determine how that cmdlet uses this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MergeAnswerFile<Boolean>
Indicates whether this cmdlet merges the specified answer file with the specified guest operating system settings. The default value is $True. This parameter is used by the VMM console. You do not need to use this parameter at the command prompt.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MonitorMaximumCount<Int32]>
Specifies the maximum number of monitors supported by a virtual video adapter.
Example format: -MonitorMaximumCount 3
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-MonitorMaximumResolution<String>
Specifies, as a string, the value that represents the maximum possible monitor resolution of a virtual video adapter. Valid values are:
-- 1024x768
-- 1280x1024
-- 1600x1200
-- 1920x1200
The default value is 1280x1024.
Example format: -MonitorMaximumResolution "1600x1200"
Aliases |
MonitorResolutionMaximum |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-NoCustomization
Indicates that guest operating system settings on this template cannot be customized.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NumaIsolationRequired<Boolean]>
Indicates whether NUMA isolation is required.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OperatingSystem<OperatingSystem>
Specifies the type of operating system for a virtual machine. To list the names of all available operating systems in VMM, type Get-SCOperatingSystem.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OrganizationName<String>
Specifies the name of the organization for the person in whose name a virtual machine is registered.
Aliases |
OrgName |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Owner<String>
Specifies the owner of a VMM object in the form of a valid domain user account.
Example format: -Owner "Contoso\ReneeLo"
Example format: -Owner "ReneeLo@Contoso"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProductKey<String>
Specifies a product key. The product key is a 25-digit number that identifies the product license. A product key can be used to register VMM or an operating system to be installed on a virtual machine or host.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProtectionProvider<Nullable [Microsoft.VirtualManager.Utils.ProtectionProvider]>
-- Sysprep.inf. Windows XP, Windows Server 2000, or Windows Server 2003.
-- Unattend.xml. Windows Vista, Windows 7, or Windows Server 2008.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RecoveryPointObjective<Int32]>
Specifies the maximum period for which it is tolerable to lose data from an IT service due to a major incident.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveDomainJoinOrganizationalUnit
Indicates that this cmdlet removes the organizational unit that the computer joined during setup.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveServerFeatures
Indicates that this cmdlet removes all server roles and features from a template.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReplicationGroup<Microsoft.SystemCenter.VirtualMachineManager.ReplicationGroup>
-- Sysprep.inf. Windows XP, Windows Server 2000, or Windows Server 2003.
-- Unattend.xml. Windows Vista, Windows 7, or Windows Server 2008.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SharePath<String>
Specifies a path to a valid library share on an existing library server that uses a Universal Naming Convention (UNC) path.
Example format: -SharePath "\\LibServer01\LibShare"
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SkipRearm
Indicates that this cmdlet skips running the Windows Software Licensing Rearm program. This program restores the Windows operating system to its original, out-of-box licensing state.
IMPORTANT: Refer to your licensing agreements with regard to activation and the Rearm program. Using this parameter might violate your licensing agreements.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SQLProfile<SQLProfile>
Specifies a SQL Server profile object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TimeZone<Int32]>
Specifies a number (an index) that identifies a geographical region that shares the same standard time. For a list of time zone indexes, see Microsoft Time Zone Index Values (https://go.microsoft.com/fwlink/?LinkId=120935) on the Microsoft Developer Network. If no time zone is specified, the default time zone used for a virtual machine is the same time zone setting that is on the virtual machine host.
Example format to specify the GMT Standard Time zone: -TimeZone 085
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UnattendSettings<Dictionary`2>
Specifies a key/value pair consisting of string, string.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UserRole<UserRole>
Specifies a user role object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualHardDisk<StandaloneVirtualHardDisk>
Specifies a virtual hard disk object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VirtualNumaNodesPerSocketMaximum<Byte]>
Specifies the maximum number of NUMA nodes allowed for each socket.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualVideoAdapterEnabled<Boolean]>
Indicates whether to enable the Microsoft Synthetic 3D Virtual Video Adapter for virtual machines. You can enable the Virtual Video Adapter directly on a virtual machine, or on a template or hardware profile that will be used to create virtual machines.
REQUIRED: You can enable the Microsoft Synthetic 3D Virtual Video Adapter for a virtual machine only if that virtual machine is deployed on a host running Windows Server 2008 R2 SP1 (with the Remote Desktop Services role and Remote Desktop Virtual Graphics role service installed) or later or if the virtual machine is stored in a library in a stopped state (hardware changes to a stored virtual machine can only be made if the virtual machine does not have snapshots). Enabling the Microsoft Synthetic 3D Virtual Video Adapter on a virtual machine stored in a library will limit placement of that machine to hosts running Windows Server 2008 R2 SP1 (with the Remote Desktop Services role and Remote Desktop Virtual Graphics role service installed) or later.
Example format: -VirtualVideoAdapterEnabled $True
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VM>
Specifies a virtual machine object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMTemplate<Template>
Specifies a VMM template object used to create virtual machines.
Aliases |
Template |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Workgroup<String>
Specifies on a new or existing template, on a new or existing guest operating system profile, or on a new virtual machine the name of the workgroup to which you want to join a virtual machine. You can use this parameter to override the existing value on a template or on a guest operating system profile.
Aliases |
JoinWorkgroup |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Template
Examples
Example 1: Create a virtual machine template from a virtual hard disk
The first command gets the specified operating system object, and then stores the object in the $OS variable.
The second command gets the virtual hard disk object named VHD01 from the Windows Server 2008 R2 library on LibServer01, and then 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.
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.
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
Example Example 2: Create a virtual machine template from an existing virtual machine.
The first command gets the library server object named LibServer01, and then stores the object in the $LibraryServer variable.
The second command gets the virtual machine object named VM01 deployed on VMHost02, and then stores the object in the $VM variable.
Note: VM01, which is the virtual machine that will be converted to a template, is 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, and then 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.
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
Example 3: Create a virtual machine template from a virtual hard disk with specified characteristics
The first command generates a GUID, and then 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 then 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 connects 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 GUID, and then stores it in the $JobGroupID02 variable. This job group ID is 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 then 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 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 then stores the object in the $HWProfile variable.
The eleventh command gets the specified operating system object, and then 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.
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
Example Example 4: Create a virtual machine template with the DRProtectionRequired parameter set to $True.
The first command gets the operating system named Windows Server 2012, and then stores it in the $OS variable.
The second command gets the virtual hard disk object named VHDX01 from the VMM library, and then 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.
PS C:\> $OS = Get-SCOperatingSystem -VMMServer "VMMServer01.Contoso.com" | where {$_.Name -eq "Windows Server 2012"}
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
Example 5: Create a customizable Linux virtual machine template from a virtual hard disk
The first command gets the specified operating system object, and then 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 then 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.
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
Related topics
New-SCP2V