W3cubDocs

/Ansible

ce_bgp - Manages BGP configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages BGP configurations on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
as_number
 no
Local AS number. The value is a string of 1 to 11 characters.
as_path_limit
 no
Maximum number of AS numbers in the AS_Path attribute. The default value is 255.
bgp_rid_auto_sel
 no no_use
  • no_use
  • true
  • false
The function to automatically select router IDs for all VPN BGP instances is enabled.
check_first_as
 no no_use
  • no_use
  • true
  • false
Check the first AS in the AS_Path of the update messages from EBGP peers.
clear_interval
 no
Clear interval.
confed_id_number
 no
Confederation ID. The value is a string of 1 to 11 characters.
confed_nonstanded
 no no_use
  • no_use
  • true
  • false
Configure the device to be compatible with devices in a nonstandard confederation.
confed_peer_as_num
 no
Confederation AS number, in two-byte or four-byte format. The value is a string of 1 to 11 characters.
conn_retry_time
 no
ConnectRetry interval. The value is an integer, in seconds. The default value is 32s.
default_af_type
 no
  • ipv4uni
  • ipv6uni
Type of a created address family, which can be IPv4 unicast or IPv6 unicast. The default type is IPv4 unicast.
ebgp_if_sensitive
 no no_use
  • no_use
  • true
  • false
If the value is true, After the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are deleted immediately when the interface goes Down. If the value is false, After the fast EBGP interface awareness function is enabled, EBGP sessions on an interface are not deleted immediately when the interface goes Down.
gr_peer_reset
 no no_use
  • no_use
  • true
  • false
Peer disconnection through GR.
graceful_restart
 no no_use
  • no_use
  • true
  • false
Enable GR of the BGP speaker in the specified address family, peer address, or peer group.
hold_interval
 no
Hold interval.
hold_time
 no
Hold time, in seconds. The value of the hold time can be 0 or range from 3 to 65535.
is_shutdown
 no no_use
  • no_use
  • true
  • false
Interrupt BGP all neighbor.
keep_all_routes
 no no_use
  • no_use
  • true
  • false
If the value is true, the system stores all route update messages received from all peers (groups) after BGP connection setup. If the value is false, the system stores only BGP update messages that are received from peers and pass the configured import policy.
keepalive_time
 no
If the value of a timer changes, the BGP peer relationship between the routers is disconnected. The value is an integer ranging from 0 to 21845. The default value is 60.
memory_limit
 no no_use
  • no_use
  • true
  • false
Support BGP RIB memory protection.
min_hold_time
 no
Min hold time, in seconds. The value of the hold time can be 0 or range from 20 to 65535.
router_id
 no
ID of a router that is in IPv4 address format.
state
 no present
  • present
  • absent
Specify desired state of the resource.
suppress_interval
 no
Suppress interval.
time_wait_for_rib
 no
Period of waiting for the End-Of-RIB flag. The value is an integer ranging from 3 to 3000. The default value is 600.
vrf_name
 no
Name of a BGP instance. The name is a case-sensitive string of characters.
vrf_rid_auto_sel
 no no_use
  • no_use
  • true
  • false
If the value is true, VPN BGP instances are enabled to automatically select router IDs. If the value is false, VPN BGP instances are disabled from automatically selecting router IDs.

Examples

- name: CloudEngine BGP 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: "Enable BGP"
    ce_bgp:
      state: present
      as_number: 100
      confed_id_number: 250
      provider: "{{ cli }}"

  - name: "Disable BGP"
    ce_bgp:
      state: absent
      as_number: 100
      confed_id_number: 250
      provider: "{{ cli }}"

  - name: "Create confederation peer AS num"
    ce_bgp:
      state: present
      confed_peer_as_num: 260
      provider: "{{ cli }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
end_state
k/v pairs of aaa params after module execution
 always dict {'bgp_enable': [['100'], ['true']]}
changed
check to see if a change was made on the device
 always boolean True
updates
command sent to the device
 always list ['bgp 100']
proposed
k/v pairs of parameters passed into module
 always dict {'as_number': '100', 'state"': 'present'}
existing
k/v pairs of existing aaa server
 always dict {'bgp_enable': [['100'], ['true']]}

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ce_bgp_module.html