W3cubDocs

/Ansible

ce_evpn_bgp - Manages BGP EVPN configuration on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis

This module offers the ability to configure a BGP EVPN peer relationship on HUAWEI CloudEngine switches.

Options

parameter	required	default	choices	comments
advertise_l2vpn_evpn	no		enable disable	Enable or disable a device to advertise IP routes imported to a VPN instance to its EVPN instance.
advertise_router_type	no		arp irb	Configures a device to advertise routes to its BGP EVPN peers.
as_number	no			Specifies integral AS number. The value is an integer ranging from 1 to 4294967295.
bgp_instance	yes			Name of a BGP instance. The value is a string of 1 to 31 case-sensitive characters, spaces not supported.
peer_address	no			Specifies the IPv4 address of a BGP EVPN peer. The value is in dotted decimal notation.
peer_enable	no		true false	Enable or disable a BGP device to exchange routes with a specified peer or peer group in the address family view.
peer_group_name	no			Specify the name of a peer group that BGP peers need to join. The value is a string of 1 to 47 case-sensitive characters, spaces not supported.
state	no	present	present absent	Manage the state of the resource.
vpn_name	no			Associates a specified VPN instance with the IPv4 address family. The value is a string of 1 to 31 case-sensitive characters, spaces not supported.

Examples

- name: evpn bgp module 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 peer address.
    ce_evpn_bgp:
      bgp_instance: 100
      peer_address: 1.1.1.1
      as_number: 100
      peer_enable: true
      provider: "{{ cli }}"

  - name: Enable peer group arp.
    ce_evpn_bgp:
      bgp_instance: 100
      peer_group_name: aaa
      advertise_router_type: arp
      provider: "{{ cli }}"

  - name: Enable advertise l2vpn evpn.
    ce_evpn_bgp:
      bgp_instance: 100
      vpn_name: aaa
      advertise_l2vpn_evpn: enable
      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 configuration after module execution	verbose mode	dict	{'vpn_name': 'aaa', 'bgp_instance': '100', 'advertise_l2vpn_evpn': 'enable'}
changed	check to see if a change was made on the device	always	boolean	True
updates	command sent to the device	always	list	['peer 1.1.1.1 enable', 'peer aaa advertise arp']
proposed	k/v pairs of parameters passed into module	always	dict	{'advertise_router_type': 'arp', 'state': 'present', 'bgp_instance': '100', 'peer_group_name': 'aaa'}
existing	k/v pairs of existing rollback	always	dict	{'peer_group_advertise_type': [], 'bgp_instance': '100'}

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_evpn_bgp_module.html