cisco.aci.aci_interface_policy_eigrp 模块 – 管理 EIGRP 接口策略 (eigrp:IfPol)

注意

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

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

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

要在剧本中使用它，请指定：cisco.aci.aci_interface_policy_eigrp。

概要

• 管理 Cisco ACI 结构中租户的 EIGRP 接口策略。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务和环境变量 ACI_ANNOTATION 中均未指定此值，则将使用默认值。 默认值： "orchestrator:ansible"
bandwidth 整数	以 kbps 为单位的 EIGRP 带宽，会覆盖接口上配置的带宽。 这用于影响路径选择。 可接受的值范围在 0 和 2560000000 之间。 在创建期间未设置时，APIC 默认值为 0。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名（无扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
control_state 列表 / 元素=字符串	接口策略控制状态。 这是一个或多个以下控制的列表 bfd – 启用双向转发检测。 nexthop_self – 下一跳自身。 split_horizon – 分割视野。 passive – 接口不参与 EIGRP 协议，不会建立邻接关系或发送路由更新。 在创建期间未设置时，APIC 默认值为 [split_horizon, nexthop_self]。 选项 "bfd" "nexthop_self" "passive" "split_horizon"
delay 整数	EIGRP 吞吐量延迟，会覆盖接口上配置的延迟。 这用于影响路径选择。 在创建期间未设置时，APIC 默认值为 0。
delay_unit 字符串	EIGRP 延迟单位，宽度指标可以使用皮秒精度的延迟。 在创建期间未设置时，APIC 默认值为 tens_of_microseconds。 选项 "picoseconds" "tens_of_microseconds"
description 别名：descr 字符串	EIGRP 接口策略的描述。
eigrp 别名：eigrp_interface, name 字符串	EIGRP 接口策略名称。 请注意，对象创建后无法更改此名称。
hello_interval 整数	EIGRP 在接口上发送 hello 数据包之间的时间间隔（秒）。 hello 间隔越小，拓扑变化检测速度越快，但产生的路由流量越多。 可接受的值范围在 1 和 65535 之间。 在创建期间未设置时，APIC 默认值为 5。
hold_interval 整数	声明邻居已关闭的时间段（秒）。 可接受的值范围在 1 和 65535 之间。 在创建期间未设置时，APIC 默认值为 15。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
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 的值。
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 的值。
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 类 eigrp:IfPol 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create an EIGRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    bandwidth: 10000
    control_state: [split-horizon, nh-self]
    delay: 10
    delay_unit: tens_of_micro
    hello_interval: 5
    hold_interval: 15
    state: present
  delegate_to: localhost

- name: Delete EIGRRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    state: present
  delegate_to: localhost

- name: Query an EIGRRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EIGRP interface policies in tenant production
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    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"
方法 字符串	用于向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"

作者

• Gaspard Micol (@gmicol)

• Lukas Holub (@lukasholub)

相关链接

• 问题追踪
• 代码仓库