3.9.7 Migrate virtual server
Function
Migrates multiple virtual servers in a VMware vSphere environment.
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.
If a target virtual server's power is on, the plugin performs hot migration (migration with the power on); if the target virtual server's power is off, the plugin performs cold migration (migration with the power off).
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 10-50 or later
[Required products for the service template execution system]
(1) Required product for the vCenter server
• VMware vCenter Server 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 5.5, 5.1 or 5.0 or VMware ESX Server 4.1 or 4.0
(3) Required product for the vCenter control server
• VMware vSphere PowerCLI 5.5 Release1, 5.1 Release2, 5.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 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)(for vCenter4.1 or later; not supported by vCenter4.0)
• 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)
(2) Required OS for the vCenter control server
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter
[Usage conditions of prerequisite products in the system executing the service template]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2) Each virtual server name is unique among the vCenter servers.
(3) The firewall of the target virtual server is set to allow for responses to ICMP (ECHO).
(4) VMwareTools is installed on the target virtual server.
Cautions
(1) Note that when you move multiple virtual servers, the target VMware vSphere ESXi (or VMware ESX Server) might experience a high workload.
(2) The same virtualization software product must be used at the source and the target.
(3) The virtualization software that runs the virtual servers must be running.
(4) The virtual server name, cluster name, vApp name, and resource pool name must be unique within the vCenter Server.
The same name cannot be assigned to more than one virtual server, cluster, vApp, and resource pool 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 group name.
(5) If a cluster is specified as a virtual server's migration target, the virtual server to be migrated must exist in the resource pool under the specified target cluster.
(6) If a folder is specified as a virtual server's migration target, there must be at least one virtual server under the specified target folder.
(7) In an environment that uses a VMware vCenter Server version earlier than 4.1 U2, if an inactive virtual machine is migrated to an ESX in a different data center, an error might occur, in which case task execution will fail. For details about how to handle this, see Migrating a powered off virtual machine across hosts in different datacenters fails with the error: A specified parameter was not correct. host in the VMware Knowledge Base.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server needs the following permissions:
Role with vMotion query and migration and relocation permissions for the target virtual server, or system administrator role
Version
01.50.01
Category
VM_Operations/Management
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 server information |
Specify the information for the virtual server to be migrated. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" dialog box:
- (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 |
The following shows the list of the properties to be displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
---|---|---|---|---|---|---|
vmware.foreachVmName |
Virtual server name(s) |
Specify the virtual server name or names. Specify server names as they appear in VMware vCenter Server, not by host name. Separate multiple virtual servers with commas. The maximum number of virtual servers you can specify is 99. |
Input |
Disabled |
R |
Virtual server information |
vmware.destinationName |
Virtual server destination |
Specify the name of the destination VMware vSphere ESXi (or VMware ESX Server), resource pool, cluster, or folder. |
Input |
Disabled |
R |
Virtual server information |
The following shows the list of the properties to be displayed in the "Task Details" dialog box only:
Property key |
Property name |
Description |
I/O type |
Shared |
---|---|---|---|---|
common.taskResult |
Results of repeating tasks |
This property contains the results of each task (as "true" or "false"), in a comma-delimited format. |
Output |
Disabled |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" dialog box:
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 |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" dialog box and the "Submit Service" dialog box:
Property key |
Characters that can be input |
---|---|
vmware.foreachVmName |
A character string of no more than 1024 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` or %. |
vmware.destinationName |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` or %. |
Flow specification details
The following table shows the detailed specification of the flow:
Hierarchy |
Display name |
Plug-in |
|||
---|---|---|---|---|---|
Plug-in name |
Version |
Description |
Error recovery method |
||
1 |
migrateVM_vSphere |
Repeated Execution Plug-in |
01.00.00 |
Migrates multiple virtual servers to the specified destination. |
Eliminate the cause of the error, and then re-execute the service. |