cisco.aci.aci_tenant_action_rule_profile 模块 – 管理动作规则配置文件 (rtctrl:AttrP)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中的动作规则配置文件。

参数

参数	注释
action_rule 别名：action_rule_name, name 字符串	动作规则配置文件的名称。
注释 字符串	用户定义的字符串，用于注释对象。 如果任务中未指定此值，则将改用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也未设置，则将使用默认值。 默认值： "orchestrator:ansible"
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 的值。
multipath 布尔值	基于设置重新分配多路径配置设置动作规则。 不能与 set_route_tag 一起配置。 不能为 APIC 版本 4.2 及更低版本配置。 未设置时，APIC 默认为 false。 选项 false true
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
next_hop_propagation 布尔值	基于 nexthop 未更改配置设置动作规则。 不能与 set_route_tag 一起配置。 不能为 APIC 版本 4.2 及更低版本配置。 未设置时，APIC 默认为 false。 选项 false true
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 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定此值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定值，则将使用环境变量ACI_PORT的值。
private_key 别名：cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果任务中未指定值，则将使用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
set_community 字典	基于社区的设置操作规则。 要删除此属性，请传递一个空字典。
community 字符串	社区值。
criteria 字符串	社区标准。 追加或替换社区值的选项。 选项 "append" "replace" "none"
set_dampening 字典	基于阻尼的设置操作规则。 要删除此属性，请传递一个空字典。
half_life 整数	半衰期值（分钟）。
max_suppress_time 整数	最大抑制时间值（分钟）。
reuse 整数	重用限制值。
suppress 整数	抑制限制值。
set_metric 字符串	基于指标的设置操作规则。 要删除此属性，请传递一个空字符串。
set_metric_type 字符串	基于指标类型的设置操作规则。 要删除此属性，请传递一个空字符串。 选项 "ospf_type_1" "ospf_type_2" ""
set_next_hop 字符串	基于下一跳地址的设置操作规则。 要删除此属性，请传递一个空字符串。
set_preference 字符串	基于优先级的设置操作规则。 要删除此属性，请传递一个空字符串。
set_route_tag 字符串	基于路由标签的设置操作规则。 不能与next_hop_propagation和multipath一起配置。 要删除此属性，请传递一个空字符串。
set_weight 字符串	基于权重的设置操作规则。 要删除此属性，请传递一个空字符串。
state 字符串	使用present或absent进行添加或删除。 使用query列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous, ignore_previous 布尔值	如果为true，则在向 APIC 发送 POST 更新之前不会发送 GET 来检查之前的状态。 如果任务中未指定值，则将使用环境变量ACI_SUPPRESS_PREVIOUS的值。 默认值为false。 警告 - 这会导致之前的返回值为空。 不会检查对象的先前状态，POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为true，则在向 APIC 发送 POST 更新后不会发送验证 GET。 如果任务中未指定值，则将使用环境变量ACI_SUPPRESS_VERIFICATION的值。 默认值为false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值在内的当前对象在一个任务中将无法验证。 选项 false true
tenant 别名：tenant_name 字符串	租户的名称。
timeout 整数	套接字级别超时（秒）。 如果任务中未指定值，则将使用环境变量ACI_TIMEOUT的值。 默认值为 30。
use_proxy 布尔值	如果为false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定值，则将使用环境变量ACI_USE_PROXY的值。 默认值为 true。 选项 false true
use_ssl 布尔值	如果为false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定值，则将使用环境变量ACI_USE_SSL的值。 当连接为本地连接时，默认值为 true。 选项 false true
username 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定值，则将使用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为 admin。
validate_certs 布尔值	如果为false，则不会验证 SSL 证书。 只有在使用自签名证书的个人控制站点上使用时，才应将其设置为false。 如果任务中未指定值，则将使用环境变量ACI_VALIDATE_CERTS的值。 默认值为 true。 选项 false true

注释

注意

• 在您的 playbook 中使用此模块之前，必须存在所使用的tenant。cisco.aci.aci_tenant模块可用于此目的。

另请参见

另请参见

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

APIC 管理信息模型参考

有关内部 APIC 类rtctrl:AttrP的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    set_preference: 100
    set_weight: 100
    set_metric: 100
    set_metric_type: ospf_type_1
    set_next_hop: 1.1.1.1
    next_hop_propagation: true
    multipath: true
    set_community:
      community: no-advertise
      criteria: replace
    set_dampening:
      half_life: 10
      reuse: 1
      suppress: 10
      max_suppress_time: 100
    state: present
  delegate_to: localhost

- name: Delete action rule profile's children
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    set_preference: ""
    set_weight: ""
    set_metric: ""
    set_metric_type: ""
    set_next_hop: ""
    next_hop_propagation: false
    multipath: false
    set_community: {}
    set_dampening: {}
    state: present
  delegate_to: localhost

- name: Delete a action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    state: absent
  delegate_to: localhost

- name: Query all action rule profiles
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific action rule profile
  cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后 APIC 中的现有配置 已返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	APIC 返回的错误信息 已返回：失败 示例：{"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的过滤器字符串 已返回：失败或调试 示例："?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发送请求的 HTTP 方法 已返回：失败或调试 示例："POST"
previous 列表 / 元素=字符串	模块启动前 APIC 中的原始配置 已返回：信息 示例：[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	用户提供的参数组装的配置 已返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw 字符串	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>"
response 字符串	来自 APIC 的 HTTP 响应 已返回：失败或调试 示例："OK (30 bytes)"
sent 列表 / 元素=字符串	实际/最小配置推送到 APIC 已返回：信息 示例：{"fvTenant": {"attributes": {"descr": "Production environment"}}}
status 整数	来自 APIC 的 HTTP 状态 已返回：失败或调试 示例：200
url 字符串	用于向 APIC 发送请求的 HTTP url 已返回：失败或调试 示例："https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Dag Wieers (@dagwieers)

• Tim Cragg (@timcragg)

• Gaspard Micol (@gmicol)

集合链接

• 问题追踪器
• 代码库（源代码）