Set-SCVirtualMachine

Reference

Module:: VirtualMachineManager

Changes properties of a virtual machine managed by VMM.

Syntax

Set-SCVirtualMachine
   [-VM] <VM>
   [-VMwareResourcePool <VmwResourcePool>]
   [-StartAction <VMStartAction>]
   [-StopAction <VMStopAction>]
   [-RemoveSelfServiceUserRole <Boolean>]
   [-EnableOperatingSystemShutdown <Boolean>]
   [-EnableTimeSync <Boolean>]
   [-EnableDataExchange <Boolean>]
   [-EnableHeartbeat <Boolean>]
   [-EnableBackup <Boolean>]
   [-InstallVirtualizationGuestServices <Boolean>]
   [-Owner <String>]
   [-OperatingSystem <OperatingSystem>]
   [-Enabled <Boolean>]
   [-HighlyAvailable <Boolean>]
   [-HAVMPriority <UInt32>]
   [-DRProtectionRequired <Boolean>]
   [-ReplicationGroup <ReplicationGroup>]
   [-SecureBootEnabled <Boolean>]
   [-NumLock <Boolean>]
   [-CPULimitFunctionality <Boolean>]
   [-CPULimitForMigration <Boolean>]
   [-VMShieldingData <KeyFile>]
   [-RunAsSystem]
   [-RunAsUserCredential <PSCredential>]
   [-DelayStartSeconds <Int32>]
   [-UseHardwareAssistedVirtualization <Boolean>]
   [-Cloud <Cloud>]
   [-CapabilityProfile <CapabilityProfile>]
   [-RemoveCapabilityProfile]
   [-RemoveFromCloud]
   [-ClusterNonPossibleOwner <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.Host]>]
   [-ClusterPreferredOwner <System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.Host]>]
   [-AvailabilitySetNames <System.Collections.Generic.List`1[System.String]>]
   [-UserRole <UserRole>]
   [-Name <String>]
   [-JobGroup <Guid>]
   [-QuotaPoint <UInt32>]
   [-CostCenter <String>]
   [-Tag <String>]
   [-Custom1 <String>]
   [-Custom2 <String>]
   [-Custom3 <String>]
   [-Custom4 <String>]
   [-Custom5 <String>]
   [-Custom6 <String>]
   [-Custom7 <String>]
   [-Custom8 <String>]
   [-Custom9 <String>]
   [-Custom10 <String>]
   [-BlockDynamicOptimization <Boolean>]
   [-ClearDRProtection]
   [-Description <String>]
   [-MemoryMB <Int32>]
   [-DynamicMemoryEnabled <Boolean>]
   [-DynamicMemoryMaximumMB <Int32>]
   [-DynamicMemoryBufferPercentage <Int32>]
   [-MemoryWeight <Int32>]
   [-VirtualVideoAdapterEnabled <Boolean>]
   [-MonitorMaximumCount <Int32>]
   [-MonitorMaximumResolution <String>]
   [-RecoveryPointObjective <Int32>]
   [-ProtectionProvider <ProtectionProvider>]
   [-BootOrder <BootDevice[]>]
   [-FirstBootDevice <String>]
   [-SecureBootTemplate <String>]
   [-CPUCount <Byte>]
   [-CPUType <ProcessorType>]
   [-CPUExpectedUtilizationPercent <Int32>]
   [-DiskIops <Int32>]
   [-NetworkUtilizationMbps <Int32>]
   [-CPURelativeWeight <Int32>]
   [-CPUReserve <Int32>]
   [-CPUMaximumPercent <Int32>]
   [-CPUPerVirtualNumaNodeMaximum <Byte>]
   [-MemoryPerVirtualNumaNodeMaximumMB <Int32>]
   [-VirtualNumaNodesPerSocketMaximum <Byte>]
   [-DynamicMemoryMinimumMB <Int32>]
   [-NumaIsolationRequired <Boolean>]
   [-AutomaticCriticalErrorAction <UInt16>]
   [-AutomaticCriticalErrorActionTimeout <Int32>]
   [-CheckpointType <CheckpointType>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [-OnBehalfOfUser <String>]
   [-OnBehalfOfUserRole <UserRole>]
   [<CommonParameters>]

Description

The Set-SCVirtualMachine cmdlet changes properties of a virtual machine managed by Virtual Machine Manager (VMM).

Properties that you can change include the following:

Associate a virtual machine to a cloud.
Name, owner, and description of a virtual machine.
BIOS boot order, if the virtual machine is deployed on a Hyper-V host.
Amount of resources on the host used by a virtual machine. These include the following:
Maximum amount of host CPU resources that a virtual machine can use.
Expected use of host CPU by a virtual machine.
Amount of host CPU resources used by one virtual machine relative to other virtual machines on the same host.
Amount of host memory that a virtual machine can use.
Amount of bandwidth on the host's network that a virtual machine can use.
Hardware settings for a virtual machine unrelated to host resources. These include the following:
Number of CPUs.
Type of CPU.
Number of disk input/output operations per second (IOPS).
Limiting CPU functionality, for an older operating system, such as Windows NT 4.0.
Cost center, tag, and custom settings that are used to filter virtual machines by criteria.
Settings that enable various optional capabilities, which include the following:
Enabling or disabling a library object to make it available, or temporarily unavailable, to users.
Enabling backing up a virtual machine on a Hyper-V host with Volume Shadow Copy service.
Enabling a key/value pair for data exchange between a virtual machine and its Hyper-V host.
Enabling shutdown of a virtual machine from the Hyper-V console.
Enabling time synchronization between a virtual machine and its Hyper-V host.
Enabling the BIOS value for NumLock for a virtual machine on a Hyper-V host.
Setting that identifies whether a virtual machine is highly available, that is, a virtual machine to be deployed on a node of a Hyper-V host cluster or a Citrix XenServer host cluster.
Setting that determines whether virtualization guest services are installed on a virtual machine deployed on a Hyper-V host.
Number of seconds to delay before starting a virtual machine.
Setting that identifies the operating system that is used for a virtual machine.
Start and stop actions for a virtual machine.
Setting that limits the number of virtual machines self-service users can create.
Setting used to switch the role that a self-service user who belongs to multiple roles uses to manage a virtual machine.
Setting that assigns a virtual machine on an ESX host to a VMware resource pool.

If you want to change the properties of a virtual floppy drive, virtual DVD drive, virtual network adapter, or virtual SCSI adapter associated with a specific virtual machine, use the Set-SCVirtualFloppyDrive, Set-SCVirtualDVDDrive, Set-SCVirtualNetworkAdapter, or Set-SCVirtualScsiAdapter cmdlet.

Examples

Example 1: Specify an amount of memory for an existing virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM01"
PS C:\> If($VM.Status -ne "PowerOff"){Stop-SCVirtualMachine -VM $VM}
PS C:\> Set-SCVirtualMachine -VM $VM -MemoryMB 1024

The first command gets the virtual machine object named VM01, and then stores that object in the $VM variable.

The second determines whether the virtual machine stored in $VM is in a powered off state. If the virtual machine is not in a powered off state, the command uses the Stop-SCVirtualMachine command to power off the virtual machine. For more information about powering off a virtual machine, type Get-Help Stop-SCVirtualMachine.

The last command changes the memory allocated to VM01 to 1024 MB.

Example 2: Change the user role used to manage a virtual machine for a user who belongs to multiple self-service user roles

PS C:\> $VM = Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" -Name "VM02"
PS C:\> $SSRole = Get-SCUserRole -Name "ContosoSelfServiceUsers"
PS C:\> Set-SCVirtualMachine -VM $VM -UserRole $SSRole

The first command gets the virtual machine object named VM02 from VMMServer01, and then stores that object in the $VM variable.

The second command gets the user role object named ContosoSelfServiceUsers, and then stores the object in the $SSRole variable.

The last command specifies that members of the self-service user role called SSUserRole3 are now granted the permission to manage the virtual machine called VM02.

Note: VMM uses the UserRole parameter to set which virtual machines are managed by the members of a specific self-service user role. Typically, you do not have to use the Set-SCVirtualMachine cmdlet with the UserRole parameter to configure this setting. However, if one or more users are members of multiple self-service user roles and you grant them permission to manage multiple virtual machines on the same host, you might encounter a case where you want to switch which user role is authorized to manage a particular virtual machine. This example illustrates that scenario.

Example 3: Disable time syncronization on a virtual machine used as a domain controller

PS C:\> $EAP = $ErrorActionPreference
PS C:\> $ErrorActionPreference = "STOP" 
PS C:\> $VM = Get-SCVirtualMachine -Name "VM03"
PS C:\> trap{"Fail: Cannot disable Time Synchronization for VM: $VM";continue} Set-SCVirtualMachine -VM $VM -EnableTimeSynchronization $TRUE | Out-Null
PS C:\> $ErrorActionPreference = $EAP

The first command stores the current setting for $ErrorActionPreference in variable $EAP. This variable is used later to return the setting to its original value.

The second command sets the action preference to STOP. This error action preference changes an error from a non-terminating error to a terminating error. The error object is raised as an exception instead of being written to the output pipe, and the command does not continue to run.

The third command gets the virtual machine object named VM03, and stores that object in the $VM variable.

The fourth command disables the time synchronization setting. Typically, disabling time synchronization is required for virtual machines that act as domain controllers. The command uses the trap statement to catch terminating exceptions. If the Set-SCVirtualMachine command fails, the string in the trap statement is displayed. Continue is used in the trap statement to continue running instead of exiting. The Out-Null cmdlet redirects the output to $Null instead of sending it to the console.

The last command sets the value for $ErrorActionPreference to the value stored in $EAP.

Example 4: Set the device start order for all virtual machines that support this feature

PS C:\> $EAP = $ErrorActionPreference
PS C:\> $ErrorActionPreference = "Stop" 
PS C:\> $VMs = @(Get-SCVirtualMachine)
PS C:\> ForEach($VM in $VMs){trap{"Fail: Cannot set BIOS for VM: $VM";continue} Set-SCVirtualMachine -VM $VM -BootOrder "PXEBoot","IDEHarddrive","CD","Floppy" | Out-Null}
PS C:\> $ErrorActionPreference = $EAP

The first command stores the current setting for $ErrorActionPreference in $EAP. This variable is used later to return the setting to its original value.

The second command sets the error action preference to Stop. This error action preference changes an error from a non-terminating error to a terminating error. The error object is raised as an exception instead of being written to the output pipe, and the command does not continue to run.

The third command gets each virtual machine object stores the objects in $VMs. Using the @ symbol and parentheses makes sure that that the command stores the results in an array in case the command returns a single object or a null value.

The fourth command sets the BIOS boot order for each virtual machine to PXEBoot,IDEHarddrive,CD,Floppy. The command uses a trap statement to catch terminating exceptions. If the Set-SCVirtualMachine command fails, the string in the trap statement is displayed. Continue is used in the trap statement to continue running instead of exiting the ForEach loop. The Out-Null cmdlet redirects the output to $Null instead of sending it to the console.

Note: The BootOrder parameter is used only for virtual machines on Hyper-V and Citrix XenServer hosts. It is not used for virtual machines on VMware ESX hosts. XenServer hosts do not support floppy disks, and therefore ignores Floppy if listed in the boot order.

The last command sets the value for $ErrorActionPreference to the value stored in EAP.

For more information about the standard Windows PowerShellForEach loop statement, type Get-Help about_ForEach.

Example 5: Specify an owner for all virtual machines without an owner

PS C:\> Get-SCVirtualMachine -VMMServer "VMMServer01.Contoso.com" | where {$_.Owner -eq ""} | Set-SCVirtualMachine -Owner "Contoso\ReneeLo"

This command gets all virtual machine objects on VMMServer01, selects only those virtual machine objects where no owner is listed, and specifies an owner for each virtual machine.

Example 6: Enable dynamic memory for an existing virtual machine

PS C:\> $VM = Get-SCVirtualMachine -Name "VM06"
PS C:\> if($VM.Status -ne "PowerOff"){Stop-SCVirtualMachine -VM $VM}
PS C:\> Set-SCVirtualMachine -VM $VM -DynamicMemoryEnabled $True -MemoryMB 1024 -DynamicMemoryMaximumMB 2048

The first command gets the virtual machine object VM06, and stores that object in the $VM variable. To enable dynamic memory on a virtual machine, the virtual machine must reside on a host that runs Windows Server 2008 R2 SP1 or a later version.

The second command determines whether the virtual machine stored in $VM is in a powered off state. If the virtual machine is not in a powered off state, the command uses the Stop-SCVirtualMachine command to power off the virtual machine.

The last command enables Dynamic Memory, sets the startup memory to 1024 MB, and sets the maximum memory to 2048 MB. The startup memory is the amount of memory on the host that is allocated to VM06 upon startup. The maximum memory is the maximum amount of memory on the host that is allocated to VM06.

Parameters

-AutomaticCriticalErrorAction

Specifies the action to take when the virtual machine encounters a critical error, and exceeds the timeout duration specified by the AutomaticCriticalErrorActionTimeout parameter. The acceptable values for this parameter are: Pause and None.

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

-AutomaticCriticalErrorActionTimeout

Specifies the amount of time, in minutes, to wait in critical pause before powering off the virtual machine.

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

-AvailabilitySetNames

Specifies a list of availability set names.

Type:	System.Collections.Generic.List`1[System.String]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BlockDynamicOptimization

Indicates whether dynamic optimization is blocked for a virtual machine.

Type:	Boolean
Aliases:	ExcludeFromPRO
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BootOrder

Specifies the order, as an array, of devices that a virtual machine on a Hyper-V host uses to start. Valid values are:

CD
IDEHardDrive
PXEBoot
Floppy

Type:	BootDevice[]
Accepted values:	Floppy, CD, IdeHardDrive, PxeBoot, Unknown
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CapabilityProfile

Specifies a capability profile object.

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

-CheckpointType

Specifies the checkpoint type. The acceptable values for this parameter are:

Disabled
Production
ProductionOnly
Standard

Type:	CheckpointType
Accepted values:	Disabled, Production, ProductionOnly, Standard
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClearDRProtection

Indicates that this cmdlet resets the data recovery protection option.

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

-Cloud

Specifies a private cloud object.

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

-ClusterNonPossibleOwner

Specifies a list of names of the non-possible cluster node owners for a specified virtual machine.

Type:	System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.Host]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterPreferredOwner

Specifies a list of names of the preferred cluster node owners for a particular virtual machine.

Type:	System.Collections.Generic.List`1[Microsoft.SystemCenter.VirtualMachineManager.Host]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CostCenter

Specifies the cost center for a virtual machine. You can collect data about the allocation of virtual machines or resources allocated to virtual machines for your billing system.

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

-CPUCount

Specifies the number of CPUs on the virtual machine. The following hosts support the following number of processors:

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 one CPU on a virtual machine that run Windows NT 4.0.
Citrix XenServer. Up to eight CPUs per virtual machine, depending on guest operating system.

Type:	Byte
Aliases:	ProcessorCount
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPUExpectedUtilizationPercent

Specifies the percentage of CPU on the host that you expect this virtual machine to use. This value is used only when VMM determines an appropriate host for the virtual machine.

Type:	Int32
Aliases:	ExpectedCPUUtilization
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPULimitForMigration

Indicates whether to limit processor features for the specified virtual machine in order to enable migration to a physical computer that has a different version of the same processor as the source computer. VMM does not support migrating virtual machines between physical computers that have processors from different manufacturers.

Type:	Boolean
Aliases:	LimitCPUForMigration
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPULimitFunctionality

Indicates whether to provide limited CPU functionality for the virtual machine. Specify a value of $True to support an older operating system, such as Windows NT 4.0, on a virtual machine deployed on a Hyper-V host or on a VMware ESX host.

Type:	Boolean
Aliases:	LimitCPUFunctionality
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPUMaximumPercent

Specifies the highest percentage of the total resources of a single CPU on the host that a virtual machine can use at the same time.

Type:	Int32
Aliases:	CPUMax
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPUPerVirtualNumaNodeMaximum

Specifies the maximum number of CPUs allowed for each virtual NUMA node.

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

-CPURelativeWeight

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 weight value is allocated more CPU resources than a virtual machine with a lower weight value. The VMware term for these values is shares. Types of hosts support the following relative values:

Hyper-V. 1 to 10000.
VMware ESX. High. 2000.
VMware ESX. Above Normal. 1500.
VMware ESX. Normal (default). 1000.
VMware ESX. Below Normal. 750.
VMware ESX. Low. 500.
VMware ESX. Custom 1 to 1000000.
Citrix XenServer. 1 to 65536, typical is 256.

Type:	Int32
Aliases:	RelativeWeight
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CPUReserve

Specifies the minimum percentage of the resources of a single CPU on the host to allocate to the virtual machine. The percentage of CPU capacity that is available to the virtual machine is never less than this percentage.

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

-CPUType

Specifies the type of CPU for a virtual machine. To get all CPU types that are available for use in virtual machines in a VMM environment, see the Get-SCCPUType cmdlet.

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