na_ontap_qos_adaptive_policy_group – NetApp ONTAP Adaptive Quality of Service policy group

From Get docs
Ansible/docs/2.9/modules/na ontap qos adaptive policy group module


na_ontap_qos_adaptive_policy_group – NetApp ONTAP Adaptive Quality of Service policy group

New in version 2.9.


Synopsis

  • Create, destroy, modify, or rename an Adaptive QoS policy group on NetApp ONTAP. Module is based on the standard QoS policy group module.

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

absolute_min_iops

string

Absolute minimum IOPS defined by this policy.

expected_iops

string

Minimum expected IOPS defined by this policy.

force

boolean

  • no

  • yes

Setting to 'true' forces the deletion of the workloads associated with the policy group along with the policy group.

from_name

string

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

  • no

  • yes

Enable and disable https

name

string / required

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

peak_iops

string

Maximum possible IOPS per allocated or used TB|GB.

peak_iops_allocation

string

  • allocated_space
  • used_space

Whether peak_iops is specified by allocated or used space.

state

string

  • present

  • absent

Whether the specified policy group should exist or not.

use_rest

string

  • 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

  • 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 adaptive qos policy group
  na_ontap_qos_adaptive_policy_group:
    state: present
    name: aq_policy_1
    vserver: policy_vserver
    absolute_min_iops: 70IOPS
    expected_iops: 100IOPS/TB
    peak_iops: 250IOPS/TB
    peak_iops_allocation: allocated_space
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

- name: modify adaptive qos policy group expected iops
  na_ontap_qos_adaptive_policy_group:
    state: present
    name: aq_policy_1
    vserver: policy_vserver
    absolute_min_iops: 70IOPS
    expected_iops: 125IOPS/TB
    peak_iops: 250IOPS/TB
    peak_iops_allocation: allocated_space
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

- name: modify adaptive qos policy group peak iops allocation
  na_ontap_qos_adaptive_policy_group:
    state: present
    name: aq_policy_1
    vserver: policy_vserver
    absolute_min_iops: 70IOPS
    expected_iops: 125IOPS/TB
    peak_iops: 250IOPS/TB
    peak_iops_allocation: used_space
    hostname: 10.193.78.30
    username: admin
    password: netapp1!

- name: delete qos policy group
  na_ontap_qos_adaptive_policy_group:
    state: absent
    name: aq_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.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/na_ontap_qos_adaptive_policy_group_module.html