3.16.3 Delete Cloned Virtual Machine

Function

Deletes a clone in the VMware vSphere environment

This service template 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 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.

An outline of the processing is as follows:

(1) The power status of the clone is obtained.

(2) It is confirmed that the power status of the clone is OFF.

If the power status is not OFF, the service ends abnormally.

If the power status is OFF, the service proceeds to the next processing.

(3) The clone is deleted.

The maximum length of the virtual server name property (vmware.vmName) and clone name property (vmware.cloneName) are 60 characters.

Prerequisites

For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.

[Required product in the System]

JP1/Automatic Operation 12-00 or later

[Prerequisite products in the system executing the service template]

(1) Prerequisite product for the vCenter server

- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 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 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0 or VMware ESX Server 4.0, 4.1

(3) Prerequisite product for the vCenter control server

- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Releae2, 5.0

- VMware PowerCLI 6.5 Release1

- VMware PowerCLI 6.5.1, 6.5.4

- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0

[Prerequisite product OS running in the system executing the service template]

(1) 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 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

- Windows Server 2016 Standard/Datacenter

- Windows Server 2019 Standard/Datacenter

- Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)

- Red Hat Enterprise Linux Server 7 (64-bit x86_64)

- Red Hat Enterprise Linux Server 8 (64-bit x86_64)

- CentOS 6 (64-bit x86_64)

- CentOS 7 (64-bit x86_64)

- CentOS 8 (64-bit x86_64)

(2) Prerequisite OS for the vCenter control server

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

- Windows Server 2016 Standard/Datacenter

- Windows Server 2019 Standard/Datacenter

[Usage conditions for the required products for the service template execution system]

(1) The VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.

(2) There is no name duplication of the clone to be deleted in the same vCenter instance. Also, there is no virtual server name that is the same the clone name.

(3) VMware Tools is installed in the virtual servers to be operated.

Cautions

(1) Do not execute this service for multiple instances of the same clone at the same time.

(2) 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

03.00.00

Tags

Delete Cloned VM,VMware vSphere

Property list

The following shows the list of the property groups set in the property:

Property group	Description	Initial display
Virtual system environment information	Specify the VMware vCenter Server information.	Y
Information about a virtual server as the cloning source	Specify the name of a virtual server as the cloning source.	Y
Information about the clone to be deleted	Specify the information about the clone to be deleted.	Y

The following shows the list of the properties to be displayed in the "Service Definition" window:

(Legend)

R: The property must be specified.

O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.

Property key	Property name	Description	I/O type	Shared	Required	Property group
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.	Input	Disabled	R	Virtual system environment information
vmware.vCenterServerName	VMware vCenter server name	Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address.	Input	Disabled	R	Virtual system environment information
vmware.userName	User name for VMware vCenter Server connection	Specify the user name to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information
vmware.password	Password for VMware vCenter Server connection	Specify the password to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information
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.	Input	Disabled	O	Virtual system environment information
vmware.protocol	Protocol for VMware vCenter Server connection	Specify the protocol to use when connecting to the VMware vCenter server.	Input	Disabled	R	Virtual system environment information

The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Property name	Description	I/O type	Shared	Required	Property group
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	Disabled	R	Information about a virtual server as the cloning source
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.)	Input	Disabled	R	Information about the clone to be deleted

The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:

Property key	Characters that can be input
vmware.targetHost	A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.
vmware.vCenterServerName	A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.
vmware.userName	A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %.
vmware.password	A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %.
vmware.portNumber	Integer between 1 and 65535 can be entered.
vmware.protocol	Select one of the following values: http,https

The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:

Property key	Characters that can be input
vmware.vmName	A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, , and %.
vmware.cloneName	This is a character string of up to 60 characters. < > | ; & ' " * ? [ ] ` , and % are not allowed.

Flow specification details

The following table shows the detailed specification of the flow:

Hierarchy	Display name	Plug-in
		Plug-in name	Description	Error recovery method
1	vsphereGetPower	Get power status of virtual server	Obtains the power status of the clone in the VMware vSphere environment.	Remove the cause of the error, and then execute the service again.
2	vsphereCheckPower	Flow Plug-in	Checks the power status, and if the status is not OFF, ends with an error.	--
2-3		Compatible Plug-in	Determines whether the output character string matches "PoweredOn".	After removing the cause of the error, run the service again.
2-4		Abnormal-End Plug-in	Makes the jobnet an error.	Check the power supply state of the clone and execute the service again.
3	vsphereDeleteClone	Deletion of a virtual server clone	Deletes a clone of a virtual server in the VMware vSphere environment.	Remove the cause of the error, and then execute the service again.

To Page Top