VMware: Revert VM to Snapshot
VMware: Revert To Snapshot plugin step reverts a Virtual Machine to a specified snapshot of a virtual machine or to the latest (current) snapshot.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to 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 given instead of vCenter server name, it throws certificate error, because the certificate contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format. |
| 2 | Port | Specify the vCenter server port. (Default port is 443). This field should be an integer and value should be less than 65536. |
| 3 | Username | Specify a Username to authenticate vCenter server. |
| Password: | The password to authenticate vCenter server. | |
| 4 | Accept value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 5 | Password | Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. Please Note: that Field values can only be accessed when workflow is in running state. |
| 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/UUID of the virtual machine to revert to a snapshot. The data type is string. This field is mandatory. |
| Note(s): | - Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID. - If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM. - If VM name contains ‘%’ special character then to execute the plugin step, provide VM name by replacing ‘%’ character with ‘%25’. | |
| 2 | Button: Get | On click of this button, if the connection is successfully established, it populates the list of Virtual Machine Names on the vCenter server. Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that. |
| 3 | Snapshot Created Date | Snapshot Created Date of a snapshot to revert. Date Format: EEEE, MMMM dd, yyyy h:mm:ss a (e.g., Tuesday, November 26, 2019, 12:01:36 PM). The data type is string. This field is optional. |
| 4 | 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. |
| 5 | Snapshot Name | Specify Snapshot Name to revert VM to. ‘Snapshot Name’ must be unique. The data type is string. This field is optional. |
| 6 | Button: Get | On click of this button, if the connection is successfully established it populates the list of Snapshot Names on the vCenter server. |
| 7 | Revert VM To Latest (Current) Snapshot | Allowed Value: ‘Yes’. If given “Yes” then a virtual machine will be reverted to the latest (current) snapshot state. If the field is blank, then ‘No’ is considered. The data type is string. This field is optional. |
tip
Allowed combinations of values for the input fields viz., ‘Revert VM To Snapshot Created Date’, ‘Revert VM To Snapshot Name’ and ‘Revert VM To Latest (Current) Snapshot as depicted below. As seen below only one of the following values can be provided.
Input Tab:
| No. | Revert VM To Snapshot Created Date | Revert VM To Snapshot Name | Revert VM To Latest (Current) Snapshot |
|---|---|---|---|
| 1 | <Valid DateTime> | ||
| 2 | <Valid Name> | ||
| 3 | <Yes> |
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, it will display a validation error message; else, if all the required field values are provided, it will save the field values. |
| 2 | Cancel | Click this button to cancel the window and not save any values. |