The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| auth dictionary / required | Dictionary with values needed to create HTTP/HTTPS connection to oVirt: | ||
| ca_file string | 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. | ||
| headers dictionary | Dictionary of HTTP headers to be added to each API call. | ||
| hostname string | 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. | ||
| insecure boolean |
| A boolean flag that indicates if the server TLS certificate and host name should be checked. | |
| kerberos boolean |
| A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. | |
| password string / required | The password of the user. Default value is set by OVIRT_PASSWORD environment variable. | ||
| token string | Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. | ||
| url string | 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. | ||
| username string / required | The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. | ||
| description - | Description of the snapshot. | ||
| disk_id - added in 2.8 | Disk id which you want to upload or download To get disk, you need to define disk_id or disk_name | ||
| disk_name - added in 2.8 | Disk name which you want to upload or download | ||
| download_image_path - added in 2.8 | Path on a file system where snapshot should be downloaded. Note that you must have an valid oVirt/RHV engine CA in your system trust store or you must provide it in ca_file parameter.Note that the snapshot is not downloaded when the file already exists, but you can forcibly download the snapshot when using force I (true). | ||
| fetch_nested boolean |
| 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. | |
| keep_days_old - added in 2.8 | Number of days after which should snapshot be deleted. It will check all snapshots of virtual machine and delete them, if they are older. | ||
| nested_attributes list | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true. | ||
| poll_interval integer | 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 integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state. | |
| upload_image_path - added in 2.8 | Path to disk image, which should be uploaded. | ||
| use_memory boolean |
| 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 boolean |
| yes 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 }}"
# Upload local image to disk and attach it to vm:
# Since Ansible 2.8
- ovirt_snapshot:
name: mydisk
vm_name: myvm
upload_image_path: /path/to/mydisk.qcow2
# Download snapshot to local file system:
# Since Ansible 2.8
- ovirt_snapshot:
snapshot_id: 7de90f31-222c-436c-a1ca-7e655bd5b60c
disk_name: DiskName
vm_name: myvm
download_image_path: /home/user/mysnaphost.qcow2
# Delete all snapshots older than 2 days
- ovirt_snapshot:
vm_name: test
keep_days_old: 2
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. |
| snapshots list | On success returns deleted snapshots | List of deleted snapshots when keep_days_old is defined and snapshot is older than the input days |
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.9/modules/ovirt_snapshot_module.html