W3cubDocs

/Ansible

netapp_e_snapshot_group - Manage snapshot groups

New in version 2.2.

Synopsis

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

Options

parameter required default choices comments
api_password
 yes
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url
 yes
The url to the SANtricity WebServices Proxy or embedded REST API.
api_username
 yes
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
base_volume_name
 yes
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 name already exists but with a different base volume an error will be returned.
delete_limit
 no 30
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.
full_policy
 no purgepit
  • purgepit
  • unknown
  • failbasewrites
  • __UNDEFINED
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
name
 yes
The name to give the snapshot group
repo_pct
 no 20
The size of the repository in relation to the size of the base volume
rollback_priority
 no medium
  • highest
  • high
  • medium
  • low
  • lowest
  • __UNDEFINED
The importance of the rollback operation.
This value is overridden by consistency group setting if this snapshot group is associated with a consistency group
state
 yes
  • present
  • absent
Whether to ensure the group is present or absent.
storage_pool_name
 yes
The name of the storage pool on which to allocate the repository volume.
validate_certs
 no True
Should https certificates be validated?
warning_threshold
 no 80
The repository utilization warning threshold, as a percentage of the repository volume capacity.

Examples

- 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

Return Values

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

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

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–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/netapp_e_snapshot_group_module.html