Service Definition Properties
The following table lists the properties visible in the Service Definition window for the Migrate Virtual Machine service template.
| Property Key | Property Name | Description | Required or optional |
|---|---|---|---|
| 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. | R |
| vmware.vCenterServerName | VMware vCenter server name | Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. | R |
| vmware.userName | User name for VMware vCenter Server connection | Specify the user name to use when connecting to the VMware vCenter server. | R |
| vmware.password | Password for VMware vCenter Server connection | Specify the password to use when connecting to the VMware vCenter server. | 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. | O |
| vmware.protocol | Protocol for VMware vCenter Server connection | Specify the protocol to use when connecting to the VMware vCenter server. | R |
Service Definition and Submit Service Properties
The following table lists the properties visible in the Service Definition and Submit Service windows for the Migrate Virtual Machine service template.
| Property Key | Property Name | Description | Required or optional |
|---|---|---|---|
| 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. | R |
| vmware.destinationName | Virtual server destination | Specify the name of the destination VMware vSphere ESXi (or VMware ESX Server), resource pool, cluster, or folder. | R |
Prerequisites
Note: Although some of the properties in the tables indicate that they can be omitted, they might be required when used in conjunction with some other property setting as indicated in the descriptions.
The following conditions must be met:
- VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
- Each virtual server name is unique among the vCenter servers.
- The firewall of the target virtual server is set to allow responses to ICMP (ECHO).
- VMwareTools is installed on the target virtual server.
Server requirements
To use this service template, the following servers are needed:
- 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. Note: If a target virtual server's power is on, the plug-in performs hot migration (migration with the power on); if the target virtual server's power is off, the plug-in performs cold migration (migration with the power off).
Software requirements
One of the following is required:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1
Usage guidelines
- When you move multiple virtual servers, the target VMware vSphere ESXi (or VMware ESX Server) might experience a high workload.
- The same virtualization software product must be used for the source and the target.
- The virtualization software that runs the virtual servers must be running.
- The virtual server name, cluster name, vApp name, and resource pool name must be unique within the vCenter Server.
Note: 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 pool name.
- If a cluster is specified as a virtual server's migration target, the virtual server being migrated must exist in the resource pool under the specified target cluster.
- 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.
- 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 fails.