5.9.5 Set virtual server resources
Function
Changes a virtual server's resource allocation (number of CPUs and memory capacity) in a VMware vSphere environment.
In VMware vCenter Server 4.1 or earlier, the number of CPUs means the number of virtual processors; in VMware vCenter Server 5.0 or later, it means the number of virtual sockets.
This plugin assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed.The plugin is sent to this server by JP1/AO and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESX.
Use situation
You use this plugin to change the allocation of resources for a virtual server when there is a shortage of virtual server resources.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 10-50 or later
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server 5.5,5.1,5.0,4.1,4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages the virtual servers
• VMware vSphere ESXi 5.5,5.1,5.0 or VMware ESX Server 4.1,4.0
(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 (or VMware ESX Server)/vCenter control server that manages the virtual server.
• Windows Server 2003,Standard Edition/Enterprise Edition (x86/x64) SP1 or later,Windows Server 2003 R2,Standard Edition/Enterprise Edition (x86/x64)
• Windows Server 2008 Standard/Enterprise (x86/x64),Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter,Windows Server 2012 R2 Standard/Datacenter
• Red Hat Enterprise Linux 5 Advanced Platform (x86),Red Hat Enterprise Linux 5 (x86),Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64),Red Hat Enterprise Linux 5 (AMD/Intel 64)
• Red Hat Enterprise Linux Server 6 (32-bit x86),Red Hat Enterprise Linux Server 6 (64-bit x86_64)
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2)Conditions for virtual servers
• There is no duplication of the names of virtual servers under the management of the same vCenter.
• The virtual servers have been stopped.
• VMwareTools has been installed in the virtual servers.
[Required products on the execution target server]
• VMware vSphere PowerCLI 5.5 Release1, 5.1 Release2, 5.0
[Prerequisite product OS running in the execution target server]
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter
Cautions
(1) For VMware vCenter Server 5.0 or later, set to 1 the number of cores per socket on the target virtual server. If the number of CPUs is changed for a virtual server on which the number of cores per socket has been set to a value other than 1, the virtual server might not start.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
Version
01.12.00
Category
VirtualMachine/vSphere
Plug-in name displayed in the task log
vsphereChangeResource
Return code
0: Normal
12: Error (user error) Invalid property
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
VMware.vCenterServerName |
VMware vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
-- |
Input |
R |
|
VMware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
|
VMware.portNumber |
Port number for VMware vCenter Server connection |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
443 |
Input |
O |
|
VMware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
https |
Input |
R |
|
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
-- |
Input |
R |
|
VMware.cpuNum |
Number of CPUs |
Specify the number of CPUs to assign to the virtual server. Note that CPUs means virtual processors in same or earlier version than 4.1, and virtual sockets in version 5.0 of VMware vCenter Server. You must specify either CPUs or memory size property. |
-- |
Input |
O |
|
VMware.memoryMB |
Memory size (MB) |
Specify the amount of memory (in MB) to assign to the virtual server. You must specify either CPUs or memory size property. |
-- |
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 |