community.network.ce_bgp_neighbor 模块 – 管理华为 CloudEngine 交换机上的 BGP 对等体配置。

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.network

要在 playbook 中使用它,请指定:community.network.ce_bgp_neighbor

注意

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

已弃用

在以下版本中删除:

6.0.0 版本

原因:

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

替代方案:

未知。

概要

  • 管理华为 CloudEngine 交换机上的 BGP 对等体配置。

别名:network.cloudengine.ce_bgp_neighbor

参数

参数

注释

conn_retry_time

字符串

ConnectRetry 间隔。该值是一个介于 1 到 65535 之间的整数。

connect_mode

字符串

值可以是 Connect-only、Listen-only 或 Both。

conventional

字符串

如果值为 true,则路由器具有所有扩展功能。如果值为 false,则路由器不具有所有扩展功能。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

description

字符串

对等体的描述,可以是字母或数字。该值是 1 到 80 个字符的字符串。

dual_as

字符串

如果值为 true,则 EBGP 对等体可以使用伪造的 AS 号或实际的 AS 号。如果值为 false,则 EBGP 对等体只能使用伪造的 AS 号。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

ebgp_max_hop

字符串

间接 EBGP 连接中的最大跳数。该值是一个介于 1 到 255 之间的整数。

fake_as

字符串

为本地对等体指定的伪造 AS 号。该值是一个 1 到 11 个字符的字符串。

hold_time

字符串

指定对等体或对等组的保持时间。该值是 0 或介于 3 到 65535 之间的整数。

is_bfd_block

字符串

如果值为 true,则允许对等体从对等组继承 BFD 功能。如果值为 false,则禁止对等体从对等组继承 BFD 功能。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

is_bfd_enable

字符串

如果值为 true,则启用 BFD。如果值为 false,则禁用 BFD。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

is_ignore

字符串

如果值为 true,则会断开与指定对等体的会话,并清除所有相关的路由条目。如果值为 false,则会保留与指定对等体的会话。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

is_log_change

字符串

如果值为 true,则启用 BGP 来记录对等体会话状态和事件信息。如果值为 false,则禁用 BGP 记录对等体会话状态和事件信息。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

is_single_hop

字符串

如果值为 true,则启用系统优先使用单跳模式在 IBGP 对等体之间建立 BFD 会话。如果值为 false,则禁用系统优先使用单跳模式在 IBGP 对等体之间建立 BFD 会话。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

keep_alive_time

字符串

指定对等体或对等组的 Keepalive 时间。该值是一个介于 0 到 21845 之间的整数。默认值为 60。

key_chain_name

字符串

指定 BGP 对等体建立 TCP 连接时使用的密钥链身份验证名称。该值是一个 1 到 47 个字符(不区分大小写)的字符串。

local_if_name

字符串

发送 BGP 数据包的源接口的名称。该值是 1 到 63 个字符的字符串。

min_hold_time

字符串

指定对等体或对等组的最小保持时间。

mpls_local_ifnet_disable

字符串

如果值为 true,则对等体创建 MPLS Local IFNET 禁用。如果值为 false,则对等体创建 MPLS Local IFNET 启用。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

multiplier

字符串

指定检测乘数。默认值为 3。该值是一个介于 3 到 50 之间的整数。

peer_addr

字符串 / 必需

对等体的连接地址,可以是 IPv4 或 IPv6 地址。

prepend_fake_as

字符串

将伪造的 AS 号添加到收到的更新数据包中。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

prepend_global_as

字符串

将全局 AS 号添加到要通告的更新数据包中。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

pswd_cipher_text

字符串

密码中的字符串标识密码的内容,不支持空格。该值是一个 1 到 255 个字符的字符串。

pswd_type

字符串

使 BGP 对等体能够建立 TCP 连接并对 BGP 消息执行消息摘要 5 (MD5) 身份验证。

选择

  • "null"

  • "cipher"

  • "simple"

remote_as

字符串 / 必需

对等体的 AS 号。该值是一个 1 到 11 个字符的字符串。

route_refresh

字符串

如果值为 true,则启用 BGP 以通告 REFRESH 数据包。如果值为 false,则启用路由刷新功能。

选择

  • "no_use" ←(默认)

  • "true"

  • "false"

rx_interval

字符串

指定接收 BFD 数据包的最小间隔。该值是一个介于 50 到 1000 之间的整数(以毫秒为单位)。

state

字符串

指定资源的期望状态。

选择

  • "present" ←(默认)

  • "absent"

tcp_MSS

字符串

用于对等体 TCP 连接建立的最大 TCP MSS 值。该值是一个介于 176 到 4096 之间的整数。

tx_interval

字符串

指定发送 BFD 数据包的最小间隔。该值是一个介于 50 到 1000 之间的整数(以毫秒为单位)。

valid_ttl_hops

字符串

在对等体或对等组上启用 GTSM。valid-TTL-Value 参数用于指定要检测的 TTL 跳数。该值是一个介于 1 到 255 之间的整数。

vrf_name

字符串 / 必需

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

备注

注意

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

  • 推荐的连接方式是 netconf

  • 此模块也适用于 local 连接,用于旧版本的 playbook。

示例

- name: CloudEngine BGP neighbor 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"
    community.network.ce_bgp_neighbor:
      state: present
      vrf_name: js
      peer_addr: 192.168.10.10
      remote_as: 500
      provider: "{{ cli }}"

  - name: "Config bgp route id"
    community.network.ce_bgp_neighbor:
      state: absent
      vrf_name: js
      peer_addr: 192.168.10.10
      provider: "{{ cli }}"

返回值

常见的返回值记录在这里,以下是此模块独有的字段

描述

changed

布尔值

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

返回值: 总是

示例: true

end_state

字典

模块执行后 aaa 参数的键/值对

返回值: 总是

示例: {"bgp peer": [["192.168.10.10", "500"]]}

existing

字典

现有 aaa 服务器的键/值对

返回值: 总是

示例: {"bgp peer": []}

proposed

字典

传递到模块的参数的键/值对

返回值: 总是

示例: {"peer_addr": "192.168.10.10", "remote_as": "500", "state": "present", "vrf_name": "js"}

updates

列表 / 元素=字符串

发送到设备的命令

返回值: 总是

示例: ["peer 192.168.10.10 as-number 500"]

状态

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

  • 有关更多信息,请参阅已弃用

作者

  • wangdezhuang (@QijunPan)