netapp.ontap.na_ontap_qos_policy_group 模块 – NetApp ONTAP 服务质量 (QoS) 策略组管理。
注意
此模块是 netapp.ontap 集合 (版本 22.13.0) 的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install netapp.ontap
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:netapp.ontap.na_ontap_qos_policy_group
。
netapp.ontap 2.8.0 中的新功能
概要
在 NetApp ONTAP 上创建、销毁、修改或重命名 QoS 策略组。
使用 ZAPI,仅支持固定的 QoS 策略组。
使用 REST,支持固定和自适应的 QoS 策略组。
要求
以下要求需要在执行此模块的主机上满足。
Ansible 2.9 或更高版本 - 推荐 2.12 或更高版本。
Python3 - 推荐 3.9 或更高版本。
使用 ZAPI 时,netapp-lib 2018.11.13 或更高版本(使用 'pip install netapp-lib' 安装),强烈建议使用 netapp-lib 2020.3.12,因为它为连接问题提供了更好的错误报告。
物理或虚拟集群 Data ONTAP 系统,该模块支持 Data ONTAP 9.1 及更高版本,REST 支持需要 ONTAP 9.6 或更高版本。
参数
参数 |
注释 |
---|---|
自适应 QoS 策略组定义可测量的服务级别目标 (SLO),这些目标会根据存储对象已用空间和存储对象已分配空间进行调整。 仅支持 REST。 |
|
指定当 expected_iops 小于此值时用作覆盖的绝对最小 IOPS。 在非 AFF 平台上或设置 FabricPool 分层策略时,不保证这些下限。 |
|
指定块大小。 需要 ONTAP 9.10.1 或更高版本。 选项
|
|
预期 IOPS。指定基于存储对象已分配大小,每个 TB 分配的最小预期 IOPS。 在非 AFF 平台上或设置 FabricPool 分层策略时,不保证这些下限。 |
|
指定用于计算每 TB 预期 IOPS 的大小。 仅支持 REST;需要 ONTAP 9.10.1 或更高版本。 选项
|
|
峰值 IOPS。指定基于存储对象已分配大小或存储对象已用大小,每个 TB 分配的最大可能 IOPS。 |
|
指定用于计算每 TB 峰值 IOPS 的大小。 仅支持 REST;需要 ONTAP 9.10.1 或更高版本。 选项
|
|
SSL 客户端证书文件 (.pem) 的路径。 不支持 python 2.6。 |
|
启用或禁用新功能。 这可以用于启用实验性功能或禁用破坏向后兼容性的新功能。 支持的键和值可能会在没有通知的情况下更改。未知的键将被忽略。 |
|
设置此策略定义的最小和最大吞吐量。 仅支持 REST。 创建 qos_policy 时,需要其中一个吞吐量选项。 |
|
策略组的 SLO 是在工作负载之间共享,还是将 SLO 分别应用于每个工作负载。 如果在创建 qos 策略时未使用,则默认值为 False。 选项
|
|
此策略定义的最大吞吐量。以 IOPS 为单位指定。 0 表示不强制执行最大吞吐量。 |
|
此策略定义的最大吞吐量。以 Mbps 为单位指定。 0 表示不强制执行最大吞吐量。 |
|
此策略定义的最小吞吐量。以 IOPS 为单位指定。 0 表示不强制执行最小吞吐量。 在非 AFF 平台上或设置 FabricPool 分层策略时,不保证这些下限。 |
|
此策略定义的最小吞吐量。以 Mbps 为单位指定。 0 表示不强制执行最小吞吐量。 需要 ONTAP 9.8 或更高版本以及 REST 支持。 |
|
设置为 'true' 会强制删除与策略组关联的工作负载以及策略组。 不支持 REST。 选项
|
|
使用 REST 时覆盖集群 ONTAP 版本。 如果版本与目标集群不匹配,则行为未定义。 当由于权限问题无法读取集群版本时,这提供了一种解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。 格式应为 9.10 或 9.10.1,其中每个元素都是整数。 当 使用 ZAPI 时将被忽略。 |
|
要重命名为 name 的现有策略组的名称。 |
|
ONTAP 实例的主机名或 IP 地址。 |
|
使用此端口覆盖默认端口(80 或 443)。 |
|
启用和禁用 https。 使用 REST 时将被忽略,因为仅支持 https。 使用 SSL 证书身份验证时将被忽略,因为它需要 SSL。 选项
|
|
策略组的 SLO 是在工作负载之间共享,还是将 SLO 分别应用于每个工作负载。 REST 不支持,请使用 选项
|
|
SSL 客户端密钥文件的路径。 |
|
此策略定义的最大吞吐量。 REST 不支持,请使用 |
|
此策略定义的最小吞吐量。 REST 不支持,请使用 |
|
要管理的策略组的名称。 |
|
要使用的 ontap API 版本。 |
|
指定用户的密码。 |
|
指定的策略组是否应该存在。 选项
|
|
是否使用 REST 或 ZAPI。 always – 如果模块支持 REST API,则始终使用 REST API。如果模块不支持 REST,则会发出警告。如果 REST 不支持模块选项,则会发出错误。 never – 如果模块支持 ZAPI,则始终使用 ZAPI。如果 ZAPI 不支持 REST 选项,则可能会发出错误。 auto – 如果模块支持 REST API 且支持模块选项,则尝试使用 REST API。否则,恢复为 ZAPI。 默认: |
|
这可以是集群范围或 SVM 范围的帐户,具体取决于是否需要集群级别或 SVM 级别的 API。 有关更多信息,请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。 支持两种身份验证方法
要使用证书,必须已在 ONTAP 集群中安装证书,并且必须已启用证书身份验证。 |
|
如果设置为 仅应在个人控制的使用自签名证书的站点上将此设置为 选项
|
|
要使用的 vserver 的名称。 |
说明
注意
以 na_ontap 为前缀的模块旨在支持 ONTAP 存储平台。
默认启用并建议使用 https。要在集群上启用 http,您必须运行以下命令 ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
示例
- name: create qos policy group in ZAPI.
netapp.ontap.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!
use_rest: never
- name: modify qos policy group max throughput in ZAPI.
netapp.ontap.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!
use_rest: never
- name: delete qos policy group
netapp.ontap.na_ontap_qos_policy_group:
state: absent
name: policy_1
vserver: policy_vserver
hostname: 10.193.78.30
username: admin
password: netapp1!
- name: create qos policy group in REST.
netapp.ontap.na_ontap_qos_policy_group:
state: present
name: policy_1
vserver: policy_vserver
hostname: 10.193.78.30
username: admin
password: netapp1!
use_rest: always
fixed_qos_options:
max_throughput_iops: 800
max_throughput_mbps: 200
min_throughput_iops: 500
min_throughput_mbps: 100
capacity_shared: True
- name: modify qos policy max_throughput in REST.
netapp.ontap.na_ontap_qos_policy_group:
state: present
name: policy_1
vserver: policy_vserver
hostname: 10.193.78.30
username: admin
password: netapp1!
use_rest: always
fixed_qos_options:
max_throughput_iops: 1000
max_throughput_mbps: 300
- name: create adaptive qos policy group in REST.
netapp.ontap.na_ontap_qos_policy_group:
state: present
name: adaptive_policy
vserver: policy_vserver
hostname: 10.193.78.30
username: admin
password: netapp1!
use_rest: always
adaptive_qos_options:
absolute_min_iops: 100
expected_iops: 200
peak_iops: 500
- name: modify adaptive qos policy group in REST.
netapp.ontap.na_ontap_qos_policy_group:
state: present
name: adaptive_policy
vserver: policy_vserver
hostname: 10.193.78.30
username: admin
password: netapp1!
use_rest: always
adaptive_qos_options:
expected_iops_allocation: used_space
peak_iops_allocation: allocated_space