5.5.4 Move the ESX server
Function
This plugin moves an ESX server to the specified data center, cluster, or folder in a VMware vSphere environment.
This plugin requires the following servers:
- vCenter server
A server on which VMware vCenter Server is installed
- ESX server
A server on which VMware vSphere ESXi is installed
- vCenter control server (execution target server)
A server on which VMware vSphere PowerCLI is installed. The plugin is transferred to and executed on this server by JP1/AO.
- Virtual server
A virtual server managed by the vCenter server and VMware vSphere ESXi
The following describes the destination for the ESX server (VMware.esxDestinationName property).
- For the destination, you can specify a data center, a cluster, or a folder.
Use situation
This plugin can be used to perform migration from cluster operation to standalone operation, or vise versa, during maintenance of the ESX server.
Prerequisites
See the Release Notes for the latest support statuses of prerequisite products for the execution-target system, prerequisite products on the execution-target server, and the supported OSs for the prerequisite products for the execution-target server.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
Prerequisite products for the execution-target system:
(1) Prerequisite product for the vCenter server
- VMware vCenter Server
(2) VMware vSphere ESXi to manage virtual servers
Conditions for using the prerequisite products for the execution-target system:
(1) VMware vSphere ESXi must be managed by VMware vCenter Server.
(2) Conditions for settings on VMware vCenter Server
- Data center names, cluster names, and folder names must be unique.
The same name cannot be assigned even for different types of items, such as the combination of a data center and a cluster, or a data center and a folder.
- The VMware-related names shown below are case sensitive in VMware, but the specified names are not case sensitive in a vSphere PowerCLI instance that is executed by this plugin.
Therefore, this plugin cannot be used in an environment in which duplicate names with different case letters are used.
- Data center name, cluster name, and folder name
(3) If you specify a cluster as the destination, the vSphere HA cluster or vSphere DRS cluster must be created.
Prerequisite products on the execution-target server:
- VMware PowerCLI
Supported OSs for the prerequisite products for the execution-target server:
- Windows Server
Cautions
(1) Do not specify a string containing a double quotation mark (") or single quotation mark (') for a property of this plugin.
(2) This plugin moves an ESX server without changing the ESX server status. If you attempt to move an ESX server that makes up a cluster when the ESX server status is not maintenance mode, the attempt might fail and this plugin might end abnormally. In this case, change the ESX server status to maintenance mode, and then execute the plugin.
(3) If you specify a cluster as the destination for the ESX server (VMware.esxDestinationName property), a resource pool is not created when the ESX server is moved.
Execution privilege
(1) Users who connect to VMware vCenter Server must have system administrator permissions.
Version
02.11.00
Plug-in tags
Migrate VM,VMware vSphere
Plug-in name displayed in the task log
vsphereMoveEsx
Return code
12: Error (Mistake by user) Invalid property
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error details.) Unidentified error
41: Error (An error was detected in the component.) Property not entered (An error was detected in the component script.)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
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 |
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 host name of the ESX server. |
-- |
Input |
R |
VMware.esxDestinationName |
New ESX server location |
Specifies the names of the new datacenter, cluster, and folder. |
-- |
Input |
R |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |