na_ontap_snapshot_policy – NetApp ONTAP manage Snapshot Policy

na_ontap_snapshot_policy – NetApp ONTAP manage Snapshot Policy

New in version 2.8.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Status

Synopsis

• Create/Delete ONTAP snapshot policies

Requirements

The below requirements are needed on the host that executes this module.

• A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
• Ansible 2.6
• Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
• Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
• To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter	Choices/Defaults	Comments
comment -		A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters.
count integer		Retention count for the snapshots created by the schedule.
enabled boolean	no yes	Status of the snapshot policy indicating whether the policy will be enabled or disabled.
hostname string / required		The hostname or IP address of the ONTAP instance.
http_port integer		Override the default port (80 or 443) with this port
https boolean	no ← yes	Enable and disable https
name - / required		Name of the snapshot policy to be managed. The maximum string length is 256 characters.
ontapi integer		The ontap api version to use
password string / required		Password for the specified user. aliases: pass
schedule -		schedule to be added inside the policy.
state -	present ← absent	If you want to create or delete a snapshot policy.
username string / required		This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. aliases: user
validate_certs boolean	no yes ←	If set to no, the SSL certificates will not be validated. This should only set to False used on personally controlled sites using self-signed certificates.

Notes

Note

• The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name: create Snapshot policy
  na_ontap_snapshot_policy:
    state: present
    name: ansible2
    schedule: hourly
    count: 150
    enabled: True
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"
    https: False

- name: delete Snapshot policy
  na_ontap_snapshot_policy:
    state: absent
    name: ansible2
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"
    https: False

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• NetApp Ansible Team (@carchi8py) <[email protected]>

Hint

If you notice any issues in this documentation you can edit this document to improve it.

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