5.5.2 Change CPU Settings of Virtual Server
Function
This plug-in is used to change the CPU settings of virtual servers in a Hyper-V environment.
This plug-in requires the following servers:
- Hyper-V server (execution-target server)
A server on which Hyper-V is installed
- Virtual server
A virtual server managed by Hyper-V
This plug-in can be used to change the following CPU settings:
- Number of virtual processors
- Number of reserved virtual processor resources
- Maximum number of virtual processor resources
- Relative Weight setting for virtual processor resources
- Processor compatibility
- Maximum number of processors that can be used on a NUMA node
- Maximum number of NUMA nodes that can be used by a socket
Use situation
This plug-in can be used to change the CPU settings of a virtual server.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) Prerequisite products on the Hyper-V server
- Windows Server 2012 Hyper-V, Windows Server 2012 R2 Hyper-V
(2) Prerequisite OS for the virtual server
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
Environments where Server Core is installed are excluded.
OSs for the prerequisite products on the execution-target server:
- Windows Server 2012 Standard/Datacenter or Windows Server 2012 R2 Standard/Datacenter
Environments where Server Core is installed are excluded.
Condition for using the prerequisite products on the execution-target server:
(1) Each virtual server name must be unique within a single Hyper-V server.
Cautions
(1) The CPU settings that can be changed differ depending on the status of the virtual server.
(2) If all CPU settings are blank, an error occurs.
Version
02.00.00
Plug-in tags
Modify VM,Hyper-V 2012
Plug-in name displayed in the task log
hyperv2012ChangeVMCPU
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
hyperv.vmName |
Virtual server name |
Specifies the name of the virtual server. (This is the name of the virtual server as it is displayed in Hyper-V. This is not the host name in the OS.) |
-- |
Input |
R |
|
hyperv.cpuCount |
Number of Virtual Processors |
Specify the number of virtual processors used to configure the virtual server. |
-- |
Input |
O |
|
hyperv.cpuReserve |
Reservation of Virtual Processor Resources |
Specify the allocation of the virtual processor resources between virtual servers reserved by the virtual server. |
-- |
Input |
O |
|
hyperv.cpuMaximum |
Maximum for Virtual Processor Resources |
Specify the maximum value for the allocation of the virtual processor resources between virtual servers to be used by the virtual servers. |
-- |
Input |
O |
|
hyperv.cpuRelativeWeight |
Relative Weight of Virtual Processor Resources |
Specify the relative weight of the virtual processor resources between virtual servers. |
-- |
Input |
O |
|
hyperv.cpuCompatibilityForMigrationEnabled |
Compatibility of Processors |
Specify "true" to enable or "false" to disable compatibility of processors. When a value is not entered, settings for the compatibility of processors will not be changed. |
-- |
Input |
O |
|
hyperv.cpuMaximumCountPerNumaNode |
Maximum Number of Processors used with NUMA Node |
Specify the maximum number of processors that can be used with 1 virtual NUMA (Non-Uniform Memory Architecture) node. |
-- |
Input |
O |
|
hyperv.nodeMaximumCountPerNumaSocket |
Maximum Number of NUMA Nodes used in Socket |
Specify the maximum number of virtual NUMA (Non-Uniform Memory Architecture) nodes that can be used in 1 socket. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |