5.9.27 Deletion of a virtual server clone
Function
Deletes a virtual server clone 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 (or VMware ESX Server)
- Clone
Clone of the virtual server to be cloned. The clone name is the name of the virtual server clone.
Use situation
Used to delete a clone.
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]
Job Management Partner 1/Automatic Operation 10-50 or later
[Required products on the execution target system]
(1) Prerequisite product for the vCenter server
- VMware vCenter Server 5.5, 5.1, 5.0, 4.1, 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) managing the virtual server
- VMware vSphere ESXi 5.5, 5.1, 5.0 or VMware ESX Server 4.1, 4.0
(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 (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) The VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2) There is no duplicate clone name under the same vCenter. There is no clone name that is the same as an existing virtual server name.
(3) The power status of the clone is OFF.
(4) VMware Tools is installed in the target virtual server.
[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) During clone deletion, do not operate the clone from any other services. Deletion of the clone might fail. Also, do not operate clones directly from the vCenter server.
(2) If the specified clone name is the same as that of the virtual server specified as the cloning source, the clone is not deleted.
(3) The clone name or the name of the virtual server as the cloning source is not case-sensitive.
(4) If virtual server of clone source has already been deleted or name is unknown, use virtual server deletion service to delete clone.
Execution privilege
(1) The user connecting to VMware vCenter Server must have system administrator role permissions.
Version
01.12.00
Category
VirtualMachine/vSphere
Plug-in name displayed in the task log
vsphereDeleteClone
Return code
0: Normal
12: Abnormal (User error) - Invalid property
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 the clone to be deleted. (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 |
Name of a virtual server as the cloning source |
Specifies name of virtual server of clone source (display name of virtual server in VMware vCenter Server, not host name in OS). Specify this name for confirmation to prevent clone source from being mistakenly deleted. This virtual server is not deleted. |
-- |
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 |