Documentation

cs_vmsnapshot - Manages VM snapshots on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

  • Create, remove and revert VM from snapshots.

Options

parameter required default choices comments
account
no
Account the VM snapshot is related to.
api_http_method
no get
  • get
  • post
HTTP method used.
api_key
no
API key of the CloudStack API.
api_region
no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
no
Secret key of the CloudStack API.
api_timeout
no 10
HTTP timeout.
api_url
no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
description
no
Description of the snapshot.
domain
no
Domain the VM snapshot is related to.
name
yes
Unique Name of the snapshot. In CloudStack terms display name.

aliases: display_name
poll_async
no True
Poll async jobs until job has finished.
project
no
Name of the project the VM is assigned to.
snapshot_memory
no
Snapshot memory if set to true.
state
no present
  • present
  • absent
  • revert
State of the snapshot.
tags
(added in 2.4)
no
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
yes
Name of the virtual machine.
zone
no
Name of the zone in which the VM is in. If not set, default zone is used.

Examples

# Create a VM snapshot of disk and memory before an upgrade
- local_action:
    module: cs_vmsnapshot
    name: Snapshot before upgrade
    vm: web-01
    snapshot_memory: yes

# Revert a VM to a snapshot after a failed upgrade
- local_action:
    module: cs_vmsnapshot
    name: Snapshot before upgrade
    vm: web-01
    state: revert

# Remove a VM snapshot after successful upgrade
- local_action:
    module: cs_vmsnapshot
    name: Snapshot before upgrade
    vm: web-01
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
current true if snapshot is current success boolean True
domain Domain the the vm snapshot is related to. success string example domain
display_name Display name of the snapshot. success string snapshot before update
name Name of the snapshot. success string snapshot before update
created date of the snapshot. success string 2015-03-29T14:57:06+0200
account Account the vm snapshot is related to. success string example account
project Name of project the vm snapshot is related to. success string Production
state state of the vm snapshot success string Allocated
type type of vm snapshot success string DiskAndMemory
id UUID of the snapshot. success string a6f7a5fc-43f8-11e5-a151-feff819cdc9f
description description of vm snapshot success string snapshot brought to you by Ansible


Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.