Docs4dev
Docs
ansible / 2.4 / sf_snapshot_schedule_manager_module.html

sf_snapshot_schedule_manager - Manage SolidFire snapshot schedules

New in version 2.3.

Synopsis

  • Create, destroy, or update accounts on SolidFire

Requirements (on host that executes module)

  • solidfire-sdk-python (1.1.0.92)

Options

parameter required default choices comments
hostname
 yes
The hostname or IP address of the SolidFire cluster.
name
 yes
Name for the snapshot schedule.
password
 yes
Password for the specified user.
paused
 no
Pause / Resume a schedule.
recurring
 no
Should the schedule recur?
retention
 no
Retention period for the snapshot.
Format is 'HH:mm:ss'.
schedule_id
 no
The schedule ID for the schedule that you want to update or delete.
snapshot_name
 no
Name for the created snapshots.
starting_date
 no
Starting date for the schedule.
Required when state=present.
Please use two '-' in the above format, or you may see an error- TypeError, is not JSON serializable description.
Format: 2016--12--01T00:00:00Z
state
 yes
  • present
  • absent
Whether the specified schedule should exist or not.
time_interval_days
 no 1
Time interval in days.
time_interval_hours
 no
Time interval in hours.
time_interval_minutes
 no
Time interval in minutes.
username
 yes
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://goo.gl/ddJa4Q.
volumes
 no
Volume IDs that you want to set the snapshot schedule for.
At least 1 volume ID is required for creating a new schedule.
required when state=present

Examples

- name: Create Snapshot schedule
  sf_snapshot_schedule_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    name: Schedule_A
    time_interval_days: 1
    starting_date: 2016--12--01T00:00:00Z
    volumes: 7

- name: Update Snapshot schedule
  sf_snapshot_schedule_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: present
    schedule_id: 6
    recurring: True
    snapshot_name: AnsibleSnapshots

- name: Delete Snapshot schedule
  sf_snapshot_schedule_manager:
    hostname: "{{ solidfire_hostname }}"
    username: "{{ solidfire_username }}"
    password: "{{ solidfire_password }}"
    state: absent
    schedule_id: 6

Return Values

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

name description returned type sample
schedule_id
Schedule ID of the newly created schedule
success string

Notes

Note

  • The modules prefixed with sf\_ are built to support the SolidFire storage platform.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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

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