cisco.aci.aci_interface_policy_storm_control 模块 – 管理风暴控制接口策略 (stormctrl:IfPol)

注意

此模块是 cisco.aci 集合 (版本 2.10.1) 的一部分。

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

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

要在 playbook 中使用它，请指定： cisco.aci.aci_interface_policy_storm_control。

概要

• 管理 Cisco ACI 结构中的风暴控制接口策略。

参数

参数	注释
all_types_configuration 别名：all_types 字典	所有数据包类型的速率配置。
burst_rate 字符串	所有数据包类型的突发速率。
rate 字符串	所有数据包类型的速率。
rate_type 字符串 / 必需	所有数据包类型的速率类型。 在带宽百分比 percentage 或每秒数据包数 pps 之间选择 选项 "percentage" "pps"
注释 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定值，并且环境变量 ACI_ANNOTATION 也不存在，则将使用默认值。 默认值： "orchestrator:ansible"
broadcast_configuration 别名：broadcast 字典	广播数据包的速率配置。
burst_rate 字符串	广播数据包的突发速率。
rate 字符串	广播数据包的速率。
rate_type 字符串 / 必需	所有数据包类型的速率类型。 在带宽百分比 percentage 或每秒数据包数 pps 之间选择 选项 "percentage" "pps"
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（无扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
description 别名：descr 字符串	风暴接口策略名称的描述。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改用环境变量 ACI_HOST 的值。
multicast_configuration 别名：multicast 字典	多播数据包的速率配置。
burst_rate 字符串	多播数据包的突发速率。
rate 字符串	多播数据包的速率。
rate_type 字符串 / 必需	所有数据包类型的速率类型。 在带宽百分比 percentage 或每秒数据包数 pps 之间选择 选项 "percentage" "pps"
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
output_level 字符串	影响此 ACI 模块的输出。 normal 表示标准输出，包括 current 字典 info 添加信息输出，包括 previous、proposed 和 sent 字典 debug 添加调试输出，包括 filter_string、method、response、status 和 url 信息 如果任务中未指定值，则将改用环境变量 ACI_OUTPUT_LEVEL 的值。 选项 "debug" "info" "normal" ← (默认)
output_path 字符串	将用于转储模块生成的 ACI JSON 配置对象的路径。 如果任务中未指定值，则将改用环境变量 ACI_OUTPUT_PATH 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的自定义字符串。 此属性代表一个密钥，用于启用客户端拥有其数据以进行实体关联。 如果任务中未指定值，则将改用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的自定义字符串。 此属性代表一个标签，用于启用客户端添加他们自己的数据。 例如，指示谁创建了此对象。 如果任务中未指定值，则将改用环境变量 ACI_OWNER_TAG 的值。
密码 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
端口 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定值，则将改用环境变量 ACI_PORT 的值。
私钥 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
状态 字符串	使用 present 或 absent 来添加或删除。 使用 query 来列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
风暴控制操作 字符串	触发时要采取的风暴控制操作。 选项 "drop" "shutdown"
风暴控制策略 别名：storm_control, storm_control_name, name 字符串	风暴控制接口策略名称。
风暴控制浸泡操作 整数	触发关闭之前的实例数。
抑制先前操作 别名：no_previous, ignore_previous 布尔值	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查先前状态。 如果任务中未指定值，则将改用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
抑制验证 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证 GET 请求。 如果任务中未指定值，则将改用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值的当前对象在一个任务中将无法验证。 选项 false true
超时 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将改用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
单播配置 别名：unicast 字典	单播数据包的速率配置。
突发速率 字符串	单播数据包的突发速率。
速率 字符串	单播数据包的速率。
速率类型 字符串 / 必需	所有数据包类型的速率类型。 在带宽百分比 percentage 或每秒数据包数 pps 之间选择 选项 "percentage" "pps"
使用代理 布尔值	如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定值，则将改用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选项 false true
使用 SSL 布尔值	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定值，则将改用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选项 false true
用户名 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定值，则将改用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
验证证书 布尔值	如果为 false，则不会验证 SSL 证书。 只有在使用自签名证书的个人控制站点上才应将其设置为 false。 如果任务中未指定值，则将改用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选项 false true

另请参见

另请参见

APIC 管理信息模型参考

有关内部 APIC 类stormctrl:IfPol 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础设施的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以供贡献的详细指南。

示例

- name: Add a new Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    storm_control_policy: my_storm_control_policy
    description: My Storm Control Policy
    all_types_configuration:
      rate: 80
      burst_rate: 100
      rate_type: percentage
    storm_control_action: shutdown
    storm_control_soak_action: 5
    state: present
  delegate_to: localhost

- name: Query a Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    storm_control_policy: my_storm_control_policy
    state: query
  delegate_to: localhost

- name: Query all Storm Control Interface Policies
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    storm_control_policy: my_storm_control_policy
    state: absent
  delegate_to: localhost

返回值

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

键	描述
当前 列表 / 元素=字符串	模块完成后从 APIC 获取的现有配置 返回：成功 示例：[{"cdpIfPol": {"attributes": {"adminSt": "disabled", "annotation": "", "descr": "Ansible Created CDP Test Policy", "dn": "uni/infra/cdpIfP-Ansible_CDP_Test_Policy", "name": "Ansible_CDP_Test_Policy", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
错误 字典	APIC 返回的错误信息 返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
筛选字符串 字符串	用于请求的筛选字符串 返回：失败或调试 示例："?rsp-prop-include=config-only"
方法 字符串	用于向 APIC 发出请求的 HTTP 方法 返回：失败或调试 示例："POST"
先前 列表 / 元素=字符串	模块启动前从 APIC 获取的原始配置 返回：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
建议 字典	根据用户提供的参数组装的配置 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
原始数据 字符串	APIC REST API 返回的原始输出 (xml 或 json) 返回：解析错误 示例："<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
响应 字符串	APIC 的 HTTP 响应 返回：失败或调试 示例："OK (30 bytes)"
已发送 列表 / 元素=字符串	推送到 APIC 的实际/最小配置 返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 整数	APIC 的 HTTP 状态 返回：失败或调试 示例：200
URL 字符串	用于向 APIC 发出请求的 HTTP url 返回：失败或调试 示例："https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Eric Girard (@netgirard)

• Gaspard Micol (@gmicol)

收藏链接

• 问题追踪器
• 代码库 (源代码)