netapp_eseries.santricity.netapp_e_snapshot_group – NetApp E-Series manage snapshot groups

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.1.0).

To install it use: ansible-galaxy collection install netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_snapshot_group.

New in version 2.2: of netapp_eseries.santricity

Synopsis
Parameters
Examples
Return Values

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
api_password string / required		The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url string / required		The url to the SANtricity WebServices Proxy or embedded REST API.
api_username string / required		The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
base_volume_name string / required		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 integer	Default: 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 string	unknown failbasewrites purgepit ←	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 string / required		The name to give the snapshot group
repo_pct integer	Default: 20	The size of the repository in relation to the size of the base volume
rollback_priority string	highest high medium ← low lowest	The importance of the rollback operation. This value is overridden by consistency group setting if this snapshot group is associated with a consistency group
ssid string		Storage system identifier
state string / required	present absent	Whether to ensure the group is present or absent.
storage_pool_name string / required		The name of the storage pool on which to allocate the repository volume.
validate_certs boolean	no yes ←	Should https certificates be validated?
warning_threshold integer	Default: 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, the following are the fields unique to this module:

Key	Returned	Description
msg string	success	Success message Sample: json facts for newly created snapshot group.

Authors

Kevin Hulquest (@hulquest)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp_eseries/santricity/netapp_e_snapshot_group_module.html