5.5.5 Change Memory Settings of Virtual Server
Function
This plug-in can be used to change the memory 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 memory settings:
- Startup RAM (MB)
- Whether to enable dynamic memory
- Minimum RAM for dynamic memory (MB)
- Maximum RAM for dynamic memory (MB)
- Buffer for dynamic memory
- Memory weight
- Maximum size of the memory available on a NUMA node (MB)
Use situation
This plug-in can be used to change the memory 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 memory settings that can be changed differ depending on the status of the virtual server.
(2) If all memory 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
hyperv2012ChangeVMMemory
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.memoryStartupMegaBytes |
Startup RAM (MB) |
Specify the amount of memory to use, in units of MB, when starting the virtual server. |
-- |
Input |
O |
|
hyperv.dynamicMemoryEnabled |
Enable Dynamic Memory |
Specify "true" to enable or "false" to disable dynamic memory of the virtual server. When a value is not entered, settings for enabling dynamic memory will not be changed. |
-- |
Input |
O |
|
hyperv.dynamicMemoryMinimumMegaBytes |
Minimum RAM (MB) of Dynamic Memory |
Specify the minimum amount of memory, in units of MB, for the dynamic memory. Only specify this when dynamic memory is enabled. |
-- |
Input |
O |
|
hyperv.dynamicMemoryMaximumMegaBytes |
Maximum RAM (MB) of Dynamic Memory |
Specify the maximum amount of memory, in units of MB, for the dynamic memory. Only specify this when dynamic memory is enabled. |
-- |
Input |
O |
|
hyperv.dynamicMemoryBuffer |
Memory Buffer of Dynamic Memory |
Specify the ratio of the memory to be reserved as the buffer with Hyper-V. Only specify this when dynamic memory is enabled. |
-- |
Input |
O |
|
hyperv.memoryPriority |
Priority of Memory |
Specify the priority when assigning usable memory between virtual machines. |
-- |
Input |
O |
|
hyperv.memoryMaximumAmountMegaBytesPerNumaNode |
Maximum Amount (MB) of Memory used with NUMA Node |
Specify the maximum amount of memory that can be used with 1 virtual NUMA (Non-Uniform Memory Architecture) node in units of MB. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |