community.general.netapp_e_snapshot_group (0.1.1) — module

NetApp E-Series manage snapshot groups

Authors: Kevin Hulquest (@hulquest)

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Create, update, delete snapshot groups for NetApp E-series storage arrays

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - name: Configure Snapshot group
      netapp_e_snapshot_group:
        ssid: "{{ ssid }}"
        api_url: "{{ netapp_api_url }}"
        api_username: "{{ netapp_api_username }}"
        api_password: "{{ netapp_api_password }}"
        validate_certs: "{{ netapp_api_validate_certs }}"
        base_volume_name: SSGroup_test
        name=: OOSS_Group
        repo_pct: 20
        warning_threshold: 85
        delete_limit: 30
        full_policy: purgepit
        storage_pool_name: Disk_Pool_1
        rollback_priority: medium

Inputs

    
name:
    description:
    - The name to give the snapshot group
    required: true

state:
    choices:
    - present
    - absent
    description:
    - Whether to ensure the group is present or absent.
    required: true

api_url:
    description:
    - The url to the SANtricity WebServices Proxy or embedded REST API.
    required: true

repo_pct:
    default: 20
    description:
    - The size of the repository in relation to the size of the base volume
    required: false

full_policy:
    choices:
    - purgepit
    - unknown
    - failbasewrites
    - __UNDEFINED
    default: purgepit
    description:
    - The behavior on when the data repository becomes full.
    - This value is overridden by consistency group setting if this snapshot group is
      associated with a consistency group
    required: false

api_password:
    description:
    - The password to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

api_username:
    description:
    - The username to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

delete_limit:
    default: 30
    description:
    - The automatic deletion indicator.
    - If non-zero, the oldest snapshot image will be automatically deleted when creating
      a new snapshot image to keep the total number of snapshot images limited to the
      number specified.
    - This value is overridden by the consistency group setting if this snapshot group
      is associated with a consistency group.
    required: false

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false
    type: bool

base_volume_name:
    description:
    - The name of the base volume or thin volume to use as the base for the new snapshot
      group.
    - If a snapshot group with an identical C(name) already exists but with a different
      base volume an error will be returned.
    required: true

rollback_priority:
    choices:
    - highest
    - high
    - medium
    - low
    - lowest
    - __UNDEFINED
    default: medium
    description:
    - The importance of the rollback operation.
    - This value is overridden by consistency group setting if this snapshot group is
      associated with a consistency group
    required: false

storage_pool_name:
    description:
    - The name of the storage pool on which to allocate the repository volume.
    required: true

warning_threshold:
    default: 80
    description:
    - The repository utilization warning threshold, as a percentage of the repository
      volume capacity.
    required: false

Outputs

msg:
  description: Success message
  returned: success
  sample: json facts for newly created snapshot group.
  type: str