W3cubDocs

/Ansible

cs_snapshot_policy - Manages volume snapshot policies on Apache CloudStack based clouds.

New in version 2.2.

Synopsis

Create, update and delete volume snapshot policies.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
Account the volume 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.
domain
 no
Domain the volume is related to.
interval_type
 no daily
  • hourly
  • daily
  • weekly
  • monthly
Interval of the snapshot.
aliases: interval
max_snaps
 no 8
Max number of snapshots.
aliases: max
project
 no
Name of the project the volume is related to.
schedule
 no
Time the snapshot is scheduled. Required if state=present.
Format for interval_type=HOURLY: MM
Format for interval_type=DAILY: MM:HH
Format for interval_type=WEEKLY: MM:HH:DD (1-7)
Format for interval_type=MONTHLY: MM:HH:DD (1-28)
state
 no present
  • present
  • absent
State of the snapshot policy.
time_zone
 no UTC
Specifies a timezone for this command.
aliases: timezone
volume
 yes
Name of the volume.

Examples

# Ensure a snapshot policy daily at 1h00 UTC
- local_action:
    module: cs_snapshot_policy
    volume: ROOT-478
    schedule: '00:1'
    max_snaps: 3

# Ensure a snapshot policy hourly at minute 5 UTC
- local_action:
    module: cs_snapshot_policy
    volume: ROOT-478
    schedule: '5'
    interval_type: hourly
    max_snaps: 1

# Ensure a snapshot policy weekly on Sunday at 05h00, TZ Europe/Zurich
- local_action:
    module: cs_snapshot_policy
    volume: ROOT-478
    schedule: '00:5:1'
    interval_type: weekly
    max_snaps: 1
    time_zone: 'Europe/Zurich'

# Ensure a snapshot policy is absent
- local_action:
    module: cs_snapshot_policy
    volume: ROOT-478
    interval_type: hourly
    state: absent

Return Values

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

name description returned type sample
volume the volume of the snapshot policy. success string Etc/UTC
account Account the volume is related to. success string example account
zone Name of zone the volume is related to. success string ch-gva-2
schedule schedule of the snapshot policy. success string None
interval_type interval type of the snapshot policy. success string daily
time_zone the time zone of the snapshot policy. success string Etc/UTC
project Name of project the volume is related to. success string Production
domain Domain the volume is related to. success string example domain
max_snaps maximum number of snapshots retained. success int 10
id UUID of the snapshot policy. success string a6f7a5fc-43f8-11e5-a151-feff819cdc9f

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.

Note

A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html

Note

This module supports check mode.

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/cs_snapshot_policy_module.html