5.11.41 Pre-evaluation of resource changes in virtual server
Function
Pre-checks the resource (number of CPUs and memory capacity) settings for the virtual server that is managed by VMware vCenter Server.
In VMware vCenter Server 4.1 and earlier versions, the number of CPUs refers to the number of virtual processors. In VMware vCenter Server 5.0 and later versions, the number of CPUs refers to the product of the number of virtual sockets and the number of cores per socket. In version 11-11 and earlier, the number of cores per socket is always 1, so the number of CPUs is equal to the number of virtual sockets. However, starting from version 11-12, the number of cores per socket can be changed.
Note that, as a result of the above, the display name of the VMware.cpuNum property has been changed. In version 11-11 and earlier, the display name was "Number of CPUs". In version 11-12 and later, the display name is "Number of CPU sockets".
This component requires the following servers:
- 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 (or VMware ESX Server).
Use situation
Decide the following based on the property specified in the service template:
- Whether to change the CPU, memory, or disk configuration
Prerequisites
For the latest support information about [Required product in the System]/[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
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 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 7.0, 6.7, 6.5, 6.0, 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 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
• Windows Server 2016 Standard/Datacenter
• Windows Server 2019 Standard/Datacenter
• Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
• Red Hat Enterprise Linux Server 7 (64-bit x86_64)
• Red Hat Enterprise Linux Server 8 (64-bit x86_64)
• CentOS 6 (64-bit x86_64)
• CentOS 7 (64-bit x86_64)
• CentOS 8 (64-bit x86_64)
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi (or VMware ESX Server) 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 is stopped.
- VMware Tools must be installed to the virtual server.
[Required products on the execution target server]
• VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0
• VMware PowerCLI 6.5 Release1
• VMware PowerCLI 6.5.1, 6.5.4
• VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
[Prerequisite product OS running in the execution target server]
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
• Windows Server 2016 Standard/Datacenter
• Windows Server 2019 Standard/Datacenter
Cautions
(1) Specify the same version for this plug-in and for the plug-in for setting virtual server resources.
Execution privilege
(1) The following privilege is required for users connected to VMware vCenter Server.
System administrator role
Version
03.00.01
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereCheckResource
Return code
0: Normal
12: Error (Mistake by user) Invalid property
23: Error (Environmental error) Required environment is invalid
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.cpuNum |
Number of CPU sockets |
Specify the number of CPU virtual sockets to assign to the virtual server. You must specify either CPU sockets or memory size property. The product of the number of CPU sockets and the number of cores per socket is the number of CPUs on a virtual server. |
-- |
Input |
O |
VMware.setCoresOption |
Option for setting the number of cores |
When you set the number of cores per CPU sockets in a virtual server, specify "true". Unless you specify "true", the number of cores is not set. For details, see the notes in the detailed information of the service for modifying the virtual machine configuration (CPUs and memory). |
false |
Input |
O |
VMware.numCoresPerSocket |
Number of cores per socket |
Specify the number of cores per CPU sockets to assign to the virtual server, if you specify "true" for the Option for setting the number of cores property. If you specify this property, you must also specify the number of CPU sockets. The product of the number of CPU sockets and the number of cores per socket is the number of CPUs on a virtual server. |
-- |
Input |
O |
VMware.memoryMB |
Memory size |
Specify the amount of memory (in MB) to assign to the virtual server. You must specify either CPU sockets 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 |
VMware.checkResourceResult |
Pre-evaluation results for resource changes for the virtual server |
Determine whether it is necessary to change the resources for the virtual server. Store TRUE if they will be changed, or store FALSE if they will not be changed. |
-- |
Output |
O |