netapp.ontap.na_ontap_volume_efficiency – NetApp ONTAP enables, disables or modifies volume efficiency

Note

This plugin is part of the netapp.ontap collection (version 21.10.0).

To install it use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_volume_efficiency.

New in version 21.2.0: of netapp.ontap

Synopsis

  • Enable, modify or disable volume efficiency

Requirements

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

  • Ansible 2.9

  • Python3 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.

  • 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
cert_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client cert file (.pem).
not supported with python 2.6.
enable_compression
boolean
    Choices:
  • no
  • yes
Specifies if compression is to be enabled.
enable_cross_volume_background_dedupe
boolean
    Choices:
  • no
  • yes
Specifies if cross volume background deduplication is to be enabled, this can only be enabled when inline deduplication is enabled.
enable_cross_volume_inline_dedupe
boolean
    Choices:
  • no
  • yes
Specifies if in-line cross volume inline deduplication is to be enabled, this can only be enabled when inline deduplication is enabled.
enable_data_compaction
boolean
    Choices:
  • no
  • yes
Specifies if compaction is to be enabled.
enable_inline_compression
boolean
    Choices:
  • no
  • yes
Specifies if in-line compression is to be enabled.
enable_inline_dedupe
boolean
    Choices:
  • no
  • yes
Specifies if in-line deduplication is to be enabled, only supported on AFF systems or hybrid aggregates.
feature_flags
dictionary
added in 20.5.0 of netapp.ontap
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.
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
    Choices:
  • no ←
  • yes
Enable and disable https.
Ignored when using REST as only https is supported.
Ignored when using SSL certificate authentication as it requires SSL.
key_filepath
string
added in 20.6.0 of netapp.ontap
path to SSL client key file.
ontapi
integer
The ontap api version to use
password
string
Password for the specified user.

aliases: pass
path
string / required
Specifies the path for the volume.
policy
string
    Choices:
  • auto
  • default
  • inline-only
  • -
Specifies the storage efficiency policy to use, only supported on AFF systems.
schedule
string
Specifies the storage efficiency schedule.
start_ve_build_metadata
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies the scanner to scan the entire and generate fingerprint database without attempting the sharing.
start_ve_delete_checkpoint
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies the scanner to delete existing checkpoint and start the operation from the begining.
start_ve_qos_policy
string
added in 21.4.0 of netapp.ontap
    Choices:
  • background
  • best-effort ←
Specifies the QoS policy for the operation.
start_ve_queue_operation
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies the operation to queue if an exisitng operation is already running on the volume and in the fingerprint verification phase.
start_ve_scan_all
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies the scanner to scan the entire volume without applying share block optimization.
start_ve_scan_old_data
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies the operation to scan the file system to process all the existing data.
state
string
    Choices:
  • present ←
  • absent
Whether the specified volume efficiency should be enabled or not.
stop_ve_all_operations
boolean
added in 21.4.0 of netapp.ontap
    Choices:
  • no
  • yes
Specifies that all running and queued operations to be stopped.
use_rest
string
Default:
"auto"
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
username
string
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
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.

aliases: user
validate_certs
boolean
    Choices:
  • 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.
volume_efficiency
string
added in 21.4.0 of netapp.ontap
    Choices:
  • start
  • stop
Start or Stop a volume efficiency operation on a given volume path.
vserver
string / required
Specifies the vserver for the volume.

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

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 policy
  na_ontap_volume_efficiency:
    state: present
    vserver: "TESTSVM"
    path: "/vol/test_sis"
    schedule: "[email protected],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

Authors