5.5.31 Creating a virtual server clone
Function
Creates a clone of a virtual server in the VMware vSphere environment.
This component assumes the following servers as prerequisites:
- vCenter server
Server where VMware vCenter Server is installed
- vCenter control server
Server where VMware vSphere PowerCLI is installed
- Virtual server to be cloned
Virtual server managed by vCenter server or VMware vSphere ESXi
- Clone
Clone of the virtual server to be cloned. The clone name is the name of the virtual server clone.
Use situation
Creates a clone as a backup of the virtual server after creating the server.
Prerequisites
For the latest support information about [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.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target system]
(1) Prerequisite product for the vCenter
- VMware vCenter Server
(2) VMware vSphere ESXi managing the virtual server
(3) Prerequisite OS for 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/vCenter control server that manages the virtual server.
- Windows Server
- Red Hat Enterprise Linux Server
[Usage conditions for required products in the execution target system]
(1) The power status of the virtual server to be cloned is OFF.
(2) To put the virtual server into a resource pool, the resource pool name and cluster name are unique.
A duplicate name is not allowed, even if the type, such as the combination of the cluster and resource pool, is different.
(3) There is no duplicate clone name in the same vCenter instance. There is no clone name that is the same as an existing virtual server name.
(4) There is no duplicate data store name under the same vCenter.
(5) VMware Tools is installed in the target virtual server.
(6) The version of VMware vSphere ESXi managing the virtual server to be clone matches that of VMware vSphere ESXi managing the cloning destination.
[Required products on the execution target server]
- VMware PowerCLI
[Prerequisite product OS running in the execution target server]
- Windows Server
Cautions
(1) During the creation of a virtual server clone, do no operate the source virtual server or the clone of the destination. Also, do not operate them directly from the vCenter server. Cloning might fail.
(2) If the virtual server to be cloned has a raw or RAM disk, the disk will be converted to a virtual disk.
(3) vApp cannot be specified as the destination of cloning.
(4) Do not start the created clone. To start a created clone, it is necessary to delete or restore the cloned virtual server.
(5) If the virtual server to be cloned has snapshots, they are all deleted. (If there is a snapshot in use, the snapshot is committed.)
Execution privilege
(1) The user connecting to VMware vCenter Server must have system administrator role permissions.
Version
02.11.00
Plug-in tags
Clone VM,VMware vSphere
Plug-in name displayed in the task log
vsphereCreateClone
Return code
0: Normal
23: Abnormal (Environment error) Invalid prerequisite environment
27: Abnormal (See the task log for error contents.)
41: Abnormal (Error detected inside the component) - A property is not specified. (The component script has detected an error.)
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.cloneName |
Clone name |
Specifies the name of a clone (This is the display name of a clone under VMware vCenter Server. It is not a host name under the OS.) |
-- |
Input |
R |
VMware.vmName |
Virtual server name |
Specifies the name of a virtual server as the cloning source (This is the display name of a virtual server under VMware vCenter Server. It is not a host name under the OS.) |
-- |
Input |
R |
VMware.vmHostName |
Host name of the ESX server |
Specifies the ESX server name displayed in [Hosts and Clusters] managed by the VMware vCenter Server, which serves as the cloning destination. |
-- |
Input |
R |
VMware.dataStoreName |
Datastore name |
Specifies the name of a data store as the cloning destination. |
-- |
Input |
R |
VMware.resourcePoolName |
Resource pool name |
Specifies a resource pool or cluster as the cloning destination. |
-- |
Input |
O |
VMware.diskFormat |
Virtual disk format |
Specifies format of the virtual disk of the clone to be created. Specify "Default" when the format is the same as the virtual disk of the virtual server of the clone source, "Thin" when committing it on demand, or "Thick" when committing it in full size. |
-- |
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 |