ansible.builtin.ce_bgp_neighbor (v2.5.12) — module

Install Ansible via pip

Install with pip install ansible==2.5.12

Description

Manages BGP peer configurations on HUAWEI CloudEngine switches.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify desired state of the resource.
    required: false

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.
    required: false

fake_as:
    default: null
    description:
    - Fake AS number that is specified for a local peer. The value is a string of 1 to
      11 characters.
    required: false

tcp_MSS:
    default: null
    description:
    - Maximum TCP MSS value used for TCP connection establishment for a peer. The value
      is an integer ranging from 176 to 4096.
    required: false

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:
    default: null
    description:
    - Specify the Hold time of a peer or peer group. The value is 0 or an integer ranging
      from 3 to 65535.
    required: false

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.
    required: false

peer_addr:
    description:
    - Connection address of a peer, which can be an IPv4 or IPv6 address.
    required: true

pswd_type:
    choices:
    - 'null'
    - cipher
    - simple
    default: null
    description:
    - Enable BGP peers to establish a TCP connection and perform the Message Digest 5
      (MD5) authentication for BGP messages.
    required: false

remote_as:
    description:
    - AS number of a peer. The value is a string of 1 to 11 characters.
    required: true

multiplier:
    default: null
    description:
    - Specify the detection multiplier. The default value is 3. The value is an integer
      ranging from 3 to 50.
    required: false

description:
    default: null
    description:
    - Description of a peer, which can be letters or digits. The value is a string of
      1 to 80 characters.
    required: false

rx_interval:
    default: null
    description:
    - Specify the minimum interval at which BFD packets are received. The value is an
      integer ranging from 50 to 1000, in milliseconds.
    required: false

tx_interval:
    default: null
    description:
    - Specify the minimum interval at which BFD packets are sent. The value is an integer
      ranging from 50 to 1000, in milliseconds.
    required: false

connect_mode:
    default: null
    description:
    - The value can be Connect-only, Listen-only, or Both.
    required: false

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.
    required: false

ebgp_max_hop:
    default: null
    description:
    - Maximum number of hops in an indirect EBGP connection. The value is an ranging from
      1 to 255.
    required: false

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.
    required: false

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.
    required: false

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.
    required: false

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.
    required: false

local_if_name:
    default: null
    description:
    - Name of a source interface that sends BGP packets. The value is a string of 1 to
      63 characters.
    required: false

min_hold_time:
    default: null
    description:
    - Specify the Min hold time of a peer or peer group.
    required: false

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.
    required: false

key_chain_name:
    default: null
    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.
    required: false

valid_ttl_hops:
    default: null
    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.
    required: false

conn_retry_time:
    default: null
    description:
    - ConnectRetry interval. The value is an integer ranging from 1 to 65535.
    required: false

keep_alive_time:
    default: null
    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.
    required: false

prepend_fake_as:
    choices:
    - no_use
    - 'true'
    - 'false'
    default: no_use
    description:
    - Add the Fake AS number to received Update packets.
    required: false

pswd_cipher_text:
    default: null
    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.
    required: false

prepend_global_as:
    choices:
    - no_use
    - 'true'
    - 'false'
    default: no_use
    description:
    - Add the global AS number to the Update packets to be advertised.
    required: false

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.
    required: false

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: boolean
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