5.9.25 Deletion of a virtual server snapshot
Function
Deletes a specified snapshot of a virtual server in the VMware vSphere environment.
If the snapshot specified to be deleted is currently in use, the change is applied to the virtual disk containing the source snapshot.
This component assumes the following servers as prerequisites:
- vCenter server
Server where VMware vCenter Server is installed
- vCenter control server (Execution target server)
Server where VMware vSphere PowerCLI is installed. JP1/AO transfers the component to the server for execution.
- Virtual server
Virtual server managed by vCenter server or VMware vSphere ESXi (or VMware ESX Server)
Use situation
This component can be used to delete a snapshot.
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) Conditions for the virtual server:
- There is no duplicate virtual server name under the same vCenter.
- VMware Tools is installed in the 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) Do not target any virtual servers where a raw disk, an RDM physical mode disk, or an independent disk is set.
Execution privilege
(1) The user connecting to VMware vCenter Server must have the following permissions:
System administrator role permissions
Version
01.12.00
Category
VirtualMachine/vSphere
Plug-in name displayed in the task log
vsphereRemoveSnapshot
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.vmName |
Virtual server name |
Specify the name of the virtual server. (This is the virtual server name in VMware vCenter Server. Do not specify a host name.) |
-- |
Input |
R |
|
VMware.snapshotId |
Snapshot ID |
Specify the ID of the snapshot. |
-- |
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 |