5.11.37 Migrate virtual server
Function
This plugin migrates the specified virtual server in a VMware vSphere environment.
In the window showing virtual servers and templates for vSphere Client, this plugin changes the display position of a virtual server to the specified folder.
To move a virtual server, specify the destination for the virtual server (VMware.destinationName property).
For the destination, you can specify VMware vSphere ESXi (or VMware ESX Server), a resource pool, or a cluster.
To move the virtual server in the window showing virtual machines and templates for vSphere Client, specify the folder name as the destination.
To move the data store that contains a virtual server, specify the destination data store for the virtual server (VMware.destinationDataStoreName property).
You need to specify the data store name as the destination.
This plugin requires the following servers:
- vCenter server
The server on which VMware vCenter Server is installed
- ESX server
The server on which VMware vSphere ESXi (or VMware ESX Server) is installed
- vCenter control server (execution target server)
The server on which VMware vSphere PowerCLI v server is installed. The plugin is transferred to and executed on this server by JP1/AO.
- Virtual server
A virtual server managed by vCenter server and VMware vSphere ESXi (or VMware ESX Server)
The following describes the notes on setting properties.
- When the ESX server version is 5.0 or earlier
If you specify the name of a running virtual server in the VMware.vmName property, you cannot specify the virtual server destination (VMware.destinationName property) and the virtual-server destination data store (VMware.destinationDataStoreName property) at the same time.
Use situation
- You can use this plugin to migrate a virtual server during maintenance (such as when increasing physical machine memory or replacing CPUs). You can also use the plugin if the performance of a specific VMware vSphere ESXi (or VMware ESX Server) becomes insufficient due to a heavy load.
- If you need to relocate virtual servers after adding a virtual server or after changing the data store capacity, you can use this plugin to migrate the data store containing the virtual servers to another data store.
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 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) 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) is managed by VMware vCenter Server.
(2) Conditions relating to virtual servers
- The virtual servers being managed by a vCenter instance must have unique names.
- VMwareTools must be installed on a virtual server.
- The data stores being managed by a vCenter instance must have unique names.
(3) Conditions relating to VMware vSphere ESX settings
- When the VMware vSphere ESX version is 5.0 or earlier
To migrate a virtual server, the environment for the target virtual server must satisfy the prerequisites for vMotion.
To move a data store that contains a virtual server, the environment for the target virtual server must satisfy the prerequisites for Storage vMotion.
- When the VMware vSphere ESX version is 5.1 or later
To migrate a virtual server, the environment for the target virtual server must satisfy the prerequisites for vMotion or Cross-Host Storage vMotion.
To move a data store that contains a virtual server, the environment for the target virtual server must satisfy the prerequisites for Storage vMotion or Cross-Host Storage vMotion.
[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) Do not specify a string containing a double-quotation mark (") or single quotation mark (') for a property of this plugin.
(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) Virtual server names, cluster names, vApp names, resource pool names, and data store names must be unique in vCenter Server.
The same name cannot be assigned even for different types of items, such as the combination of a cluster and a vApp, or a cluster and a resource pool.
(5) 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.
(6) To specify a folder as the migration destination for the virtual server, the destination folder must exist in the window showing virtual servers and templates for vSphere Client.
(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 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.
(8) Specify either or both the virtual server destination (VMware.destinationName property) or virtual-server destination data store (VMware.destinationDataStoreName property). If neither is specified, this plugin ends abnormally.
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
02.11.00
Plug-in tags
Migrate VM,VMware vSphere
Plug-in name displayed in the task log
vsphereMigration
Return code
0: Normal
12: Error (Mistake by user) Invalid property
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 |
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.destinationName |
Virtual server destination |
Specify the name of the destination VMware vSphere ESXi (or VMware ESX Server), resource pool, cluster, or folder. |
-- |
Input |
O |
|
VMware.destinationDataStoreName |
Name of the virtual server's new location (datastore) |
Specifies the name of the datastore to which the virtual server is to be moved. |
-- |
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 |