3.16.12 Pre-check for OS Deployment on Virtual Machine

Function

Checks the environment prerequisites for the virtual server addition service (deployment and OS initialization).

This service template assumes the following servers:

· vCenter server

This is a server on which VMware vCenter Server is installed.

· vCenter control server

This is a server on which VMware vSphere PowerCLI is installed.

· Virtual server

This is a virtual server managed by the vCenter server and VMware vSphere ESX.

The following provides an overview of the processing.

(1) Checks whether connection can be established from the vCenter control server to a vCenter server.

(2) Checks whether a virtual server can be created from the specified template.

This service checks the following items:

· Whether the specified template has been registered into the vCenter server

If the template is not registered in the vCenter server, the result is false.

· Whether the specified ESX server has been registered into the vCenter server

If the ESX server is not registered in the vCenter server, the result is false.

· Whether the specified data store has been registered into the ESX server.

If the data store is not registered in the ESX server, the result is false.

· Whether the data store on the specified ESX server has enough free space to expand the template.

If the template capacity is greater than the free space on the data store, the result is false.

The template capacity used for this comparison is the capacity of provisioned storage of the virtual disk specified in the template.

· Whether the specified resource pool (resource pool, cluster, vApp) has been registered into the vCenter server.

If the resource pool is not registered in the vCenter server, the result is false.

· Whether the specified virtual server name is already in use in the vCenter server.

If the virtual server name is already in use in the vCenter server, the result is false.

(3) Sends an ICMP echo request to the specified IP address to determine whether there is a response.

If there is no response, the IP address is treated as being available (not in use).

If there is a response, the IP address is treated as being unavailable (already in use).

Prerequisites

For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.

[Required product for the system]

Job Management Partner 1/Automatic Operation 12-00 or later

[Required products for the service template execution system]

(1) Required product for the vCenter server

· VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, or 4.0

(2) VMware vSphere ESXi (or VMware ESX Server) that manages 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 or 4.0

(3) Required product for the vCenter control 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 system executing the service template]

(1)Prerequisite OS of the virtual server

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)

(2) Required OS for the vCenter control 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

[Usage conditions of prerequisite products in the system executing the service template]

(1) Conditions for the settings on VMware vSphere ESXi (or VMware ESX Server)

· A port group has been set up. For a port group that is to be set up for the 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 duplication of a cluster name and a vApp name or a duplication of a cluster name and a resource pool name.

· The VMware-related names listed below are case-sensitive in VMware, but they are not case-sensitive in vSphere Power CLI that is executed from this service. For this reason, this service cannot be used in an environment where names can be used that are the same except for case differences.

· Data store name

· Resource pool name

· vApp name

(2) Conditions for the template used for deployment:

· VMware Tools have been installed.

· The execution of remote commands is allowed as per the settings (administrative share for Windows, while SSH for Linux is enabled, respectively).

· NICs have been configured (up to two).

· The reception of and response to pings is allowed.

· When you convert a virtual server to a template, do so when the virtual server is stopped.

(3) Condition of the virtual server

· There is no duplication of the virtual server name under the management of an identical vCenter.

(4) Conditions of this product

· The authentication information of the virtual server to be deployed has been registered to the agentless connection destination definition in the "Management" tab in advance.

Cautions

(1) The specified port group must be able to communicate with the local server. If there are multiple NICs for the virtual server, set one of the NICs to a port group that can communicate with the local server.

(2) Do not specify for the IP address (for management) a value that is not valid as an IP address in the virtual server's OS. For example, network addresses, broadcast addresses, and special addresses such as 0.0.0.0 and 255.255.255.255 cannot be specified.

Execution privilege

(1)The user who will be connecting to VMware vCenter Server must have the following permissions:

System administrator role

(2) The user who will be connecting to vCenter operation server must have the following permissions:

Built-in Administrator

Version

03.00.00

Tags

Gather VM information,VMware vSphere

Property list

The following shows the list of the property groups set in the property:

Property group	Description	Initial display
Virtual system environment information	Specify the VMware vCenter Server information.	Y
Virtual environment information for checking	Specify the information for the virtual server to be checked.	Y
Run-time options	These are properties related to checking the virtual server. Modify as necessary.	N

The following shows the list of the properties to be displayed in the "Service Definition" window:

(Legend)

R: The property must be specified.

O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.

Property key	Property name	Description	I/O type	Shared	Required	Property group
vmware.targetHost	Host name of VMware vCenter control server	Specify the host name or IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address.	Input	Disabled	R	Virtual system environment information
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	Disabled	R	Virtual system environment information
vmware.userName	User name for VMware vCenter Server connection	Specify the user name to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information
vmware.password	Password for VMware vCenter Server connection	Specify the password to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information
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.	Input	Disabled	O	Virtual system environment information
vmware.protocol	Protocol for VMware vCenter Server connection	Specify the protocol to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information
common.icmpEchoTimeout	Timeout period for ICMP echo requests	Specifies the time, in milliseconds, to wait for a response to the ICMP echo request that was sent in order to make sure that IP address is free.	Input	Disabled	R	Run-time options

The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
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	Disabled	R	Virtual environment information for checking
vmware.templateName	Template name	Specify the name of the template on which the virtual server is to be based.	Input	Disabled	R	Virtual environment information for checking
vmware.vmHostName	ESX server name	Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server.	Input	Disabled	R	Virtual environment information for checking
vmware.dataStoreName	Datastore name	Specify the datastore name.	Input	Disabled	R	Virtual environment information for checking
vmware.resourcePoolName	Resource pool name	Specify the resource pool, vApp, or cluster where the virtual server will be provisioned.	Input	Disabled	O	Virtual environment information for checking
vmware.portGroupName	Port group name	Specify the name of the port group currently assigned to the virtual server.	Input	Disabled	O	Virtual environment information for checking
vmware.portGroupNameNew	Port group name (updated)	Specify a new port group name to assign to the virtual server.	Input	Disabled	O	Virtual environment information for checking
OS.ipAddressMan	IP address (management LAN)	Specify the IP address for the management LAN of the virtual server. You cannot specify an IPv6 address.	Input	Disabled	O	Virtual environment information for checking

The following shows the list of the properties to be displayed in the "Task Details" window only:

Property key	Property name	Description	I/O type	Shared
vmware.checkConnectResult	Result of checking vSphere connectivity	Stores the result of determining whether a connection to the VMware vCenter Server can be established.	Output	Disabled
vmware.checkTemplateResult	Result of checking creation of virtual server	Stores the result of determining whether or not a virtual server can be created.	Output	Disabled
os.checkICMPResult	Result of checking ICMP	Stores the result of determining whether or not the specified IP address is being used.	Output	Disabled

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

Property key	Characters that can be input
vmware.targetHost	A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.
vmware.vCenterServerName	A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.
vmware.userName	A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %.
vmware.password	A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %.
vmware.portNumber	Integer between 1 and 65535 can be entered.
vmware.protocol	Select one of the following values: http,https
common.icmpEchoTimeout	Integer between 1 and 214783647 can be entered.

The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Characters that can be input
vmware.vmName	A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, , and %.
vmware.templateName	A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, ', ", *, ?, [, ], `, %.
vmware.vmHostName	A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.
vmware.dataStoreName	A maximum of 42 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %.
vmware.resourcePoolName	A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` and %.
vmware.portGroupName	A maximum of 49 characters can be entered. Characters that can be used include alphanumeric characters, as well as " "(space), -, ., / and _.
vmware.portGroupNameNew	A maximum of 49 characters can be entered. Characters that can be used include alphanumeric characters, as well as " "(space), -, ., / and _.
OS.ipAddressMan	A maximum of 15 characters can be entered. Characters that can be used include alphanumeric characters, as well as . .

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
		Plug-in name	Description	Error recovery method
1	vsphereConnectChallenge	Check VMware vCenter Server connectivity	Determines whether a connection can be established to the vCenter server.	Eliminate the cause of the error, and then re-execute the service.
2	vsphereCheckTemplateSpec	Check virtual server creation	Determines whether a virtual server can be created from the specified template.	Eliminate the cause of the error, and then re-execute the service.
3	checkIPAddress	Flow Plug-in	Confirms that the IP address is not being used.	--
3-3		Compatible Plug-in	Checks whether there is an output character string.	Eliminate the cause of the error, and then re-execute the service.
3-4		Send ICMP echo request message (confirm no response)	Issues an ICMP echo request to the specified IP address. Confirms that there is no response.	Eliminate the cause of the error, and then re-execute the service.

To Page Top