community.general.sf_snapshot_schedule_manager (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Create, destroy, or update accounts on SolidFire

Requirements

• The modules were developed with SolidFire 10.1
• solidfire-sdk-python (1.1.0.92) or greater. Install using 'pip install solidfire-sdk-python'

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

   - name: Create Snapshot schedule
     community.general.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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - Name for the snapshot schedule.
    required: true

state:
    choices:
    - present
    - absent
    description:
    - Whether the specified schedule should exist or not.
    required: true

paused:
    description:
    - Pause / Resume a schedule.
    required: false

volumes:
    description:
    - 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 C(state=present)
    required: false

hostname:
    description:
    - The hostname or IP address of the SolidFire cluster.
    required: true

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    required: true

username:
    aliases:
    - user
    description:
    - Please ensure that the user has the adequate permissions. For more information,
      please read the official documentation U(https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US).
    required: true

recurring:
    description:
    - Should the schedule recur?
    required: false

retention:
    description:
    - Retention period for the snapshot.
    - Format is 'HH:mm:ss'.
    required: false

schedule_id:
    description:
    - The schedule ID for the schedule that you want to update or delete.
    required: false

snapshot_name:
    description:
    - Name for the created snapshots.
    required: false

starting_date:
    description:
    - Starting date for the schedule.
    - Required when C(state=present).
    - Please use two '-' in the above format, or you may see an error- TypeError, is not
      JSON serializable description.
    - 'Format: C(2016--12--01T00:00:00Z)'
    required: false

time_interval_days:
    default: 1
    description: Time interval in days.
    required: false

time_interval_hours:
    default: 0
    description: Time interval in hours.
    required: false

time_interval_minutes:
    default: 0
    description: Time interval in minutes.
    required: false

Outputs

schedule_id:
  description: Schedule ID of the newly created schedule
  returned: success
  type: str