netapp.ontap.na_ontap_qos_policy_group 模块 – NetApp ONTAP 服务质量策略组管理。

注意

此模块是 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 或更高版本。

参数

参数

注释

adaptive_qos_options

字典

netapp.ontap 21.19.0 中新增

自适应 QoS 策略组定义了可衡量的服务级别目标 (SLO),这些目标会根据存储对象已用空间和存储对象已分配空间进行调整。

仅支持 REST。

absolute_min_iops

整数 / 必需

指定用作覆盖的绝对最小 IOPS,当 expected_iops 小于此值时使用。

在非 AFF 平台上或设置 FabricPool 分层策略时,这些下限不能保证。

block_size

字符串

netapp.ontap 22.6.0 中新增

指定块大小。

需要 ONTAP 9.10.1 或更高版本。

选项

  • "any"

  • "4k"

  • "8k"

  • "16k"

  • "32k"

  • "64k"

  • "128k"

expected_iops

整数 / 必需

预期 IOPS。根据存储对象已分配大小指定每个 TB 已分配的最小预期 IOPS。

在非 AFF 平台上或设置 FabricPool 分层策略时,这些下限不能保证。

expected_iops_allocation

字符串

netapp.ontap 22.8.0 中新增

指定用于计算每 TB 预期 IOPS 的大小。

仅支持 REST;需要 ONTAP 9.10.1 或更高版本。

选项

  • "used_space"

  • "allocated_space"

peak_iops

整数 / 必需

峰值 IOPS。根据存储对象已分配大小或存储对象已用大小指定每个 TB 已分配的可能最大 IOPS。

peak_iops_allocation

字符串

netapp.ontap 22.8.0 中新增

指定用于计算每 TB 峰值 IOPS 的大小。

仅支持 REST;需要 ONTAP 9.10.1 或更高版本。

选项

  • "used_space"

  • "allocated_space"

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端证书文件 (.pem) 的路径。

python 2.6 不支持。

feature_flags

字典

netapp.ontap 20.5.0 中新增

启用或禁用新功能。

这可用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会随时更改,恕不另行通知。未知键将被忽略。

fixed_qos_options

字典

netapp.ontap 21.19.0 中新增

设置此策略定义的最小和最大吞吐量。

仅支持 REST。

创建 qos_policy 时需要一个吞吐量选项。

capacity_shared

布尔值

策略组的 SLO 是在工作负载之间共享,还是分别应用于每个工作负载。

如果未用于创建 qos 策略,则默认值为 False。

选项

  • false

  • true

max_throughput_iops

整数

此策略定义的最大吞吐量。以 IOPS 为单位指定。

0 表示不强制执行最大吞吐量。

max_throughput_mbps

整数

此策略定义的最大吞吐量。以 Mbps 为单位指定。

0 表示不强制执行最大吞吐量。

min_throughput_iops

整数

此策略定义的最小吞吐量。以 IOPS 为单位指定。

0 表示不强制执行最小吞吐量。

在非 AFF 平台上或设置 FabricPool 分层策略时,这些下限不能保证。

min_throughput_mbps

整数

此策略定义的最小吞吐量。以 Mbps 为单位指定。

0 表示不强制执行最小吞吐量。

需要 ONTAP 9.8 或更高版本,以及 REST 支持。

force

布尔值

设置为“true”将强制删除与策略组关联的工作负载以及策略组。

REST 不支持。

选项

  • false

  • true

force_ontap_version

字符串

netapp.ontap 21.23.0 中新增

使用REST时覆盖集群ONTAP版本。

如果版本与目标集群不匹配,则行为未定义。

这是在由于权限问题无法读取集群版本时的变通方法。请参阅https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues

这应采用9.10或9.10.1的形式,每个元素都是整数。

use_rest设置为auto时,这可能会根据版本和平台功能强制切换到ZAPI。

使用ZAPI时忽略。

from_name

字符串

要重命名为name的现有策略组的名称。

hostname

字符串 / 必需

ONTAP实例的主机名或IP地址。

http_port

整数

使用此端口覆盖默认端口(80或443)。

https

布尔值

启用和禁用https。

使用REST时忽略,因为只支持https。

使用SSL证书身份验证时忽略,因为它需要SSL。

选项

  • false ← (默认)

  • true

is_shared

布尔值

在netapp.ontap 20.12.0中添加。

策略组的 SLO 是在工作负载之间共享,还是分别应用于每个工作负载。

REST不支持,请使用fixed_qos_options

选项

  • false

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL客户端密钥文件的路径。

max_throughput

字符串

此策略定义的最大吞吐量。

REST不支持,请使用fixed_qos_options

min_throughput

字符串

此策略定义的最小吞吐量。

REST不支持,请使用fixed_qos_options

name

字符串 / 必需

要管理的策略组的名称。

ontapi

整数

要使用的ontap api版本。

password

别名:pass

字符串

指定用户的密码。

state

字符串

指定的策略组是否存在。

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用REST或ZAPI。

always – 如果模块支持REST,则始终使用REST API。如果模块不支持REST,则会发出警告。如果REST不支持模块选项,则会发出错误。

never – 如果模块支持ZAPI,则始终使用ZAPI。如果ZAPI不支持REST选项,则可能会发出错误。

auto – 如果模块支持REST并且支持模块选项,则尝试使用REST API。否则还原为ZAPI。

默认: "auto"

username

别名:user

字符串

这可以是集群范围或SVM范围的帐户,具体取决于是否需要集群级或SVM级API。

更多信息,请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/

支持两种身份验证方法:

  1. 基本身份验证,使用用户名和密码;

  2. SSL证书身份验证,使用ssl客户端证书文件,以及可选的私钥文件。

要使用证书,必须已在ONTAP集群中安装证书,并且必须已启用证书身份验证。

validate_certs

布尔值

如果设置为no,则不会验证SSL证书。

这应该只在使用自签名证书的个人控制站点上设置为False

选项

  • false

  • true ← (默认)

vserver

字符串 / 必需

要使用的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

作者

  • NetApp Ansible团队 (@carchi8py)