cisco.aci.aci_interface_policy_bfd_multihop 模块 – 管理 BFD 多跳接口策略 (bfd:MhIfPol)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的 BFD 多跳接口策略配置

• 仅在 APIC 版本 5.2 或更高版本中可用

参数

参数	注释
admin_state 字符串	BFD 多跳接口策略的管理状态 APIC 将默认值设置为 enabled。 选项 "enabled" "disabled"
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 的值。
description 字符串	BFD 多跳接口策略的描述
detection_multiplier 整数	BFD 多跳接口策略的检测倍数 APIC 将默认值设置为 3。 允许范围是 1-50。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将改为使用环境变量 ACI_HOST 的值。
min_receive_interval 整数	BFD 多跳接口策略的最小接收 (Rx) 间隔 APIC 将默认值设置为 250 允许范围是 250-999
min_transmit_interval 整数	BFD 多跳接口策略的最小发送 (Tx) 间隔 APIC 将默认值设置为 250 允许范围是 250-999
name 别名：bfd_multihop_interface_policy 字符串	BFD 多跳接口策略的名称
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的值。
端口 整数	用于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"
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
租户 字符串	现有租户的名称
超时 整数	以秒为单位的套接字级别超时。 如果任务中未指定值，则将改用环境变量ACI_TIMEOUT的值。 默认值为30。
使用代理 布尔值	如果为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

备注

注意

• 在您的剧本中使用此模块之前，必须存在tenant。可以使用cisco.aci.aci_tenant模块来实现。

另请参阅

另请参阅

APIC管理信息模型参考

有关内部APIC类bfd:MhIfPol的更多信息

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Add a new  BFD Multihop Interface policy
  cisco.aci.aci_interface_policy_bfd_multihop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: ansible_bfd_multihop_interface_policy
    description: Ansible BFD Multihop Interface Policy
    state: present
  delegate_to: localhost

- name: Remove a BFD Multihop Interface policy
  cisco.aci.aci_interface_policy_bfd_multihop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: ansible_bfd_multihop_interface_policy
    state: absent
  delegate_to: localhost

- name: Query a BFD Multihop Interface policy
  cisco.aci.aci_interface_policy_bfd_multihop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: ansible_bfd_multihop_interface_policy
    state: query
  delegate_to: localhost

- name: Query all BFD Multihop Interface policies in a specific tenant
  cisco.aci.aci_interface_policy_bfd_multihop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    state: query
  delegate_to: localhost

返回值

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

键	描述
当前 列表 / 元素=字符串	模块完成之后从APIC获取的现有配置 返回：成功 示例：[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "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 \"/></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"

作者

• Anvitha Jain (@anvjain)

资源链接

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