vmware_guest_snapshot - Manages virtual machines snapshots in vCenter

New in version 2.3.

Synopsis

  • Create virtual machines snapshots

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
datacenter
required
Destination datacenter for the deploy operation
description Default:
Define an arbitrary description to attach to snapshot.
folder
Destination folder, absolute or relative path to find an existing guest.
This is required if name is supplied.
The folder should include the datacenter. ESX's datacenter is ha-datacenter
Examples:
folder: /ha-datacenter/vm
folder: ha-datacenter/vm
folder: /datacenter1/vm
folder: datacenter1/vm
folder: /datacenter1/vm/folder1
folder: datacenter1/vm/folder1
folder: /folder1/datacenter1/vm
folder: folder1/datacenter1/vm
folder: /folder1/datacenter1/vm/folder2
folder: vm/folder2
folder: folder2
hostname
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable supported added in version 2.6.
memory_dump
(added in 2.4)
    Choices:
  • no ←
  • yes
If set to true, memory dump of virtual machine is also included in snapshot.
Note that memory snapshots take time and resources, this will take longer time to create.
If virtual machine does not provide capability to take memory snapshot, then this flag is set to false.
name
Name of the VM to work with
This is required if uuid is not supplied.
name_match
    Choices:
  • first ←
  • last
If multiple VMs matching the name, use the first or last found
new_description
(added in 2.5)
Value to change the description of an existing snapshot to
new_snapshot_name
(added in 2.5)
Value to rename the existing snapshot to
password
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable supported added in version 2.6.

aliases: pass, pwd
port
(added in 2.5)
 Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable supported added in version 2.6.
quiesce
(added in 2.4)
    Choices:
  • no ←
  • yes
If set to true and virtual machine is powered on, it will quiesce the file system in virtual machine.
Note that VMWare Tools are required for this flag.
If virtual machine is powered off or VMware Tools are not available, then this flag is set to false.
If virtual machine does not provide capability to take quiesce snapshot, then this flag is set to false.
remove_children
(added in 2.4)
    Choices:
  • no ←
  • yes
If set to true and state is set to absent, then entire snapshot subtree is set for removal.
snapshot_name
Sets the snapshot name to manage.
This param is required only if state is not remove_all
state
required
    Choices:
  • present ←
  • absent
  • revert
  • remove_all
Manage snapshots attached to a specific virtual machine.
username
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable supported added in version 2.6.

aliases: user, admin
uuid
UUID of the instance to manage if known, this is VMware's unique identifier.
This is required if name is not supplied.
validate_certs
    Choices:
  • no
  • yes
Default:
True
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.
Environment variable supported added in version 2.6.

Notes

Note

  • Tested on vSphere 5.5, 6.0

Examples

- name: Create snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: present
    snapshot_name: snap1
    description: snap1_description
  delegate_to: localhost

- name: Remove a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    name: dummy_vm
    datacenter: datacenter_name
    folder: /myfolder
    state: remove
    snapshot_name: snap1
  delegate_to: localhost

- name: Revert to a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: revert
    snapshot_name: snap1
  delegate_to: localhost

- name: Remove all snapshots of a VM
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    datacenter: datacenter_name
    folder: /myfolder
    name: dummy_vm
    state: remove_all
  delegate_to: localhost

- name: Take snapshot of a VM using quiesce and memory flag on
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    name: dummy_vm
    state: present
    snapshot_name: dummy_vm_snap_0001
    quiesce: True
    memory_dump: True
  delegate_to: localhost

- name: Remove a snapshot and snapshot subtree
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    name: dummy_vm
    state: remove
    remove_children: True
    snapshot_name: snap1
  delegate_to: localhost

- name: Rename a snapshot
  vmware_guest_snapshot:
    hostname: 192.168.1.209
    username: [email protected]
    password: vmware
    name: dummy_vm
    state: present
    snapshot_name: current_snap_name
    new_snapshot_name: im_renamed
    new_description: "renamed snapshot today"
  delegate_to: localhost

Return Values

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

Key Returned Description
instance
dict
 always
metadata about the new virtualmachine

Sample:
None


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_guest_snapshot_module.html