N-central Help

Set VM CPU Settings

Configures one or more processors of a virtual machine.

Input Parameters

Name Type Required Description
VM Name String Yes Specifies the name of the virtual machine on which the processor is to be configured.
Migration Compatibility Enabled Selector Yes Specifies whether the virtual processor’s features are to be limited for compatibility when migrating the virtual machine to another host.
Operating System Compatibility Enabled Selector Yes Specifies whether the virtual processor’s features are to be limited for compatibility with older operating systems.
CPU Count Number Yes Specifies the number of processors for the virtual machine.
CPU Maximum Number Yes Specifies the maximum percentage of resources available to the virtual machine processor to be configured. Allowed values range from 0 to 100.
Max CPU Count Per Numa Node Number Yes Specifies the maximum number of processors per NUMA node to be configured for the virtual machine.
Max Count Per Numa Socket Number Yes Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine.
Relative CPU Weight Number Yes 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.
Total CPU Reserved for VM Number Yes Specifies the percentage of processor resources to be reserved for this virtual machine. Allowed values range from 0 to 100.
Resource Pool Name String Yes Specifies the name of the processor resource pool to be used.

Output Parameters

Name Type Description
Result Number Returns a success value of zero or any value other than zero to indicate failure.

Example Input Parameters

Name Type Required Example
VM Name String Yes Guest001
Migration Compatibility Enabled Selector No Enabled
Operating System Compatibility Enabled Selector No Enabled
CPU Count Number No 2
CPU Maximum Number No 75
Max CPU Count Per Numa Node Number No 0
Max Count Per Numa Socket Number No 0
Relative CPU Weight Number No 200
Total CPU Reserved for VM Number No 10
Resource Pool Name String No Primordial