ansible.builtin.na_ontap_qos_adaptive_policy_group (v2.9.26) — module

NetApp ONTAP Adaptive Quality of Service policy group.

| "added in version" 2.9 of ansible.builtin"

Authors: NetApp Ansible Team (@joshedmonds) <ng-ansibleteam@netapp.com>

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.26

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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!
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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!
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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!
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
    - 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!

Inputs

    
name:
    description:
    - The name of the policy group to manage.
    required: true
    type: str

force:
    default: false
    description:
    - Setting to 'true' forces the deletion of the workloads associated with the policy
      group along with the policy group.
    type: bool

https:
    default: false
    description:
    - Enable and disable https.
    - Ignored when using REST as only https is supported.
    - Ignored when using SSL certificate authentication as it requires SSL.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified policy group should exist or not.
    type: str

ontapi:
    description:
    - The ontap api version to use
    type: int

vserver:
    description:
    - Name of the vserver to use.
    required: true
    type: str

hostname:
    description:
    - The hostname or IP address of the ONTAP instance.
    required: true
    type: str

password:
    aliases:
    - pass
    description:
    - Password for the specified user.
    type: str

use_rest:
    choices:
    - Never
    - Always
    - Auto
    default: Auto
    description:
    - 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
    type: str

username:
    aliases:
    - user
    description:
    - 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 U(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.
    type: str

from_name:
    description:
    - Name of the existing policy group to be renamed to name.
    type: str

http_port:
    description:
    - Override the default port (80 or 443) with this port
    type: int

peak_iops:
    description:
    - Maximum possible IOPS per allocated or used TB|GB.
    type: str

key_filepath:
    description:
    - path to SSL client key file.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

cert_filepath:
    description:
    - path to SSL client cert file (.pem).
    - not supported with python 2.6.
    type: str
    version_added: 20.6.0
    version_added_collection: netapp.ontap

expected_iops:
    description:
    - Minimum expected IOPS defined by this policy.
    type: str

feature_flags:
    description:
    - 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.
    type: dict
    version_added: 20.5.0
    version_added_collection: netapp.ontap

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(False) used on personally controlled sites using self-signed
      certificates.
    type: bool

absolute_min_iops:
    description:
    - Absolute minimum IOPS defined by this policy.
    type: str

peak_iops_allocation:
    choices:
    - allocated_space
    - used_space
    default: used_space
    description:
    - Whether peak_iops is specified by allocated or used space.
    type: str