Set-VMProcessor

Set-VMProcessor

Configures one or more processors of a virtual machine.

Syntax

Parameter Set: VMName
Set-VMProcessor [-VMName] <String[]> [-CompatibilityForMigrationEnabled <Boolean> ] [-CompatibilityForOlderOperatingSystemsEnabled <Boolean> ] [-ComputerName <String[]> ] [-Count <Int64> ] [-Maximum <Int64> ] [-MaximumCountPerNumaNode <Int32> ] [-MaximumCountPerNumaSocket <Int32> ] [-Passthru] [-RelativeWeight <Int32> ] [-Reserve <Int64> ] [-ResourcePoolName <String> ] [ <CommonParameters>]

Parameter Set: VMObject
Set-VMProcessor [-VM] <VirtualMachine[]> [-CompatibilityForMigrationEnabled <Boolean> ] [-CompatibilityForOlderOperatingSystemsEnabled <Boolean> ] [-Count <Int64> ] [-Maximum <Int64> ] [-MaximumCountPerNumaNode <Int32> ] [-MaximumCountPerNumaSocket <Int32> ] [-Passthru] [-RelativeWeight <Int32> ] [-Reserve <Int64> ] [-ResourcePoolName <String> ] [ <CommonParameters>]

Parameter Set: VMProcessor
Set-VMProcessor [-VMProcessor] <VMProcessor[]> [-CompatibilityForMigrationEnabled <Boolean> ] [-CompatibilityForOlderOperatingSystemsEnabled <Boolean> ] [-Count <Int64> ] [-Maximum <Int64> ] [-MaximumCountPerNumaNode <Int32> ] [-MaximumCountPerNumaSocket <Int32> ] [-Passthru] [-RelativeWeight <Int32> ] [-Reserve <Int64> ] [-ResourcePoolName <String> ] [ <CommonParameters>]

Detailed Description

The Set-VMProcessor cmdlet configures one or more processors of a virtual machine.

Parameters

-ComputerName<String[]>

Specifies one or more Hyper-V hosts on which processors are to be configured. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.

Aliases	none
Required?	false
Position?	named
Default Value	.
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Count<Int64>

Specifies the number of processors for the virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Maximum<Int64>

Specifies the maximum percentage of resources available to the virtual machine processor to be configured. Allowed values range from 0 to 100.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaximumCountPerNumaNode<Int32>

Specifies the maximum number of processors per NUMA node to be configured for the virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MaximumCountPerNumaSocket<Int32>

Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Passthru

Specifies that a Microsoft.Virtualization.Powershell.Processor is to be passed through to the pipeline representing the processor to be configured.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-RelativeWeight<Int32>

Specifies the priority for allocating the physical machine’s processing power to this virtual machine relative to others. Allowed values range from 1 to 10000.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Reserve<Int64>

Specifies the percentage of processor resources to be reserved for this virtual machine. Allowed values range from 0 to 100.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ResourcePoolName<String>

Specifies the name of the processor resource pool to be used.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VM<VirtualMachine[]>

Specifies the virtual machine on which the processor is to be configured.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-VMName<String[]>

Specifies the name of the virtual machine on which the processor is to be configured.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	true

-VMProcessor<VMProcessor[]>

Specifies the virtual machine processor to be configured.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-CompatibilityForMigrationEnabled<Boolean>

Specifies whether the virtual processor’s features are to be limited for compatibility when migrating the virtual machine to another host.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CompatibilityForOlderOperatingSystemsEnabled<Boolean>

Specifies whether the virtual processor’s features are to be limited for compatibility with older operating systems.

Aliases	none
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.

• None by default; Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting if –PassThru is specified.

Examples

Example 1

Configures virtual machine TestVM with two virtual processors, a reserve of 10%, a limit of 75%, and a relative weight of 200.

PS C:\> Set-VMProcessor TestVM -Count 2 -Reserve 10 -Maximum 75 -RelativeWeight 200

Example 2

Configures virtual machine TestVM, enabling processor compatibility for live migration.

PS C:\> Set-VMProcessor TestVM -CompatibilityForMigrationEnabled $true

Example 3

Configures virtual machine TestVM, enabling compatibility for running older operating systems.

PS C:\> Set-VMProcessor TestVM –CompatibilityForOlderOperatingSystemsEnabled $true