ce_bgp – Manages BGP configuration on HUAWEI CloudEngine switches — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ce_bgp – Manages BGP configuration on HUAWEI CloudEngine switches

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages BGP configurations on HUAWEI CloudEngine switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
as_number - |  | Local AS number. The value is a string of 1 to 11 characters.
as_path_limit - |  | Maximum number of AS numbers in the AS_Path attribute. The default value is 255.
bgp_rid_auto_sel - | Choices: no_use ← true false | The function to automatically select router IDs for all VPN BGP instances is enabled.
check_first_as - | Choices: no_use ← true false | Check the first AS in the AS_Path of the update messages from EBGP peers.
clear_interval - |  | Clear interval.
confed_id_number - |  | Confederation ID. The value is a string of 1 to 11 characters.
confed_nonstanded - | Choices: no_use ← true false | Configure the device to be compatible with devices in a nonstandard confederation.
confed_peer_as_num - |  | Confederation AS number, in two-byte or four-byte format. The value is a string of 1 to 11 characters.
conn_retry_time - |  | ConnectRetry interval. The value is an integer, in seconds. The default value is 32s.
default_af_type - | Choices: 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 - | Choices: 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 - | Choices: no_use ← true false | Peer disconnection through GR.
graceful_restart - | Choices: no_use ← true false | Enable GR of the BGP speaker in the specified address family, peer address, or peer group.
hold_interval - |  | Hold interval.
hold_time - |  | Hold time, in seconds. The value of the hold time can be 0 or range from 3 to 65535.
is_shutdown - | Choices: no_use ← true false | Interrupt BGP all neighbor.
keep_all_routes - | Choices: 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 - |  | 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 - | Choices: no_use ← true false | Support BGP RIB memory protection.
min_hold_time - |  | Min hold time, in seconds. The value of the hold time can be 0 or range from 20 to 65535.
router_id - |  | ID of a router that is in IPv4 address format.
state - | Choices: present ← absent | Specify desired state of the resource.
suppress_interval - |  | Suppress interval.
time_wait_for_rib - |  | 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 - |  | Name of a BGP instance. The name is a case-sensitive string of characters.
vrf_rid_auto_sel - | Choices: 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.

## Notes

Note

- This module requires the netconf system service be enabled on the remote device being managed.
- Recommended connection is `netconf`.
- This module also works with `local` connections for legacy playbooks.

## 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, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
changed boolean | always | check to see if a change was made on the device Sample: True
end_state dictionary | always | k/v pairs of aaa params after module execution Sample: {'bgp_enable': [['100'], ['true']]}
existing dictionary | always | k/v pairs of existing aaa server Sample: {'bgp_enable': [['100'], ['true']]}
proposed dictionary | always | k/v pairs of parameters passed into module Sample: {'as_number': '100', 'state"': 'present'}
updates list | always | command sent to the device Sample: ['bgp 100']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- wangdezhuang (@QijunPan)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.