cisco.aci.aci_bgp_peer_prefix_policy 模块 – 管理 BGP 对等体前缀策略 (bgp:PeerPfxPol)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构中租户的 BGP 对等体前缀策略。

参数

参数	注释
action 字符串	达到最大前缀限制时要执行的操作。 在创建期间未设置时，APIC 默认值为 reject。 选项 "log" "reject" "restart" "shut"
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 别名：descr 字符串	BGP 对等体前缀策略的描述。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定该值，则将改用环境变量 ACI_HOST 的值。
maximum_number_prefix 别名：max_prefix, max_num_prefix 整数	从对等体允许的最大前缀数。 在创建期间未设置时，APIC 默认值为 20000。
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的值。
peer_prefix_policy 别名：peer_prefix_policy_name，name 字符串	BGP对等体前缀策略的名称。
port 整数	用于REST连接的端口号。 默认值取决于参数use_ssl。 如果任务中未指定此值，则将改用环境变量ACI_PORT的值。
private_key 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将被忽略。 如果任务中未指定此值，则将改用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
restart_time 字符串	达到前缀限制后重新启动对等体之前的时间段（分钟）。 仅当action设置为restart时使用。 在创建期间未设置时，APIC默认为infinite。
state 字符串	使用present或absent添加或删除。 使用query列出单个对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous，ignore_previous 布尔值	如果为true，则在进行POST更新到APIC之前不会发送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 字符串	现有租户的名称。
threshold 别名：thresh 整数	发出警告之前，前缀最大数量的阈值百分比。 例如，如果前缀的最大数量为10，阈值为70％，则当前缀数量超过7（70％）时，将发出警告。 在创建期间未设置时，APIC默认为75。
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类bgp:PeerPfxPol的更多信息。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Create a BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_policy
    action: restart
    restart_time: 10
    max_prefix: 10000
    threshold: 80
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete a BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_policy
    tenant: production
    state: absent
  delegate_to: localhost

- name: Query all BGP peer prefix policies
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific BGP peer prefix policy
  cisco.aci.aci_bgp_peer_prefix_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    peer_prefix_policy: my_bgp_peer_prefix_policy
    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"
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"

作者

• Gaspard Micol (@gmicol)

资源链接

• 问题跟踪器
• 代码仓库