community.network.ce_bgp_neighbor_af 模块 – 管理华为 CloudEngine 交换机上的 BGP 邻居地址族配置。

注意

此模块是 community.network 集合（版本 5.1.0）的一部分。

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

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

要在剧本中使用它，请指定：community.network.ce_bgp_neighbor_af。

注意

community.network 集合已弃用，将从 Ansible 12 中删除。有关更多信息，请参阅讨论主题。

已弃用

移除版本:

6.0.0 版

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 管理华为 CloudEngine 交换机上的 BGP 邻居地址族配置。

别名：network.cloudengine.ce_bgp_neighbor_af

参数

参数

注释

add_path_mode

字符串

null，空。receive，支持接收 Add-Path 路由。send，支持发送 Add-Path 路由。both，支持接收和发送 Add-Path 路由。

选择

  • "null"

  • "receive"

  • "send"

  • "both"

adv_add_path_num

字符串

addPath 广播路由的数量。该值是一个介于 2 到 64 之间的整数。

advertise_arp

字符串

如果该值为 true，则会区分广播的 ARP 路由。如果该值为 false，则不会区分广播的 ARP 路由。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

advertise_community

字符串

如果该值为 true，则将 community 属性广播给对等方。如果该值为 false，则不会将 community 属性广播给对等方。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

advertise_ext_community

字符串

如果该值为 true，则将扩展 community 属性广播给对等方。如果该值为 false，则不会将扩展 community 属性广播给对等方。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

advertise_irb

字符串

如果该值为 true，则会区分广播的 IRB 路由。如果该值为 false，则不会区分广播的 IRB 路由。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

advertise_remote_nexthop

字符串

如果该值为 true，则将远程下一跳属性广播给对等方。如果该值为 false，则不会将远程下一跳属性广播给任何对等方。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

af_type

字符串 / 必需

BGP 实例的地址族类型。

选择

  • "ipv4uni"

  • "ipv4multi"

  • "ipv4vpn"

  • "ipv6uni"

  • "ipv6vpn"

  • "evpn"

allow_as_loop_enable

字符串

如果该值为 true，则允许重复的本地 AS 号。如果该值为 false，则不允许重复的本地 AS 号。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

allow_as_loop_limit

字符串

设置重复本地 AS 号的最大数量。该值是一个介于 1 到 10 之间的整数。

default_rt_adv_enable

字符串

如果该值为 true，则启用将默认路由广播给对等方的功能。如果该值为 false，则禁用将默认路由广播给对等方的功能。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

default_rt_adv_policy

字符串

指定使用的策略的名称。该值是一个字符串。该值是一个 1 到 40 个字符的字符串。

default_rt_match_mode

字符串

null，空。matchall，如果满足所有匹配条件，则广播默认路由。matchany，如果满足任何匹配条件，则广播默认路由。

选择

  • "null"

  • "matchall"

  • "matchany"

discard_ext_community

字符串

如果该值为 true，则会丢弃对等路由信息中的扩展 community 属性。如果该值为 false，则不会丢弃对等路由信息中的扩展 community 属性。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

export_acl_name_or_num

字符串

将基于 IPv4 ACL 的过滤策略应用于要广播到指定对等方的路由。该值是一个 1 到 32 个字符的字符串。

export_as_path_filter

字符串

将基于 AS_Path 的过滤策略应用于要广播到指定对等方的路由。该值是一个介于 1 到 256 之间的整数。

export_as_path_name_or_num

字符串

将基于 AS 路径列表的过滤策略应用于指定对等方的路由。

export_pref_filt_name

字符串

指定应用于要广播到指定对等方的路由的 IPv4 过滤策略。该值是一个 1 到 169 个字符的字符串。

export_rt_policy_name

字符串

指定应用于要广播到对等方的路由的过滤策略。该值是一个 1 到 40 个字符的字符串。

import_acl_name_or_num

字符串

将基于 IPv4 ACL 的过滤策略应用于从指定对等方接收的路由。该值是一个 1 到 32 个字符的字符串。

import_as_path_filter

字符串

将基于 AS_Path 的过滤策略应用于从指定对等方接收的路由。该值是一个介于 1 到 256 之间的整数。

import_as_path_name_or_num

字符串

一种基于 AS 路径列表的路由策略，用于指定对等方接收的路由。

import_pref_filt_name

字符串

指定应用于从指定对等方接收的路由的 IPv4 过滤策略。该值是一个 1 到 169 个字符的字符串。

import_rt_policy_name

字符串

指定应用于从对等方学习的路由的过滤策略。该值是一个 1 到 40 个字符的字符串。

ipprefix_orf_enable

字符串

如果值为 true，则为对等体启用基于地址前缀的出站路由过滤器 (ORF) 功能。如果值为 false，则为对等体禁用基于地址前缀的出站路由过滤器 (ORF) 功能。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

is_nonstd_ipprefix_mod

字符串

如果值为 true，则在能力协商期间使用非标准能力代码。如果值为 false，则在能力协商期间使用 RFC 定义的标准 ORF 能力代码。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

keep_all_routes

字符串

如果值为 true，则系统会在 BGP 连接建立后存储从所有对等体（组）接收的所有路由更新消息。如果值为 false，则系统仅存储从对等体接收且通过配置的导入策略的 BGP 更新消息。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

nexthop_configure

字符串

null，下一跳不更改。local，下一跳更改为本地 IP 地址。invariable，防止设备在将其通告给其 BGP 对等体时更改每个导入的 IGP 路由的下一跳。

选择

  • "null"

  • "local"

  • "invariable"

orf_mode

字符串

ORF 模式。null，默认值。receive，用于传入数据包的 ORF。send，用于传出数据包的 ORF。both，用于传入和传出数据包的 ORF。

选择

  • "null"

  • "receive"

  • "send"

  • "both"

orftype

字符串

ORF 类型。该值是一个介于 0 到 65535 之间的整数。

origin_as_valid

字符串

如果值为 true，则为路由通告的应用程序结果。如果值为 false，则不通知路由应用程序结果。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

preferred_value

字符串

为从指定对等体学习的路由分配首选值。该值是一个介于 0 到 65535 之间的整数。

public_as_only

字符串

如果值为 true，则发送的 BGP 更新消息仅携带公共 AS 号，而不携带私有 AS 号。如果值为 false，则发送的 BGP 更新消息可以携带私有 AS 号。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

public_as_only_force

字符串

如果值为 true，则发送的 BGP 更新消息仅携带公共 AS 号，而不携带私有 AS 号。如果值为 false，则发送的 BGP 更新消息可以携带私有 AS 号。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

public_as_only_limited

字符串

限制使用公共 AS 号。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

public_as_only_replace

字符串

私有 AS 号被公共 AS 号替换。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

public_as_only_skip_peer_as

字符串

公共 AS 号仅跳过对等体 AS 号。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

redirect_ip

字符串

重定向 IP。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

redirect_ip_validation

别名：redirect_ip_vaildation

字符串

重定向 IP 验证。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

reflect_client

字符串

如果值为 true，则本地设备充当路由反射器，对等体充当路由反射器的客户端。如果值为 false，则不配置路由反射器和客户端功能。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

remote_address

字符串 / 必需

IPv4 或 IPv6 对等体连接地址。

route_limit

字符串

配置可以从对等体接受的最大路由数。该值是一个介于 1 到 4294967295 之间的整数。

route_limit_idle_timeout

字符串

指定空闲超时计时器的值，以便在路由数超过设置的阈值时自动重新建立连接。该值是一个介于 1 到 1200 之间的整数。

route_limit_percent

字符串

指定路由器开始生成警报时的路由百分比。该值是一个介于 1 到 100 之间的整数。

route_limit_type

字符串

Noparameter，在接收到的路由数超过阈值且超时计时器到期后，不执行任何操作。AlertOnly，如果已接收到允许的最大路由数，则会生成警报，并且不会接受其他路由。IdleForever，如果已接收到允许的最大路由数，则中断的连接不会自动重新建立。IdleTimeout，在接收到的路由数超过阈值且超时计时器到期后，中断的连接会自动重新建立。

选择

  • "noparameter"

  • "alertOnly"

  • "idleForever"

  • "idleTimeout"

rt_updt_interval

字符串

指定发送更新数据包的最小间隔。该值是一个整数，以秒为单位。该值是一个介于 0 到 600 之间的整数。

soostring

字符串

配置始发站点 (SoO) 扩展社区属性。该值是一个 3 到 21 个字符的字符串。

substitute_as_enable

字符串

如果值为 true，则启用将 AS-Path 属性中指定的对等体的 AS 号替换为本地 AS 号的功能。如果值为 false，则禁用将 AS-Path 属性中指定的对等体的 AS 号替换为本地 AS 号的功能。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

update_pkt_standard_compatible

字符串

如果值为 true，当 vpnv4 组播邻居接收并更新消息时，该消息没有标签。如果值为 false，当 vpnv4 组播邻居接收并更新消息时，该消息有标签。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

vpls_ad_disable

字符串

如果值为 true，则启用 vpls-ad。如果值为 false，则禁用 vpls-ad。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

vpls_enable

字符串

如果值为 true，则启用 vpls。如果值为 false，则禁用 vpls。

选择

  • "no_use" ← (默认)

  • "true"

  • "false"

vrf_name

字符串 / 必需

BGP 实例的名称。该名称是一个区分大小写的字符串。BGP 实例只能在创建相应的 VPN 实例后使用。

说明

注意

  • 此模块需要远程管理设备上启用 netconf 系统服务。

  • 建议的连接是 netconf。

  • 此模块还适用于旧版 playbook 的 local 连接。

示例

- name: CloudEngine BGP neighbor address family test
  hosts: cloudengine
  connection: local
  gather_facts: false
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config BGP peer Address_Family"
    community.network.ce_bgp_neighbor_af:
      state: present
      vrf_name: js
      af_type: ipv4uni
      remote_address: 192.168.10.10
      nexthop_configure: local
      provider: "{{ cli }}"

  - name: "Undo BGP peer Address_Family"
    community.network.ce_bgp_neighbor_af:
      state: absent
      vrf_name: js
      af_type: ipv4uni
      remote_address: 192.168.10.10
      nexthop_configure: local
      provider: "{{ cli }}"

返回值

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

键

描述

changed

布尔值

检查设备上是否进行了更改

返回值：始终

示例： true

end_state

字典

模块执行后 aaa 参数的 k/v 对

返回值：始终

示例： {"bgp neighbor af": {"af_type": "ipv4uni", "remote_address": "192.168.10.10", "vrf_name": "js"}, "bgp neighbor af other": {"af_type": "ipv4uni", "nexthop_configure": "local", "vrf_name": "js"}}

existing

字典

现有 aaa 服务器的 k/v 对

返回值：始终

示例： {"bgp neighbor af": {"af_type": "ipv4uni", "remote_address": "192.168.10.10", "vrf_name": "js"}, "bgp neighbor af other": {"af_type": "ipv4uni", "nexthop_configure": "null", "vrf_name": "js"}}

proposed

字典

传递到模块的参数的 k/v 对

返回值：始终

示例： {"af_type": "ipv4uni", "nexthop_configure": "local", "remote_address": "192.168.10.10", "state": "present", "vrf_name": "js"}

updates

列表 / 元素=字符串

发送到设备的命令

返回值：始终

示例： ["peer 192.168.10.10 next-hop-local"]

状态

  • 此模块将在 6.0.0 版本中删除。[已弃用]

  • 有关详细信息，请参阅 已弃用。

作者

  • wangdezhuang (@QijunPan)