Set-VMProcessor
Configures one or more processors of a virtual machine.
Syntax
Set-VMProcessor
[-Count <Int64>]
[-CompatibilityForMigrationEnabled <Boolean>]
[-CompatibilityForOlderOperatingSystemsEnabled <Boolean>]
[-Maximum <Int64>]
[-Reserve <Int64>]
[-RelativeWeight <Int32>]
[-MaximumCountPerNumaNode <Int32>]
[-MaximumCountPerNumaSocket <Int32>]
[-ResourcePoolName <String>]
[-Passthru]
[-ComputerName <String[]>]
[-VMName] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-VMProcessor
[-VMProcessor] <VMProcessor[]>
[-Count <Int64>]
[-CompatibilityForMigrationEnabled <Boolean>]
[-CompatibilityForOlderOperatingSystemsEnabled <Boolean>]
[-Maximum <Int64>]
[-Reserve <Int64>]
[-RelativeWeight <Int32>]
[-MaximumCountPerNumaNode <Int32>]
[-MaximumCountPerNumaSocket <Int32>]
[-ResourcePoolName <String>]
[-Passthru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-VMProcessor
[-Count <Int64>]
[-CompatibilityForMigrationEnabled <Boolean>]
[-CompatibilityForOlderOperatingSystemsEnabled <Boolean>]
[-Maximum <Int64>]
[-Reserve <Int64>]
[-RelativeWeight <Int32>]
[-MaximumCountPerNumaNode <Int32>]
[-MaximumCountPerNumaSocket <Int32>]
[-ResourcePoolName <String>]
[-Passthru]
[-VM] <VirtualMachine[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
The Set-VMProcessor cmdlet configures one or more processors of a virtual machine.
Examples
Example 1
PS C:\>Set-VMProcessor TestVM -Count 2 -Reserve 10 -Maximum 75 -RelativeWeight 200Configures virtual machine TestVM with two virtual processors, a reserve of 10%, a limit of 75%, and a relative weight of 200.
Example 2
PS C:\>Set-VMProcessor TestVM -CompatibilityForMigrationEnabled $trueConfigures virtual machine TestVM, enabling processor compatibility for live migration.
Example 3
PS C:\>Set-VMProcessor TestVM -CompatibilityForOlderOperatingSystemsEnabled $trueConfigures virtual machine TestVM, enabling compatibility for running older operating systems.
Parameters
-CompatibilityForMigrationEnabled
Specifies whether the virtual processor's features are to be limited for compatibility when migrating the virtual machine to another host.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompatibilityForOlderOperatingSystemsEnabled
Specifies whether the virtual processor's features are to be limited for compatibility with older operating systems.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
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.
| Type: | String[] |
| Position: | Named |
| Default value: | . |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Count
Specifies the number of processors for the virtual machine.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Maximum
Specifies the maximum percentage of resources available to the virtual machine processor to be configured. Allowed values range from 0 to 100.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumCountPerNumaNode
Specifies the maximum number of processors per NUMA node to be configured for the virtual machine.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumCountPerNumaSocket
Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Passthru
Specifies that a Microsoft.HyperV.PowerShell.Processor is to be passed through to the pipeline representing the processor to be configured.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RelativeWeight
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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Reserve
Specifies the percentage of processor resources to be reserved for this virtual machine. Allowed values range from 0 to 100.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourcePoolName
Specifies the name of the processor resource pool to be used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VM
Specifies the virtual machine on which the processor is to be configured.
| Type: | VirtualMachine[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMName
Specifies the name of the virtual machine on which the processor is to be configured.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VMProcessor
Specifies the virtual machine processor to be configured.
| Type: | VMProcessor[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
None by default; Microsoft.HyperV.PowerShell.VMNetworkAdapterVlanSetting if -PassThru is specified.