New in version 2.3.
Aliases: ovirt_snapshots
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth required | 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 - A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. Either url or hostname is required.hostname - A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by OVIRT_HOSTNAME environment variable. Either url or hostname is required.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 | Description of the snapshot. | |
fetch_nested bool (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 . |
nested_attributes (added in 2.3) | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true. | |
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 bool |
| 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. aliases: restore_memory, save_memory |
vm_name required | Name of the Virtual Machine to manage. | |
wait bool |
|
True if the module should wait for the entity to get into desired state. |
Note
# 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 }}"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id str | On success if snapshot is found. | ID of the snapshot which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
snapshot dict | 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. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_snapshot_module.html