VMware: Delete Snapshot
Description
VMware: Delete Snapshot plugin step deletes a specified snapshot, optionally along with its child snapshots associated with a virtual machine.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name must be unique in a single workflow. |
| Configuration | ||
| 1 | vCenter Server Base URL | Specify the vCenter Server Base URL to connect to vCenter (e.g., https://vmware.example.com). Note: If vCenter IP is used instead of the server name, a certificate error may occur unless the IP is listed in the certificate’s Subject Alternative Name. |
| 2 | Port | Specify the vCenter server port. Default is 443. Data type: Integer Valid range: Less than 65536 |
| 3 | Username | Specify the username to authenticate to the vCenter server. |
| Password: | ||
| 4 | Accept value as variable/static | Leave the checkbox unchecked to use values from previous steps (drop-down). Enable it to enter static/environment variable value. |
| 5 | Password | Entered using a widget that supports both static values and drop-downs. If the checkbox above is enabled, the field appears as a text box. Otherwise, it appears as a drop-down. This field is mandatory. Note: Field values are only accessible during workflow execution. |
| 6 | Button: Test Connection | Verifies whether the connection is available or not. |
| For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Virtual Machine Name/UUID | Specify the name or UUID of the VM associated with the snapshot to be deleted. Data type: String This field is mandatory. Note: • Refer to the VMware Plugin Introduction to get VM UUID. • If duplicate VM names exist, use UUID to uniquely identify the VM. • If the VM name contains %, replace it with %25. |
| 2 | Button: Get | Retrieves the list of VM names if the connection is successful. |
| Optional Input Fields | Provide value for only one of the following only | |
| i | Snapshot Created Date | Specify the Snapshot Created Date of a snapshot that is to be deleted in specified date format. Date Format: EEEE, MMMM dd, yyyy h:mm:ss a Date Example: Tuesday, November 26, 2019, 12:01:36 PM The data type is String. This field is optional.Note: Provide value in Snapshot Created Date or Snapshot Name but not both. |
| ii | Button: Get | On click of this button, if the connection is successfully established it populates the list of Snapshot Created Dates on the vCenter server. |
| iii | Snapshot Name | Specify the name of the snapshot to be deleted. Data type: String Optional field Note: Provide a value in either Snapshot Created Date or Snapshot Name, not both. |
| iv | Button: Get | On click of this button, if the connection is successfully established it populates the list of Snapshot Names on the vCenter server. |
| 4 | Delete Child Snapshots | Allowed values: Yes or No. If Yes, all child snapshots of the specified snapshot will also be deleted. If left blank, child snapshots are not deleted. Data type: String This field is mandatory. |
Common Buttons
| No. | Field Name | Description |
|---|---|---|
| 1 | OK | Click this button to check and save the field values. If any required field values are missing then it will display a validation error message else if all the required field values are provided then it will save the field values. |
| 2 | Cancel | Cancels the configuration window without saving values. |