Try SpotterManages BGP peer configuration on HUAWEI CloudEngine switches.
Authors: wangdezhuang (@QijunPan)
preview | supported by community
Install with ansible-galaxy collection install community.general:==0.1.1
collections:
- name: community.general
version: 0.1.1Manages BGP peer configurations on HUAWEI CloudEngine switches.
- name: CloudEngine BGP neighbor test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: "Config bgp peer"
ce_bgp_neighbor:
state: present
vrf_name: js
peer_addr: 192.168.10.10
remote_as: 500
provider: "{{ cli }}"
- name: "Config bgp route id"
ce_bgp_neighbor:
state: absent
vrf_name: js
peer_addr: 192.168.10.10
provider: "{{ cli }}"
state:
choices:
- present
- absent
default: present
description:
- Specify desired state of the resource.
dual_as:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, the EBGP peer can use either a fake AS number or the actual
AS number. If the value is false, the EBGP peer can only use a fake AS number.
fake_as:
description:
- Fake AS number that is specified for a local peer. The value is a string of 1 to
11 characters.
tcp_MSS:
description:
- Maximum TCP MSS value used for TCP connection establishment for a peer. The value
is an integer ranging from 176 to 4096.
vrf_name:
description:
- Name of a BGP instance. The name is a case-sensitive string of characters. The BGP
instance can be used only after the corresponding VPN instance is created.
required: true
hold_time:
description:
- Specify the Hold time of a peer or peer group. The value is 0 or an integer ranging
from 3 to 65535.
is_ignore:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, the session with a specified peer is torn down and all related
routing entries are cleared. If the value is false, the session with a specified
peer is retained.
peer_addr:
description:
- Connection address of a peer, which can be an IPv4 or IPv6 address.
required: true
pswd_type:
choices:
- 'null'
- cipher
- simple
description:
- Enable BGP peers to establish a TCP connection and perform the Message Digest 5
(MD5) authentication for BGP messages.
remote_as:
description:
- AS number of a peer. The value is a string of 1 to 11 characters.
required: true
multiplier:
description:
- Specify the detection multiplier. The default value is 3. The value is an integer
ranging from 3 to 50.
description:
description:
- Description of a peer, which can be letters or digits. The value is a string of
1 to 80 characters.
rx_interval:
description:
- Specify the minimum interval at which BFD packets are received. The value is an
integer ranging from 50 to 1000, in milliseconds.
tx_interval:
description:
- Specify the minimum interval at which BFD packets are sent. The value is an integer
ranging from 50 to 1000, in milliseconds.
connect_mode:
description:
- The value can be Connect-only, Listen-only, or Both.
conventional:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, the router has all extended capabilities. If the value is
false, the router does not have all extended capabilities.
ebgp_max_hop:
description:
- Maximum number of hops in an indirect EBGP connection. The value is an ranging from
1 to 255.
is_bfd_block:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, peers are enabled to inherit the BFD function from the peer
group. If the value is false, peers are disabled to inherit the BFD function from
the peer group.
is_bfd_enable:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, BFD is enabled. If the value is false, BFD is disabled.
is_log_change:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, BGP is enabled to record peer session status and event information.
If the value is false, BGP is disabled from recording peer session status and event
information.
is_single_hop:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, the system is enabled to preferentially use the single-hop
mode for BFD session setup between IBGP peers. If the value is false, the system
is disabled from preferentially using the single-hop mode for BFD session setup
between IBGP peers.
local_if_name:
description:
- Name of a source interface that sends BGP packets. The value is a string of 1 to
63 characters.
min_hold_time:
description:
- Specify the Min hold time of a peer or peer group.
route_refresh:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, BGP is enabled to advertise REFRESH packets. If the value
is false, the route refresh function is enabled.
key_chain_name:
description:
- Specify the Keychain authentication name used when BGP peers establish a TCP connection.
The value is a string of 1 to 47 case-insensitive characters.
valid_ttl_hops:
description:
- Enable GTSM on a peer or peer group. The valid-TTL-Value parameter is used to specify
the number of TTL hops to be detected. The value is an integer ranging from 1 to
255.
conn_retry_time:
description:
- ConnectRetry interval. The value is an integer ranging from 1 to 65535.
keep_alive_time:
description:
- Specify the Keepalive time of a peer or peer group. The value is an integer ranging
from 0 to 21845. The default value is 60.
prepend_fake_as:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- Add the Fake AS number to received Update packets.
pswd_cipher_text:
description:
- The character string in a password identifies the contents of the password, spaces
not supported. The value is a string of 1 to 255 characters.
prepend_global_as:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- Add the global AS number to the Update packets to be advertised.
mpls_local_ifnet_disable:
choices:
- no_use
- 'true'
- 'false'
default: no_use
description:
- If the value is true, peer create MPLS Local IFNET disable. If the value is false,
peer create MPLS Local IFNET enable.
changed:
description: check to see if a change was made on the device
returned: always
sample: true
type: bool
end_state:
description: k/v pairs of aaa params after module execution
returned: always
sample:
bgp peer:
- - 192.168.10.10
- '500'
type: dict
existing:
description: k/v pairs of existing aaa server
returned: always
sample:
bgp peer: []
type: dict
proposed:
description: k/v pairs of parameters passed into module
returned: always
sample:
peer_addr: 192.168.10.10
remote_as: '500'
state: present
vrf_name: js
type: dict
updates:
description: command sent to the device
returned: always
sample:
- peer 192.168.10.10 as-number 500
type: list