This service template deletes a clone in the VMware vSphere environment.
The general steps for using this service template to delete a cloned Virtual Machine are as follows:
- Obtain the power status of the clone.
- Confirm that the power status of the clone is OFF.
- If the power status is OFF, the service proceeds to the next step.
- If the power status is not OFF, the service ends abnormally.
- Delete the clone.
The maximum length of the virtual server name property vmware.vmName and clone name property vmware.cloneName is 60 characters.
Service Definition Properties
The following table lists the properties visible in the Service Definition window for the Delete Cloned 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 |
The following table lists the properties visible in the Service Definition and Submit Service windows for the Delete Cloned Virtual Machine service template.
Property Key | Property Name | Description | Required or optional |
---|---|---|---|
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. | R |
vmware.cloneName | Name of the clone to be deleted | Specify 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.) | 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.
- No name duplication of the clone to be deleted can be in the same vCenter instance. Also, there is no virtual server name that is the same the clone name.
- VMware Tools is installed in the virtual servers to be operated.
Server requirements
To use this service template, the following servers are needed:
- vCenter server: Server on which VMware vCenter Server is installed.
- vCenter control server: Server on which VMware vSphere PowerCLI is installed.
- Virtual server cloned: Virtual server managed by vCenter server or VMware vSphere ESXi (or VMware ESX Server).
- Clone: Clone of the virtual server cloned. The clone name is the name of the virtual server clone.
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
- Do not run this service for multiple instances of the same clone at the same time.
- If virtual server of clone source is already deleted or the name is unknown, use the virtual server deletion service to delete the clone.