cisco.aci.aci_system_endpoint_controls 模块 – 管理系统端点控制 (ep:IpAgingP、ep:ControlP 和 ep:LoopProtectP)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的系统端点控制。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将改为使用环境变量 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 的值。
ep_loop_protection 字典	EP 环路保护的配置容器。
action 列表 / 元素=字符串	检测到环路时要执行的操作。 选项 "bd" "port"
admin_state 布尔值	是否在结构上启用 EP 环路保护。 选项 false true
interval 整数	环路保护检测间隔（秒）。
multiplication_factor 整数	环路保护检测乘法因子。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改为使用环境变量 ACI_HOST 的值。
ip_aging 字典	IP 老化时间的配置容器。
admin_state 布尔值	是否在结构上启用 IP 老化时间控制。 选项 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 的值。
owner_key 字符串	ACI 对象的 ownerKey 属性的自定义字符串。 此属性表示一个密钥，用于启用客户端拥有其数据以进行实体关联。 如果任务中未指定值，则将改为使用环境变量 ACI_OWNER_KEY 的值。
owner_tag 字符串	ACI 对象的 ownerTag 属性的自定义字符串。 此属性表示一个标记，用于启用客户端添加其自身数据。 例如，指示谁创建了此对象。 如果任务中未指定值，则将改为使用环境变量 ACI_OWNER_TAG 的值。
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 的值。
roque_ep_control 字典	Rogue EP 控制的配置容器。
admin_state 布尔值	是否在结构域上启用 Rogue EP 控制。 选项 false true
hold_interval 整数	异常端点保持间隔（秒）。
interval 整数	异常端点检测间隔（秒）。
multiplication_factor 整数	异常端点检测倍数。
state 字符串	使用 present 更新配置。 使用 query 显示当前配置。 选项 "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
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

另请参见

另请参见

APIC 管理信息模型参考

有关内部 APIC 类ep:IpAgingP、ep:ControlP 和 ep:LoopProtectP 的更多信息。

Cisco ACI 指南

使用 Ansible 管理 ACI 基础架构的详细信息。

开发 Cisco ACI 模块

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

示例

- name: Set system endpoint controls settings
  cisco.aci.aci_system_endpoint_controls:
    host: apic
    username: admin
    password: SomeSecretPassword
    admin_state: true
    ip_aging:
      admin_state: true
    roque_ep_control:
      admin_state: true
      interval: 50
      multiplication_factor: 10
      hold_interval: 2000
    ep_loop_protection:
      admin_state: true
      interval: 70
      multiplication_factor: 15
      action: [bd, port]
  delegate_to: localhost

- name: Query system endpoint controls settings
  cisco.aci.aci_system_endpoint_controls:
    host: apic
    username: admin
    password: SomeSecretPassword
    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"

作者

• Tim Cragg (@timcragg)

• Akini Ross (@akinross)

资源链接

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