netapp.storagegrid.na_sg_grid_traffic_classes 模块 – 管理 StorageGRID 上的流量分类策略配置。

注意

此模块是 netapp.storagegrid 集合 (版本 21.13.0) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install netapp.storagegrid。

要在 playbook 中使用它，请指定：netapp.storagegrid.na_sg_grid_traffic_classes。

netapp.storagegrid 21.10.0 中的新增功能

概要

• 在 NetApp StorageGRID 上创建、更新和删除流量分类策略。

参数

参数	注释
api_url 字符串 / 必需	StorageGRID 管理节点 REST API 的 URL。
auth_token 字符串 / 必需	API 请求的授权令牌
description 字符串	流量分类策略的描述。
limits 列表 / 元素=字典	对与该流量类别匹配的客户端请求施加的可选限制。 每种限制类型只能指定一个。
type 字符串 / 必需	要应用的限制类型。 aggregateBandwidthIn - 与此策略匹配的所有并发请求的组合上传带宽最大值（以字节/秒为单位）。 aggregateBandwidthOut - 与此策略匹配的所有并发请求的组合下载带宽最大值（以字节/秒为单位）。 concurrentReadRequests - 同时可以进行的下载请求最大数量。 concurrentWriteRequests - 同时可以进行的上传请求最大数量。 readRequestRate - 每秒可以启动的下载请求最大数量。 writeRequestRate - 每秒可以启动的下载请求最大数量。 perRequestBandwidthIn - 与此策略匹配的每个请求允许的最大上传带宽（以字节/秒为单位）。 perRequestBandwidthOut - 与此策略匹配的每个请求允许的最大下载带宽（以字节/秒为单位）。 选项 "aggregateBandwidthIn" "aggregateBandwidthOut" "concurrentReadRequests" "concurrentWriteRequests" "readRequestRate" "writeRequestRate" "perRequestBandwidthIn" "perRequestBandwidthOut"
value 整数 / 必需	要应用的限制。 限制值是特定于类型的。
matchers 列表 / 元素=字典	一组要匹配的参数。 流量类别将匹配这些匹配器中的任何一个匹配的请求。
inverse 布尔值	如果为 *true*，则排除与该值匹配的实体。 选项 false ← (默认) true
members 列表 / 元素=字符串 / 必需	要匹配的成员列表。
type 字符串 / 必需	要匹配的请求的属性。 bucket - 正在访问的 S3 存储桶（或 Swift 容器）。 bucket-regex - 用于对正在访问的 S3 存储桶（或 Swift 容器）进行评估的正则表达式。 cidr - 如果客户端请求源 IP 位于指定的 IPv4 CIDR (RFC4632) 中，则匹配。 tenant - 如果 S3 存储桶（或 Swift 容器）由具有此 ID 的租户帐户拥有，则匹配。 选项 "bucket" "bucket-regex" "cidr" "endpoint" "tenant"
name 字符串	流量分类策略的名称。
policy_id 字符串	流量分类策略 ID。 可用于修改或删除操作。
state 字符串	指定的流量分类策略是否应该存在。 选项 "present" ← (默认) "absent"
validate_certs 布尔值	是否应该验证 https 证书？ 选项 false true ← (默认)

备注

注意

• 以 na_sg 为前缀的模块旨在管理 NetApp StorageGRID。

示例

- name: create Traffic Classification Policy with bandwidth limit on buckets
  netapp.storagegrid.na_sg_grid_traffic_classes:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: Traffic-Policy1
    matchers:
      - type: bucket
        members: bucket1,anotherbucket
    limits:
      - type: aggregateBandwidthOut
        value: 100000000

- name: create Traffic Classification Policy with bandwidth limits except for specific tenant account
  netapp.storagegrid.na_sg_grid_traffic_classes:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: Fabricpool-Policy
    description: "Limit all to 500MB/s except FabricPool tenant"
    matchers:
      - type: tenant
        inverse: True
        members: 12345678901234567890
    limits:
      - type: aggregateBandwidthIn
        value: 50000000
      - type: aggregateBandwidthOut
        value: 50000000

- name: rename Traffic Classification Policy
  netapp.storagegrid.na_sg_grid_traffic_classes:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    policy_id: 00000000-0000-0000-0000-000000000000
    name: Traffic-Policy1-New-Name
    matchers:
      - type: bucket
        members: bucket1,anotherbucket
    limits:
      - type: aggregateBandwidthOut
        value: 100000000

- name: delete Traffic Classification Policy
  netapp.storagegrid.na_sg_grid_traffic_classes:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: absent
    name: Traffic-Policy1

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
resp 字典	返回有关 StorageGRID 流量分类策略的信息。 返回：成功 示例： {"description": "流量分类策略1", "id": "6b2946e6-7fed-40d0-9262-8e922580aba7", "limits": [{"type": "aggregateBandwidthOut", "value": 100000000}], "matchers": [{"inverse": false, "members": ["192.168.50.0/24"], "type": "cidr"}, {"inverse": false, "members": ["mybucket1", "mybucket2"], "type": "bucket"}], "name": "Traffic-Policy1"}

作者

• NetApp Ansible 团队 (@joshedmonds)

资源链接

• 主页
• 代码库 (源码)