Docs4dev
Docs
ansible / latest / collections / netapp / elementsw / na_elementsw_qos_policy_module.html

netapp.elementsw.na_elementsw_qos_policy – NetApp Element Software create/modify/rename/delete QOS Policy

Note

This plugin is part of the netapp.elementsw collection (version 21.6.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.elementsw.

To use it in a playbook, specify: netapp.elementsw.na_elementsw_qos_policy.

New in version 20.9.0: of netapp.elementsw

Synopsis

  • Create, modify, rename, or delete QOS policy on Element Software Cluster.

Requirements

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

  • The modules were developed with SolidFire 10.1
  • solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’

Parameters

Parameter Choices/Defaults Comments
debug
boolean
added in 21.3.0 of netapp.elementsw
    Choices:
  • no ←
  • yes
report additional information when set to true.
from_name
string
Name or id for the QOS policy to be renamed.
hostname
string / required
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
name
string / required
Name or id for the QOS policy.
password
string / required
Password for the specified user.

aliases: pass
qos
dictionary
The quality of service (QQOS) for the policy.
Required for create
Supported keys are minIOPS, maxIOPS, burstIOPS
burstIOPS
integer
added in 21.3.0 of netapp.elementsw
The maximum number of IOPS allowed over a short period of time for the volume.
maxIOPS
integer
added in 21.3.0 of netapp.elementsw
The maximum number of IOPS allowed for the volume.
minIOPS
integer
added in 21.3.0 of netapp.elementsw
The minimum number of IOPS guaranteed for the volume.
state
string
    Choices:
  • present ←
  • absent
Whether the specified QOS policy should exist or not.
username
string / required
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.

aliases: user

Notes

Note

  • The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.

Examples

- name: Add QOS Policy
  na_elementsw_qos_policy:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: present
    name: gold
    qos: {minIOPS: 1000, maxIOPS: 20000, burstIOPS: 50000}

- name: Modify QOS Policy
  na_elementsw_qos_policy:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    name: gold
    qos: {minIOPS: 100, maxIOPS: 5000, burstIOPS: 20000}

- name: Rename QOS Policy
  na_elementsw_qos_policy:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    from_name: gold
    name: silver

- name: Remove QOS Policy
  na_elementsw_qos_policy:
    hostname: "{{ elementsw_hostname }}"
    username: "{{ elementsw_username }}"
    password: "{{ elementsw_password }}"
    state: absent
    name: silver

Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/elementsw/na_elementsw_qos_policy_module.html