Try SpotterNetApp ONTAP manage Snapshot Policy
| "added in version" 2.8 of ansible.builtin"
Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
preview | supported by community
pipInstall with pip install ansible==2.9.26
Create/Modify/Delete ONTAP snapshot policies
- 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: Create Snapshot policy with multiple schedules
na_ontap_snapshot_policy:
state: present
name: ansible2
schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min']
count: [1, 2, 3, 4, 5]
enabled: True
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
https: False
- name: Create Snapshot policy owned by a vserver
na_ontap_snapshot_policy:
state: present
name: ansible3
vserver: ansible
schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min']
count: [1, 2, 3, 4, 5]
snapmirror_label: ['hourly', 'daily', 'weekly', 'monthly', '']
enabled: True
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
hostname: "{{ netapp_hostname }}"
https: False
- name: Modify Snapshot policy with multiple schedules
na_ontap_snapshot_policy:
state: present
name: ansible2
schedule: ['daily', 'weekly']
count: [20, 30]
snapmirror_label: ['daily', 'weekly']
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
name:
description: Name of the snapshot policy to be managed. The maximum string length
is 256 characters.
required: true
count:
description: Retention count for the snapshots created by the schedule.
type: list
https:
default: false
description:
- Enable and disable https.
- Ignored when using REST as only https is supported.
- Ignored when using SSL certificate authentication as it requires SSL.
type: bool
state:
choices:
- present
- absent
default: present
description:
- If you want to create, modify or delete a snapshot policy.
ontapi:
description:
- The ontap api version to use
type: int
comment:
description: A human readable comment attached with the snapshot. The size of the
comment can be at most 255 characters.
enabled:
description:
- Status of the snapshot policy indicating whether the policy will be enabled or disabled.
type: bool
vserver:
description:
- The name of the vserver to use. In a multi-tenanted environment, assigning a Snapshot
Policy to a vserver will restrict its use to that vserver.
required: false
version_added: '2.9'
version_added_collection: ansible.builtin
hostname:
description:
- The hostname or IP address of the ONTAP instance.
required: true
type: str
password:
aliases:
- pass
description:
- Password for the specified user.
type: str
schedule:
description:
- Schedule to be added inside the policy.
type: list
use_rest:
choices:
- Never
- Always
- Auto
default: Auto
description:
- REST API if supported by the target system for all the resources and attributes
the module requires. Otherwise will revert to ZAPI.
- Always -- will always use the REST API
- Never -- will always use the ZAPI
- Auto -- will try to use the REST Api
type: str
username:
aliases:
- user
description:
- 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 U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/).
- Two authentication methods are supported
- 1. basic authentication, using username and password,
- 2. SSL certificate authentication, using a ssl client cert file, and optionally
a private key file.
- To use a certificate, the certificate must have been installed in the ONTAP cluster,
and cert authentication must have been enabled.
type: str
http_port:
description:
- Override the default port (80 or 443) with this port
type: int
key_filepath:
description:
- path to SSL client key file.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
cert_filepath:
description:
- path to SSL client cert file (.pem).
- not supported with python 2.6.
type: str
version_added: 20.6.0
version_added_collection: netapp.ontap
feature_flags:
description:
- Enable or disable a new feature.
- This can be used to enable an experimental feature or disable a new feature that
breaks backward compatibility.
- Supported keys and values are subject to change without notice. Unknown keys are
ignored.
type: dict
version_added: 20.5.0
version_added_collection: netapp.ontap
validate_certs:
default: true
description:
- If set to C(no), the SSL certificates will not be validated.
- This should only set to C(False) used on personally controlled sites using self-signed
certificates.
type: bool
snapmirror_label:
description:
- SnapMirror label assigned to each schedule inside the policy. Use an empty string
('') for no label.
required: false
type: list
version_added: '2.9'
version_added_collection: ansible.builtin