cisco.aci.aci_interface_policy_ospf 模块 – 管理 OSPF 接口策略 (ospf: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_ospf。

概要

• 管理 Cisco ACI 交换结构上的 OSPF 接口策略。

参数

参数	注释
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 的值。
controls 列表 / 元素=字符串	接口策略控制。 这是以下一个或多个控制的列表 advert-subnet – 在路由器 LSA 中通告 IP 子网而不是主机掩码。 bfd – 双向转发检测 mtu-ignore – 禁用接口上的 MTU 不匹配检测。 passive – 该接口不参与 OSPF 协议，也不会建立邻接关系或发送路由更新。但是，该接口作为路由网络的一部分进行通告。 选择 "advert-subnet" "bfd" "mtu-ignore" "passive" "unspecified"
cost 整数	接口的 OSPF 开销。 接口在 OSPF 中的开销（也称为度量）表示跨特定接口发送数据包所需的开销。接口的开销与该接口的带宽成反比。较高的带宽表示较低的开销。与跨 10M 以太网线路相比，跨 56k 串行线路涉及更多的开销（更高的开销）和时间延迟。用于计算开销的公式为 cost= 10000 0000/bps 带宽 例如，跨 10M 以太网线路的开销为 10 EXP8/10 EXP7 = 10，而跨 T1 线路的开销为 10 EXP8/1544000 = 64。 默认情况下，接口的开销是根据带宽计算的；您可以使用 ip ospf cost value 接口子配置模式命令强制指定接口的开销。 接受的值范围在 1 和 450 之间。 如果在创建期间未设置，APIC 默认为 0。
dead_interval 整数	路由器声明邻居关闭之前，来自邻居的 hello 数据包之间的间隔。 对于特定网络上的所有网络设备，此值必须相同。 指定较小的死间隔（秒）将更快地检测到邻居关闭并提高收敛性，但可能会导致更多的路由不稳定性。 接受的值范围在 1 和 65535 之间。 如果在创建期间未设置，APIC 默认为 40。
description 别名：descr 字符串	OSPF 接口的描述。
hello_interval 整数	OSPF 在接口上发送 hello 数据包的间隔。 请注意，hello 间隔越小，检测到拓扑变化的速度就越快，但会产生更多的路由流量。 对于特定网络上的所有路由器和接入服务器，此值必须相同。 接受的值范围在 1 和 65535 之间。 如果在创建期间未设置，APIC 默认为 10。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将使用环境变量 ACI_HOST 的值。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
network_type 字符串	OSPF 接口策略网络类型。 OSPF 支持广播和点对点。 如果在创建期间未设置，APIC 默认为 unspecified。 选择 "bcast" "p2p" "unspecified"
ospf 别名：ospf_interface、name 字符串	OSPF 接口策略名称。 此名称的长度可以是 1 到 64 个字母数字字符。 请注意，保存对象后，您无法更改此名称。
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 的值。
prefix_suppression 字符串	是否启用或禁用前缀抑制。 在创建期间未设置时，APIC 默认值为 inherit。 选择 "inherit" "enable" "disable"
priority 整数	OSPF 接口配置文件的优先级。 接受的值范围在 0 到 255 之间。 在创建期间未设置时，APIC 默认值为 1。
private_key 别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值也会影响所使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
retransmit_interval 整数	LSA 重传之间的时间间隔。 当路由器等待邻居路由器确认收到 LSA 时，会发生重传间隔。 如果在间隔结束时未收到确认，则会重新发送 LSA。 接受的值范围在 1 和 65535 之间。 在创建期间未设置时，APIC 默认值为 5。
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 字符串	OSPF 接口策略应属于的租户的名称。
timeout 整数	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
transmit_delay 整数	发送 LSA 更新数据包所需的延迟时间。 OSPF 在传输 LSA 更新之前，会将 LSA 老化时间增加传输延迟量。 设置此值时，应考虑接口的传输和传播延迟。 接受的值范围在 1 和 450 之间。 在创建期间未设置时，APIC 默认值为 1。
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 类 ospf:IfPol 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Ensure ospf interface policy exists
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Ensure ospf interface policy does not exist
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Query an ospf interface policy
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all ospf interface policies in tenant production
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
current 列表 / 元素=字符串	模块完成后，来自 APIC 的现有配置 返回: 成功 示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	从 APIC 返回的错误信息 返回: 失败 示例: {"code": "122", "text": "未知托管对象类 foo"}
filter_string 字符串	用于请求的筛选字符串 返回: 失败或调试 示例: "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发出请求的 HTTP 方法 返回: 失败或调试 示例: "POST"
previous 列表 / 元素=字符串	模块启动前来自 APIC 的原始配置 返回: 信息 示例: [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	从用户提供的参数中组装的配置 返回: 信息 示例: {"fvTenant": {"attributes": {"descr": "生产环境", "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": "生产环境"}}}
状态 整数	来自 APIC 的 HTTP 状态 返回: 失败或调试 示例: 200
URL 字符串	用于向 APIC 发出请求的 HTTP URL 返回: 失败或调试 示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Dag Wieers (@dagwieers)

集合链接

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