ovirt_snapshot – Module to manage Virtual Machine Snapshots in oVirt/RHV
ovirt_snapshot – Module to manage Virtual Machine Snapshots in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage Virtual Machine Snapshots in oVirt/RHV
Aliases: ovirt_snapshots
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth - / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
description - |
Description of the snapshot. | |
fetch_nested boolean added in 2.3 |
|
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 - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
snapshot_id - |
ID of the snapshot to manage. | |
state - |
|
Should the Virtual Machine snapshot be restore/present/absent. |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
use_memory boolean |
|
If true and If true and Note that Virtual Machine will be paused while saving the memory.
|
vm_name - / required |
Name of the Virtual Machine to manage. | |
wait boolean |
|
True if the module should wait for the entity to get into desired state. |
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.2.4
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create snapshot:
- ovirt_snapshot:
vm_name: rhel7
description: MySnapshot
register: snapshot
# Create snapshot and save memory:
- ovirt_snapshot:
vm_name: rhel7
description: SnapWithMem
use_memory: true
register: snapshot
# Restore snapshot:
- ovirt_snapshot:
state: restore
vm_name: rhel7
snapshot_id: "{{ snapshot.id }}"
# Remove snapshot:
- ovirt_snapshot:
state: absent
vm_name: rhel7
snapshot_id: "{{ snapshot.id }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
On success if snapshot is found. |
ID of the snapshot which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
snapshot dictionary |
On success if snapshot is found. |
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.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_snapshot_module.html