vmware.vmware.vm_snapshot_revert module – Revert a virtual machine to a snapshot

Note

This module is part of the vmware.vmware collection (version 2.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware.

To use it in a playbook, specify: vmware.vmware.vm_snapshot_revert.

Synopsis

  • This module can be used to revert a virtual machine to a snapshot.

  • Since the virtual machine immediately begins to drift from the snapshot, this module will always attempt to revert the virtual machine. A change will always be reported.

  • If the snapshot is not found, the module will fail.

Parameters

Parameter

Comments

datacenter

string

Datacenter to search for the virtual machine.

folder

string

Absolute or relative folder path to search for the virtual machine.

This parameter is required if name is supplied.

For example ‘datacenter name/vm/path/to/folder’ or ‘path/to/folder’

folder_paths_are_absolute

boolean

If true, any folder path parameters are treated as absolute paths.

If false, modules will try to intelligently determine if the path is absolute or relative.

This option is useful when your environment has a complex folder structure. By default, modules will try to intelligently determine if the path is absolute or relative. They may mistakenly prepend the datacenter name or other folder names, and this option can be used to avoid this.

Choices:

  • false ← (default)

  • true

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

moid

string

Managed Object ID of the virtual machine to manage.

This is required if name or uuid is not supplied.

name

string

Name of the virtual machine to work with.

This is required parameter, if uuid or moid is not supplied.

name_match

string

If multiple VMs with the same name exist, use the first or last found.

Choices:

  • "first" ← (default)

  • "last"

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

The address of a proxy that will receive all HTTPS requests and relay them.

The format is a hostname or a IP.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

The port of the HTTP proxy that will receive all HTTPS requests and relay them.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.

snapshot_id

integer

The ID of the snapshot to revert to.

Either this parameter or snapshot_name is required.

snapshot_name

string

The name of the snapshot to revert to.

Either this parameter or snapshot_id is required.

suppress_power_on

boolean

If true, the virtual machine will not be powered on after the snapshot is reverted, even if the snapshot was taken while the virtual machine was powered on.

Choices:

  • false ← (default)

  • true

use_instance_uuid

boolean

Whether to use the VMware instance UUID rather than the BIOS UUID.

Choices:

  • false ← (default)

  • true

username

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

uuid

string

UUID of the instance to manage. This is VMware’s BIOS UUID by default.

This is required if name or moid parameter is not supplied.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Create a snapshot
  vmware.vmware.vm_snapshot:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    folder: "/{{ datacenter_name }}/vm/"
    name: "{{ guest_name }}"
    state: present
    snapshot_name: snap1
    description: snap1_description
  register: _create_snap

- name: Revert VM to snapshot
  vmware.vmware.vm_snapshot_revert:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: "{{ _create_snap.vm.moid }}"
    snapshot_name: snap1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

dictionary

Information about the vCenter task, if one was run

Returned: On change

Sample: {"completion_time": "2025-04-15T23:29:47.435215+00:00", "entity_name": "test-e7e0-vm", "error": null, "state": "success"}

snapshot

dictionary

Information about the snapshot

Returned: Always

Sample: {"id": 1, "name": "snap1"}

vm

dictionary

Information about the target VM

Returned: Always

Sample: {"moid": "vm-79828,", "name": "test-d9c1-vm"}

Authors

  • Ansible Cloud Team (@ansible-collections)