5.9.6 Migrate virtual server
Function
Migrates a specified virtual server in a VMware vSphere environment.
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.
If the 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).
Use situation
You use this plugin to migrate a virtual server when you need to perform maintenance (such as to expand memory for a physical machine or to replace the CPU) or when the processing performance of a specific VMware vSphere ESX (or VMware ESX Server) has deteriorated due to high workload.
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-00 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.
• VMwareTools has been installed on the virtual servers.
(3) The environments of the target virtual servers satisfy the prerequisite conditions of vMotion.
[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) The same virtualization software product must be used at the source and the target.
(2) The virtualization software that runs the virtual servers must be running.
(3) 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 cluster name that duplicates a vApp name or a cluster name that duplicates a resource group name.
(4) If a cluster is specified as the virtual server's migration target, the virtual server to be migrated must exist in the resource pool under the specified target cluster.
(5) If a folder is specified as the virtual server's migration target, there must be at least one virtual server under the specified target folder.
(6) 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 plugin 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 VMware Knowledge Base.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with vMotion query and migration and relocation permissions for the target virtual server or system administrator role
Version
01.00.04
Category
VirtualMachine/vSphere
Plug-in name displayed in the task log
vsphereMigration
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 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.destinationName |
Virtual server destination |
Specify the name of the destination VMware vSphere ESXi (or VMware ESX Server), resource pool, cluster, or folder. |
-- |
Input |
R |
|
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 |