5.11.47 Check virtual server creation
Function
This component makes sure that a new virtual server can be created in a VMware vSphere environment based on a specified template.
This module assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• ESX server
This is a server on which VMware vSphere ESXi (or VMware ESX Server) is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed. The module is transferred from JP1/AO to this server and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESXi.
This module checks the following:
• Makes sure that the specified ESX server is registered on the vCenter server.
If the ESX server is not registered on the vCenter server, the component returns an abnormal result.
• Makes sure that the specified data store is registered on the ESX server.
If the data store is not registered on the ESX server, the component returns an abnormal result.
• Makes sure that the data store on the specified ESX server has enough capacity to expand the template.
If the capacity of the template exceeds the capacity of the data store, the component returns an abnormal result.
The capacity of the template used for comparisons is the capacity of the Provisioned Storage of the virtual disk that is set in the template.
• Makes sure the specified resource pool (resource pool, cluster, vApp) is registered on the vCenter server.
If the resource pool is not registered on the vCenter server, the component returns an abnormal result.
• Makes sure that the specified virtual server name is not being used on the vCenter server.
If the virtual server name is already used in the vCenter server, the component returns an abnormal result.
Use situation
When you intend to create a new virtual server on an ESX server, this module enables you to first check whether a new virtual server can be created on the ESX server.
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 on the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-10 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) Prerequisite product of ESX Server
• 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)(For vCenter4.1 or later; not supported by vCenter4.0)
• 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 on the execution target server]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2) Conditions for the settings on VMware vSphere ESXi (or VMware ESX Server)
• A data store has been registered.
• A port group has been set up. For a port group that is to be set up for a virtual server, specify a port group on the network using a standard virtual switch (vNetwork or vSphere standard switch).
• The template used for deployment has already been created.
• If the virtual server is stored in a resource pool, the resource pool, cluster, and vApp names must be unique.
The same name cannot be assigned to more than one resource pool, cluster, and vApp although their types are different, such as a cluster name that duplicates a vApp name or a cluster name that duplicates a resource pool name.
(3) Conditions for the template used for deployment
• VMware Tools has already been installed.
• Remote commands are set to be executable. Administrative share is enabled in Windows; SSH is enabled in Linux.
• NIC has been set up (a maximum of two).
• In Windows, the Administrator's password is empty.
• If a virtual server is to be defined as a template, this must be done while the virtual server is stopped.
(4) Conditions for virtual servers
• There is no duplication of the names of virtual servers under the management of the same vCenter.
[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 on 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
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereCheckTemplateSpec
Return code
0: Normal
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in module) Missing property (error detected in module 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.vmHostName |
Host name of the ESX server |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
-- |
Input |
R |
|
VMware.dataStoreName |
Datastore name |
Specify the name of the data store. |
-- |
Input |
R |
|
VMware.templateName |
Virtual server's template name |
Specify the name of the template on which the virtual server is to be based. |
-- |
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.resourcePoolName |
Resource pool name |
Specify the resource pool, vApp, or cluster where the virtual server will be provisioned. |
-- |
Input |
O |
|
VMware.portGroupName |
Port group name |
Specify the name of the port group currently assigned to the virtual server. |
-- |
Input |
O |
|
VMware.portGroupNameNew |
Port group name (updated) |
Specify a new port group name to assign to the virtual server. |
-- |
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 |
|
common.CheckTemplateResult |
Virtual server creation check result |
Stores the result of determining whether the virtual server can be created. |
-- |
Output |
O |