netapp.ontap.na_ontap_volume_efficiency module – NetApp ONTAP enables, disables or modifies volume efficiency
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_efficiency.
New in netapp.ontap 21.2.0
Synopsis
Enable, modify or disable volume efficiency
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 |
|---|---|
path to SSL client cert file (.pem). not supported with python 2.6. |
|
Specifies if compression is to be enabled. Choices:
|
|
Specifies if cross volume background deduplication is to be enabled, this can only be enabled when inline deduplication is enabled. Choices:
|
|
Specifies if in-line cross volume inline deduplication is to be enabled, this can only be enabled when inline deduplication is enabled. Choices:
|
|
Specifies if compaction is to be enabled. Choices:
|
|
Specifies if in-line compression is to be enabled. Choices:
|
|
Specifies if in-line deduplication is to be enabled, only supported on AFF systems or hybrid aggregates. Choices:
|
|
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:
|
|
path to SSL client key file. |
|
The ontap api version to use |
|
Password for the specified user. |
|
Specifies the path for the volume. |
|
Specifies the storage efficiency policy to use. By default, the following names are available ‘auto’, ‘default’, ‘inline-only’, ‘-‘. |
|
Specifies the storage efficiency schedule. |
|
Specifies the scanner to scan the entire and generate fingerprint database without attempting the sharing. Choices:
|
|
Specifies the scanner to delete existing checkpoint and start the operation from the begining. Choices:
|
|
Specifies the QoS policy for the operation. Choices:
|
|
Specifies the operation to queue if an exisitng operation is already running on the volume and in the fingerprint verification phase. Choices:
|
|
Specifies the scanner to scan the entire volume without applying share block optimization. Choices:
|
|
Specifies the operation to scan the file system to process all the existing data. Choices:
|
|
Whether the specified volume efficiency should be enabled or not. Choices:
|
|
Specifies that all running and queued operations to be stopped. Choices:
|
|
Storage efficiency mode used by volume. This parameter is only supported on AFF platforms. Requires ONTAP 9.10.1 or later. Choices:
|
|
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:
|
|
Start or Stop a volume efficiency operation on a given volume path. Choices:
|
|
Specifies the vserver for the volume. |
Notes
Note
supports ZAPI and REST. REST requires ONTAP 9.6 or later.
supports check mode.
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: Enable Volume efficiency
na_ontap_volume_efficiency:
state: present
vserver: "TESTSVM"
path: "/vol/test_sis"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Disable Volume efficiency test
na_ontap_volume_efficiency:
state: absent
vserver: "TESTSVM"
path: "/vol/test_sis"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Modify storage efficiency schedule
na_ontap_volume_efficiency:
state: present
vserver: "TESTSVM"
path: "/vol/test_sis"
schedule: "mon-sun@0,1,23"
enable_compression: "True"
enable_inline_compression: "True"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Start volume efficiency
na_ontap_volume_efficiency:
state: present
vserver: "TESTSVM"
volume_efficiency: "start"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false
- name: Stop volume efficiency
na_ontap_volume_efficiency:
state: present
vserver: "TESTSVM"
volume_efficiency: "stop"
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
https: true
validate_certs: false