ovirt_snapshot_facts – Retrieve facts about one or more oVirt/RHV virtual machine snapshots
ovirt_snapshot_facts – Retrieve facts about one or more oVirt/RHV virtual machine snapshots
New in version 2.3.
Synopsis
- Retrieve facts about one or more oVirt/RHV virtual machine snapshots.
Aliases: ovirt_snapshots_facts
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, can be used as glob expression. | |
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 | |
snapshot_id - |
Id of the snapshot we want to retrieve facts about. | |
vm - / required |
Name of the VM with snapshot. |
Notes
Note
- This module creates a new top-level
ovirt_snapshots
fact, which contains a list of snapshots. - 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:
# Gather facts about all snapshots which description start with C(update) for VM named C(centos7):
- ovirt_snapshot_facts:
vm: centos7
description: update*
- debug:
var: ovirt_snapshots
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_snapshots list |
On success. |
List of dictionaries describing the snapshot. Snapshot attributes are mapped to dictionary keys, all snapshot attributes can be found 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_facts_module.html