ngine_io.cloudstack.cs_vmsnapshot – Manages VM snapshots on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ngine_io.cloudstack.
To use it in a playbook, specify: ngine_io.cloudstack.cs_vmsnapshot.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Create, remove and revert VM from snapshots.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- cs >= 0.9.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| account
string
|
Account the VM snapshot is related to.
|
|
| api_http_method
string
|
|
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
|
| api_key
string / required
|
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
|
|
| api_secret
string / required
|
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
|
|
| api_timeout
integer
|
Default:
10
|
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
|
| api_url
string / required
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
|
|
| api_verify_ssl_cert
string
|
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
|
|
| description
string
|
Description of the snapshot.
|
|
| domain
string
|
Domain the VM snapshot is related to.
|
|
| name
string / required
|
Unique Name of the snapshot. In CloudStack terms display name.
aliases: display_name |
|
| poll_async
boolean
|
|
Poll async jobs until job has finished.
|
| project
string
|
Name of the project the VM is assigned to.
|
|
| snapshot_memory
boolean
|
|
Snapshot memory if set to true.
|
| state
string
|
|
State of the snapshot.
|
| tags
list / elements=dictionary
|
List of tags. Tags are a list of dictionaries having keys key and value.
To delete all tags, set a empty list e.g. tags: [].
aliases: tag |
|
| vm
string / required
|
Name of the virtual machine.
|
|
| zone
string / required
|
Name of the zone in which the VM is in. If not set.
|
Notes
Note
- A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
- name: Create a VM snapshot of disk and memory before an upgrade
ngine_io.cloudstack.cs_vmsnapshot:
name: Snapshot before upgrade
vm: web-01
zone: zone01
snapshot_memory: yes
- name: Revert a VM to a snapshot after a failed upgrade
ngine_io.cloudstack.cs_vmsnapshot:
name: Snapshot before upgrade
vm: web-01
zone: zone01
state: revert
- name: Remove a VM snapshot after successful upgrade
ngine_io.cloudstack.cs_vmsnapshot:
name: Snapshot before upgrade
vm: web-01
zone: zone01
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| account
string
|
success |
Account the vm snapshot is related to.
Sample:
example account
|
| created
string
|
success |
date of the snapshot.
Sample:
2015-03-29T14:57:06+0200
|
| current
boolean
|
success |
true if the snapshot is current
Sample:
True
|
| description
string
|
success |
description of vm snapshot
Sample:
snapshot brought to you by Ansible
|
| display_name
string
|
success |
Display name of the snapshot.
Sample:
snapshot before update
|
| domain
string
|
success |
Domain the vm snapshot is related to.
Sample:
example domain
|
| id
string
|
success |
UUID of the snapshot.
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
| name
string
|
success |
Name of the snapshot.
Sample:
snapshot before update
|
| project
string
|
success |
Name of project the vm snapshot is related to.
Sample:
Production
|
| state
string
|
success |
state of the vm snapshot
Sample:
Allocated
|
| type
string
|
success |
type of vm snapshot
Sample:
DiskAndMemory
|
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_vmsnapshot_module.html