W3cubDocs

/Ansible 2.10

netapp.ontap.na_ontap_efficiency_policy – NetApp ONTAP manage efficiency policies (sis policies)

Note

This plugin is part of the netapp.ontap collection.

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

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

New in version 2.9.0: of netapp.ontap

Synopsis

  • Create/Modify/Delete efficiency policies (sis 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.
  • REST support requires ONTAP 9.6 or later.
  • Ansible 2.6
  • Ansible 2.9 or later is strongly recommended as it enables the new collection delivery system.
  • 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’
  • netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.
  • 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.
changelog_threshold_percent
integer
added in 19.11.0 of netapp.ontap
Specifies the percentage at which the changelog will be processed for a threshold type of policy, tested once each hour.
comment
string
A brief description of the policy.
duration
string
The duration in hours for which the scheduled efficiency operation should run. After this time expires, the efficiency operation will be stopped even if the operation is incomplete. If '-' is specified as the duration, the efficiency operation will run till it completes. Otherwise, the duration has to be an integer greater than 0. By default, the operation runs till it completes.
enabled
boolean
    Choices:
  • no
  • yes
If the value is true, the efficiency policy is active in this cluster. If the value is false this policy will not be activated by the schedulers and hence will be inactive.
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
policy_name
string / required
the name of the efficiency policy
policy_type
string
    Choices:
  • threshold
  • scheduled
The policy type reflects the reason a volume using this policy will start processing a changelog.
(Changelog processing is identifying and eliminating duplicate blocks which were written since the changelog was last processed.)
threshold Changelog processing occurs once the changelog reaches a certain percent full.
scheduled Changelog processing will be triggered by time.
qos_policy
string
    Choices:
  • background
  • best_effort
QoS policy for the efficiency operation.
background efficiency operation will run in background with minimal or no impact on data serving client operations,
best-effort efficiency operations may have some impact on data serving client operations.
schedule
string
Cron type job schedule name. When the associated policy is set on a volume, the efficiency operation will be triggered for the volume on this schedule.
These schedules can be created using the na_ontap_job_schedule module
state
string
    Choices:
  • present ←
  • absent
Whether the specified efficiency policy should exist or not.
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.
vserver
string / required
Name of the vserver to use.

Notes

Note

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

Examples

- name: Create threshold efficiency policy
  na_ontap_efficiency_policy:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    vserver: ansible
    state: present
    policy_name: test
    comment: This policy is for x and y
    enabled: true
    policy_type: threshold
    qos_policy: background
    changelog_threshold_percent: 20

- name: Create efficiency Scheduled efficiency Policy
  na_ontap_efficiency_policy:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    vserver: ansible
    state: present
    policy_name: test2
    comment: This policy is for x and y
    enabled: true
    schedule: new_job_schedule
    duration: 1
    policy_type: scheduled
    qos_policy: background

Authors

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/ontap/na_ontap_efficiency_policy_module.html