Docs4dev
Docs
ansible / 2.4 / ce_evpn_bgp_rr_module.html

ce_evpn_bgp_rr - Manages RR for the VXLAN Network on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Configure an RR in BGP-EVPN address family view on HUAWEI CloudEngine switches.

Options

parameter required default choices comments
as_number
 yes
Specifies the number of the AS, in integer format. The value is an integer that ranges from 1 to 4294967295.
bgp_evpn_enable
 no enable
  • enable
  • disable
Enable or disable the BGP-EVPN address family.
bgp_instance
 no
Specifies the name of a BGP instance. The value of instance-name can be an integer 1 or a string of 1 to 31.
peer
 no
Specifies the IPv4 address or the group name of a peer.
peer_type
 no
  • group_name
  • ipv4_address
Specify the peer type.
policy_vpn_target
 no
  • enable
  • disable
Enable or disable the VPN-Target filtering.
reflect_client
 no
  • enable
  • disable
Configure the local device as the route reflector and the peer or peer group as the client of the route reflector.

Examples

- name: BGP RR 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: "Configure BGP-EVPN address family view and ensure that BGP view has existed."
    ce_evpn_bgp_rr:
      as_number: 20
      bgp_evpn_enable: enable
      provider: "{{ cli }}"

  - name: "Configure reflect client and ensure peer has existed."
    ce_evpn_bgp_rr:
      as_number: 20
      peer_type: ipv4_address
      peer: 192.8.3.3
      reflect_client: enable
      provider: "{{ cli }}"

  - name: "Configure the VPN-Target filtering."
    ce_evpn_bgp_rr:
      as_number: 20
      policy_vpn_target: enable
      provider: "{{ cli }}"

  - name: "Configure an RR in BGP-EVPN address family view."
    ce_evpn_bgp_rr:
      as_number: 20
      bgp_evpn_enable: enable
      peer_type: ipv4_address
      peer: 192.8.3.3
      reflect_client: enable
      policy_vpn_target: disable
      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
changed
check to see if a change was made on the device
always boolean True
end_state
k/v pairs of end attributes on the device
always dict {'as_number': '20', 'bgp_instance': None, 'reflect_client': 'enable', 'peer': '192.8.3.3', 'bgp_evpn_enable': 'enable', 'policy_vpn_target': 'disable', 'peer_type': 'ipv4_address'}
existing
k/v pairs of existing attributes on the device
always dict {'as_number': '20', 'bgp_instance': None, 'reflect_client': 'disable', 'peer': None, 'bgp_evpn_enable': 'disable', 'policy_vpn_target': 'disable', 'peer_type': None}
proposed
k/v pairs of parameters passed into module
always dict {'as_number': '20', 'bgp_instance': None, 'reflect_client': 'enable', 'peer': '192.8.3.3', 'bgp_evpn_enable': 'enable', 'policy_vpn_target': 'disable', 'peer_type': 'ipv4_address'}
updates
command list sent to the device
always list ['bgp 20', ' l2vpn-family evpn', ' peer 192.8.3.3 enable', ' peer 192.8.3.3 reflect-client', ' undo policy vpn-target']

Notes

Note

  • Ensure that BGP view is existed.
  • The peer, peer_type, and reflect_client arguments must all exist or not exist.

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–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_evpn_bgp_rr_module.html