netapp.ontap.na_ontap_volume_snaplock module – NetApp ONTAP manage volume snaplock retention.
Note
This module is part of the netapp.ontap collection (version 21.24.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp.ontap.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp.ontap.na_ontap_volume_snaplock.
New in netapp.ontap 20.2.0
Synopsis
Modifies the snaplock retention of volumes on NetApp ONTAP.
Requirements
The below requirements are needed on the host that executes this module.
Ansible 2.9 or later - 2.12 or later is recommended.
Python3 - 3.9 or later is recommended.
When using ZAPI, netapp-lib 2018.11.13 or later (install using ‘pip install netapp-lib’), netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues
a physical or virtual clustered Data ONTAP system, the modules support Data ONTAP 9.1 and onward, REST support requires ONTAP 9.6 or later
Parameters
Parameter |
Comments |
|---|---|
Specifies the autocommit-period for the snaplock volume. The format is “<number> <units>” for example “8 hours”, the following units are valid seconds minutes hours days months years |
|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Specifies the default retention period that will be applied. The format is “<number> <units>” for example “10 days”, the following units are valid seconds minutes hours days months years If this option is specified as “max”, then maximum_retention_period will be used as the default retention period. |
|
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. |
|
Override the cluster ONTAP version when using REST. The behavior is undefined if the version does not match the target cluster. This is provided as a work-around when the cluster version cannot be read because of permission issues. See https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. This should be in the form 9.10 or 9.10.1 with each element being an integer number. When Ignored with ZAPI. |
|
The hostname or IP address of the ONTAP instance. |
|
Override the default port (80 or 443) with this port |
|
Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. Choices:
|
|
Specifies if the volume append mode must be enabled or disabled. It can be modified only when the volume is not mounted and does not have any data or Snapshot copy. Volume append mode is not supported on SnapLock audit log volumes. When it is enabled, all files created with write permissions on the volume will be WORM appendable files by default. All WORM appendable files not modified for a period greater than the autocommit period of the volume are also committed to WORM read-only state. Choices:
|
|
path to SSL client key file. |
|
Specifies the allowed maximum retention period that will be applied. The format is “<number> <units>” for example “2 years”, the following units are valid seconds minutes hours days months years |
|
Specifies the allowed minimum retention period that will be applied. The format is “<number> <units>” for example “1 days”, the following units are valid seconds minutes hours days months years |
|
The name of the volume to manage. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Whether to use REST or ZAPI. always – will always use the REST API if the module supports REST. A warning is issued if the module does not support REST. An error is issued if a module option is not supported in REST. never – will always use ZAPI if the module supports ZAPI. An error may be issued if a REST option is not supported in ZAPI. auto – will try to use the REST API if the module supports REST and modules options are supported. Reverts to ZAPI otherwise. Default: |
|
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/. Two authentication methods are supported
To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. |
|
If set to This should only set to Choices:
|
|
Name of the vserver to use. |
Notes
Note
supports ZAPI only.
for REST, snaplock is supported in na_ontap_volume starting with 21.18.0.
The modules prefixed with na_ontap are built to support the ONTAP storage platform.
https is enabled by default and recommended. To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Examples
- name: Set volume snaplock
na_ontap_volume_snaplock:
vserver: svm
name: ansibleVolume
default_retention_period: "5 days"
minimum_retention_period: "0 years"
maximum_retention_period: "10 days"
is_volume_append_mode_enabled: False
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"