na_ontap_qos_policy_group – NetApp ONTAP manage policy group in Quality of Service

New in version 2.8.

Synopsis

  • Create, destroy, modify, or rename QoS policy group on NetApp ONTAP.

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
  • Ansible 2.6
  • 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’
  • 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
force
boolean
    Choices:
  • no ←
  • yes
Setting to 'true' forces the deletion of the workloads associated with the policy group along with the policy group.
from_name
-
Name of the existing policy group to be renamed to name.
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
max_throughput
-
Maximum throughput defined by this policy.
min_throughput
-
Minimum throughput defined by this policy.
name
-
The name of the policy group to manage.
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
state
-
    Choices:
  • present ←
  • absent
Whether the specified policy group should exist or not.
use_rest
string
    Choices:
  • Never
  • Always
  • 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 / required
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/.

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
-
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 qos policy group
  na_ontap_qos_policy_group:
    state: present
    name: policy_1
    vserver: policy_vserver
    max_throughput: 800KB/s,800iops
    min_throughput: 100iops
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

- name: modify qos policy group max throughput
  na_ontap_qos_policy_group:
    state: present
    name: policy_1
    vserver: policy_vserver
    max_throughput: 900KB/s,800iops
    min_throughput: 100iops
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

- name: delete qos policy group
  na_ontap_qos_policy_group:
    state: absent
    name: policy_1
    vserver: policy_vserver
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

Status

Authors

Hint

If you notice any issues in this documentation, you can edit this document to improve it.