VMware: Take VM Snapshot
Description
VMware: Take VM Snapshot plugin step takes a snapshot of a virtual machine’s state.
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 take a snapshot. The data type is string. This field is mandatory. |
| Notes: • 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. |
| 3 | New Snapshot Name | Specify the name of the new snapshot to be created. If no value is provided, a new snapshot is generated with the current date-time. Example: VM Snapshot 25/11/2019 03:35:09 PM |
| 4 | Snapshot Description | Provide a description for the snapshot. |
| 5 | Snapshot The Virtual Machine’s Memory | Allowed values are: ‘Yes’ or ‘No’. If the specified value is “Yes”, then the memory state of the Virtual Machine is also saved with the Snapshot. Note: ‘Snapshot The Virtual Machine’s Memory’ and ‘Quiesce Guest File System’ values are considered only if the Virtual Machine is in a running state. |
| Allowed combinations of values for ‘Snapshot The Virtual Machine’ and ‘Quiesce Guest File System’: | ||
| 6 | Quiesce Guest File System | Allowed values: ‘Yes’ or ‘No’. If the specified value is “Yes”, then writing to the memory of the Virtual Machine is stopped while creating the Snapshot. Note: Refer to the note under Snapshot The Virtual Machine’s Memory. |