5.5.38 Resource configuration setting of the virtual server
Function
Changes the CPU, memory, or disk I/O resource configurations for the virtual server that is managed by VMware vCenter Server.
The following servers are assumed to be used for this component:
- vCenter server
This is the server on which VMware vCenter Server is installed.
- vCenter control server (Execution target server)
This is the server on which VMware vSphere PowerCLI is installed. JP1/AO transfers the component to this server and executes it.
- Virtual server
This is the virtual server that is managed by the vCenter server and VMware vSphere ESXi.
Use situation
For resource allocation to the virtual server, you can use the following configurations:
- The CPU resource that is used by the virtual server can be limited or the limitation can be removed.
- The CPU resource that is used by the virtual server can be reserved (the amount used is reserved) or the reservation can be removed.
- For the CPU resources of the virtual servers that have the same parent, relative priority can be set between the servers.
- The memory resource that is used by the virtual server can be limited or the limitation can be removed.
- The memory resource that is used by the virtual server can be reserved (maintain the amount of use) or the reservation can be removed.
- For the memory resources of the virtual servers that have the same parent, relative priority can be set between the servers.
- For the disk I/O bands of the virtual servers that have the same parent, relative priority can be set between the servers.
Prerequisites
For the latest support information about [Required products on the execution target system]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server
(2) VMware vSphere ESXi that manages the virtual servers
(3) Prerequisite OS running in the virtual servers
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi/vCenter control server that manages the virtual server.
• Windows Server
• Red Hat Enterprise Linux Server
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi must be managed by VMware vCenter Server.
(2) Virtual server requirements
- Duplicate virtual server names must not be managed under the same vCenter.
- The virtual server must be stopped.
- VMware Tools must be installed to the virtual server.
[Required products on the execution target server]
• VMware PowerCLI
[Prerequisite product OS running in the execution target server]
• Windows Server
Cautions
(1) Consider the following when setting each property:
- For the reserved memory, set a value that is within the memory capacity allotted to the virtual server.
- For the CPU and the memory, less than 100 MHz and less than 100 MB, respectively, cannot be specified as the limit.
- Reservations cannot be made for the CPU or memory for an amount exceeding the limit.
- If VMware.vHardDiskName property is omitted, all virtual disks that are connected to virtual server are set to the specified shares level.
(2) When multiple virtual disks are specified for the VMware.vHardDiskName property, if the processing that changes the disk share level fails for one or more virtual disks, the task terminates abnormally.
Execution privilege
(1) The following privilege is required for users connected to VMware vCenter Server.
System administrator role
Version
02.11.00
Plug-in tags
Modify VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetResourceConfig
Return code
0: Normal
23: Error (Environmental error) Invalid pre-conditioned environment
27: Error (Check with the task log about the error detail)
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 |
---|---|---|---|---|---|
VMware.vCenterServerName |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. (This is the virtual server name in VMware vCenter Server. Do not specify a host name.) |
-- |
Input |
R |
VMware.cpuSharesLevel |
CPU share level |
Specifies the relative priority of CPU resources between virtual servers that have the same parent. |
-- |
Input |
O |
VMware.cpuReservationMHz |
CPU reservation (MHz) |
Specifies in MHz the CPU resources that are reserved by the virtual server. |
-- |
Input |
O |
VMware.cpuLimitMHz |
CPU limit (MHz) |
Specifies in MHz the upper limit value of CPU resources that are used by the virtual server. If a value less than 100 MHz is specified, execution of the task is abnormally terminated. However, specifying -1 removes this limit. |
-- |
Input |
O |
VMware.memSharesLevel |
Memory share level |
Specifies the relative priority of memory resources between virtual servers that have the same parent. |
-- |
Input |
O |
VMware.memReservationMB |
Memory reservation (MB) |
Specifies in MB the memory resources that are reserved by the virtual server. |
-- |
Input |
O |
VMware.memLimitMB |
Memory limit (MB) |
Specifies in MB the upper limit value of memory resources that are used by the virtual server. If a value less than 100 MB is specified, execution of the task is abnormally terminated. However, specifying -1 removes this limit. |
-- |
Input |
O |
VMware.diskSharesLevel |
Disk share level |
Specifies the relative priority of virtual servers for storage I/O resources. |
-- |
Input |
O |
VMware.vHardDiskName |
Virtual hard disk name |
Specifies virtual disk where shares level is changed. Virtual disk is display name in VMware vCenter Server. To specify multiple virtual disks, specify by separating with a comma. |
-- |
Input |
O |
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 |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |