W3cubDocs

/Ansible

ovirt_snapshots - Module to manage Virtual Machine Snapshots in oVirt/RHV

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Module to manage Virtual Machine Snapshots in oVirt/RHV

Requirements (on host that executes module)

python >= 2.7
ovirt-engine-sdk-python >= 4.0.0

Options

parameter	required	default	choices	comments
auth	yes			Dictionary with values needed to create HTTP/HTTPS connection to oVirt: `username`[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. `password`[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable. `url`[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. `token` - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. `insecure` - A boolean flag that indicates if the server TLS certificate and host name should be checked. `ca_file` - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If ``ca_file`` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable. `kerberos` - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. `headers` - Dictionary of HTTP headers to be added to each API call.
description	no			Description of the snapshot.
fetch_nested (added in 2.3)	no			If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying `nested_attributes`.
nested_attributes (added in 2.3)	no			Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval	no	3		Number of the seconds the module waits until another poll request on entity status is sent.
snapshot_id	no			ID of the snapshot to manage.
state	no	present	restore present absent	Should the Virtual Machine snapshot be restore/present/absent.
timeout	no	180		The amount of time in seconds the module should wait for the instance to get into desired state.
use_memory	no			If true and `state` is present save memory of the Virtual Machine if it's running. If true and `state` is restore restore memory of the Virtual Machine. Note that Virtual Machine will be paused while saving the memory.
vm_name	yes			Name of the Virtual Machine to manage.
wait	no			True if the module should wait for the entity to get into desired state.

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create snapshot:
- ovirt_snapshots:
    vm_name: rhel7
    description: MySnapshot
  register: snapshot

# Create snapshot and save memory:
- ovirt_snapshots:
    vm_name: rhel7
    description: SnapWithMem
    use_memory: true
  register: snapshot

# Restore snapshot:
- ovirt_snapshots:
    state: restore
    vm_name: rhel7
    snapshot_id: "{{ snapshot.id }}"

# Remove snapshot:
- ovirt_snapshots:
    state: absent
    vm_name: rhel7
    snapshot_id: "{{ snapshot.id }}"

Return Values

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

name	description	returned	type	sample
snapshot	Dictionary of all the snapshot attributes. Snapshot attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/snapshot.	On success if snapshot is found.	dict
id	ID of the snapshot which is managed	On success if snapshot is found.	str	7de90f31-222c-436c-a1ca-7e655bd5b60c

Notes

Note

Note that without a guest agent the data on the created snapshot may be inconsistent.
Deleting a snapshot does not remove any information from the virtual machine - it simply removes a return-point. However, restoring a virtual machine from a snapshot deletes any content that was written to the virtual machine after the time the snapshot was taken.
In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.0.0

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ovirt_snapshots_module.html