This role facilitates the configuration of border gateway protocol (BGP) attributes. It supports the configuration of router ID, networks, neighbors, and maximum path. This role is abstracted for dellos9, dellos6, and dellos10 devices.
The BGP role requires an SSH connection for connectivity to a Dell EMC Networking device. You can use any of the built-in OS connection variables.
ansible-galaxy install Dell-Networking.dellos-bgp
- Role is abstracted using the ansible_network_os variable that can take dellos9, dellos6, and dellos10 values
- If variable dellos_cfg_generate is set to true, it generates the role configuration commands in a file
- Any role variable with a corresponding state variable setting to absent negates the configuration of that variable
- Setting an empty value for any variable negates the corresponding configuration
- Variables and values are case-sensitive
dellos_bgp keys
| Key | Type | Description | Support |
|---|---|---|---|
asn |
string (required) | Configures the autonomous system (AS) number of the local BGP instance | dellos6, dellos9, dellos10 |
router_id |
string | Configures the IP address of the local BGP router instance | dellos6, dellos9, dellos10 |
graceful_restart |
boolean | Configures graceful restart capability | dellos9, dellos10 |
graceful_restart.state |
string: absent,present* | Removes graceful restart capability if set to absent | dellos9 |
maxpath_ibgp |
integer | Configures the maximum number of paths to forward packets through iBGP (1 to 64; default 1) | dellos6, dellos9, dellos10 |
maxpath_ebgp |
integer | Configures the maximum number of paths to forward packets through eBGP (1 to 64; default 1) | dellos6, dellos9, dellos10 |
log_neighbor_changes |
boolean | Configures log neighbors up/down | dellos10 |
fast_ext_fallover |
boolean | Configures a reset session if a link to a directly connected external peer goes down | dellos10 |
always_compare_med |
boolean | Configures comparing MED from different neighbors | dellos10 |
default_loc_pref |
integer | Configures the default local preference value | dellos10 |
confederation |
dictionary | Configures AS confederation parameters (see confederation.*) |
dellos10 |
confederation.identifier |
integer | Configures routing domain confederation AS | dellos10 |
confederation.peers |
string | Configures peer ASs in BGP confederation | dellos10 |
confederation.peers_state |
string: absent,present* | Deletes peer ASs in BGP confederation if set to absent | dellos10 |
route_reflector |
dictionary | Configures route reflection parameters (see route_reflector.*) |
dellos10 |
route_reflector.client_to_client |
boolean | Configures client-to-client route reflection | dellos10 |
route_reflector.cluster_id |
string | Configures the route-reflector cluster-id | dellos10 |
address_family_ipv4 |
dictionary | Configures IPv4 address family parameters (see address_family_ipv4.*) |
dellos10 |
address_family_ipv4.aggregate_addr |
list | Configures IPv4 BGP aggregate entries (see aggregate_addr.*) |
dellos10 |
aggregate_addr.ip_and_mask |
string | Configures the IPv4 BGP aggregate address | dellos10 |
address_family_ipv4.summary_only |
boolean | Sets address to summary-only if true | dellos10 |
aggregate_addr.state |
string: absent,present* | Deletes an IPv4 BGP aggregate entry if set to absent | dellos10 |
address_family_ipv4.dampening |
dictionary | Configures route-flap dampening (see dampening.*) |
dellos10 |
dampening.value |
dictionary | Configures dampening values ( format; default 15 750 2000 60) | dellos10 |
dampening.route_map |
string | Configures the route-map to specify criteria for dampening | dellos10 |
dampening.state |
string: absent,present* | Deletes dampening if set to absent | dellos10 |
address_family_ipv6 |
dictionary | Configures IPv6 address family parameters (see address_family_ipv6.*) |
dellos10 |
address_family_ipv6.aggregate_addr |
list | Configures IPv6 BGP aggregate entries (see aggregate_addr.*) |
dellos10 |
aggregate_addr.ip_and_mask |
string | Configures the IPv6 BGP aggregate address | dellos10 |
address_family_ipv6.summary_only |
boolean | Sets address to summary-only if true | dellos10 |
aggregate_addr.state |
string: absent,present* | Deletes an IPv6 BGP aggregate entry if set to absent | dellos10 |
address_family_ipv6.dampening |
dictionary | Configures route-flap dampening (see dampening.*) |
dellos10 |
dampening.value |
dictionary | Configures dampening values ( format; default 15 750 2000 60) | dellos10 |
dampening.route_map |
string | Configures the route-map to specify criteria for dampening | dellos10 |
dampening.state |
string: absent,present* | Deletes dampening if set to absent | dellos10 |
best_path |
list | Configures the default best-path selection (see best_path.*) |
dellos9, dellos10 |
best_path.as_path |
string (required): ignore,multipath-relax | Configures the AS path used for the best-path computation | dellos9, dellos10 |
best_path.as_path_state |
string: absent,present* | Deletes the AS path configuration if set to absent | dellos9, dellos10 |
best_path.ignore_router_id |
boolean: true,false | Ignores the router identifier in best-path computation if set to true | dellos9, dellos10 |
best_path.med |
list | Configures the MED attribute (see med.*) |
dellos9, dellos10 |
med.attribute |
string (required): confed,missing-as-best | Configures the MED attribute used for the best-path computation | dellos9, dellos10 |
med.state |
string: absent,present* | Deletes the MED attribute if set to absent | dellos9, dellos10 |
ipv4_network |
list | Configures an IPv4 BGP networks (see ipv4_network.*) |
dellos6, dellos9, dellos10 |
ipv4_network.address |
string (required) | Configures the IPv4 address of the BGP network (A.B.C.D/E format) | dellos6, dellos9, dellos10 |
ipv4_network.state |
string: absent,present* | Deletes an IPv4 BGP network if set to absent | dellos6, dellos9, dellos10 |
ipv6_network |
list | Configures an IPv6 BGP network (see ipv6_network.*) |
dellos6, dellos9, dellos10 |
ipv6_network.address |
string (required) | Configures the IPv6 address of the BGP network (2001:4898:5808:ffa2::1/126 format) | dellos6, dellos9, dellos10 |
ipv6_network.state |
string: absent,present* | Deletes an IPv6 BGP network if set to absent | dellos6, dellos9, dellos10 |
neighbor |
list | Configures IPv4 BGP neighbors (see neighbor.*) |
dellos6, dellos9, dellos10 |
neighbor.ip |
string (required) | Configures the IPv4 address of the BGP neighbor (10.1.1.1) | dellos6, dellos9, dellos10 |
neighbor.interface |
string | Configures the BGP neighbor interface details | dellos10 |
neighbor.name |
string (required) | Configures the BGP peer-group with this name; supported only when the neighbor is a peer group; mutually exclusive with neighbor.ip | dellos6, dellos9, dellos10 |
neighbor.type |
string (required): ipv4,ipv6,peergroup | Specifies the BGP neighbor type | dellos6, dellos9, dellos10 |
neighbor.password |
string | Configures the BGP neighbor password | dellos10 |
neighbor.peergroup_type |
string (ibgp, ebgp) | Configures the BGP neighbor peer group type | dellos10 |
neighbor.route_reflector_client |
boolean | Configures router reflector client on the BGP neighbor. | dellos10 |
neighbor.local_as |
integer | Configures the local AS for the BGP peer | dellos10 |
neighbor.weight |
integer | Configures the default weight for routes from the neighbor interface | dellos10 |
neighbor.send_community |
list | Configures the send community attribute to the BGP neighbor (see send_community.*) |
dellos10 |
send_community.type |
string (required) | Configures the send community attribute to the BGP neighbor | dellos10 |
send_community.state |
string: absent,present* | Deletes the send community attribute of the BGP neighbor if set to absent | dellos10 |
neighbor.address_family |
list | Configures address family commands on the BGP neighbor (see address_family.*) |
dellos10 |
address_family.type |
string (required): ipv4,ipv6,l2vpn | Configures IPv4/IPv6/EVPN address family command mode on the BGP neighbor | dellos10 |
address_family.activate |
boolean | Configures activation/deactivation of IPv4/IPv6 address family command mode on the BGP neighbor | dellos10 |
address_family.sender_loop_detect |
boolean | Enables/disables the sender-side loop detection process for a BGP neighbor of IPv4/IPv6/l2vpn address family | dellos10 |
address_family.allow_as_in |
integer | Configures the local AS number in the as-path | dellos10 |
address_family.next_hop_self |
boolean | Configures disabling the next-hop calculation for the neighbor | dellos10 |
address_family.soft_reconf |
boolean | Configures per neighbor soft reconfiguration | dellos10 |
address_family.add_path |
string | Configures send or receive multiple paths (value can be 'both ', 'send ', 'receive') | dellos10 |
address_family.route_map |
list | Configures the route-map on the BGP neighbor (see route_map.*) |
dellos10 |
route_map.name |
string | Configures the name of the route-map for the BGP neighbor | dellos10 |
route_map.filter |
string | Configures the filter for routing updates | dellos10 |
route_map.state |
string, choices: absent,present* | Deletes the route-map of the BGP neighbor if set to absent | dellos10 |
address_family.state |
string: absent,present* | Deletes the address family command mode of the BGP neighbor if set to absent | dellos10 |
neighbor.remote_asn |
string (required) | Configures the remote AS number of the BGP neighbor | dellos6, dellos9, dellos10 |
neighbor.remote_asn_state |
string: absent,present* | Deletes the remote AS number from the peer group if set to absent; supported only when neighbor.type is "peergroup" | dellos6, dellos9, dellos10 |
neighbor.timer |
string | Configures neighbor timers ( ); 5 10, where 5 is the keepalive interval and 10 is the holdtime | dellos6, dellos9, dellos10 |
neighbor.default_originate |
boolean: true, false* | Configures default originate routes to the BGP neighbor | dellos6, dellos9 |
neighbor.peergroup |
string | Configures neighbor to BGP peer-group (configured peer-group name) | dellos6, dellos9, dellos10 |
neighbor.peergroup_state |
string: absent,present* | Deletes the IPv4 BGP neighbor from the peer-group if set to absent | dellos6, dellos9, dellos10 |
neighbor.distribute_list |
list | Configures the distribute list to filter networks from routing updates (see distribute_list.*) |
dellos9, dellos10 |
distribute_list.in |
string | Configures the name of the prefix-list to filter incoming packets | dellos9, dellos10 |
distribute_list.in_state |
string: absent,present* | Deletes the filter at incoming packets if set to absent | dellos9, dellos10 |
distribute_list.out |
string | Configures the name of the prefix-list to filter outgoing packets | dellos9, dellos10 |
distribute_list.out_state |
string: absent,present* | Deletes the filter at outgoing packets if set to absent | dellos9, dellos10 |
neighbor.admin |
string: up,down | Configures the administrative state of the neighbor | dellos6, dellos9, dellos10 |
neighbor.adv_interval |
integer | Configures the advertisement interval of the neighbor | dellos9, dellos10 |
neighbor.fall_over |
string: absent,present | Configures the session fall on peer-route loss | dellos9, dellos10 |
neighbor.sender_loop_detect |
boolean: true,false | Enables/disables the sender-side loop detect for neighbors | dellos9, dellos10 |
neighbor.src_loopback |
integer | Configures the source loopback interface for routing packets | dellos6, dellos9, dellos10 |
neighbor.src_loopback_state |
string: absent,present* | Deletes the source for routing packets if set to absent | dellos6, dellos9 |
neighbor.ebgp_multihop |
integer | Configures the maximum-hop count value allowed in eBGP neighbors that are not directly connected (default 255) | dellos6, dellos9, dellos10 |
neighbor.passive |
boolean: true,false* | Configures the passive BGP peer group; supported only when neighbor is a peer-group | dellos9 |
neighbor.subnet |
string (required) | Configures the passive BGP neighbor to this subnet; required together with the neighbor.passive key for dellos9 devices | dellos6, dellos9, dellos10 |
neighbor.subnet_state |
string: absent,present* | Deletes the subnet range set for dynamic IPv4 BGP neighbor if set to absent | dellos6, dellos9, dellos10 |
neighbor.limit |
integer | Configures maximum dynamic peers count (key is required together with neighbor.subnet) |
dellos10 |
neighbor.bfd |
boolean | Enables BDF for neighbor | dellos10 |
neighbor.description |
string | Configures neighbor description | dellos10 |
neighbor.state |
string: absent,present* | Deletes the IPv4 BGP neighbor if set to absent | dellos6, dellos9, dellos10 |
redistribute |
list | Configures the redistribute list to get information from other routing protocols (see redistribute.*) |
dellos6, dellos9, dellos10 |
redistribute.route_type |
string (required): static,connected | Configures the name of the routing protocol to redistribute | dellos6, dellos9, dellos10 |
redistribute.route_map_name |
string | Configures the route-map to redistribute | dellos9, dellos10 |
redistribute.route_map |
string: absent,present* | Deletes the route-map to redistribute if set to absent | dellos9, dellos10 |
redistribute.address_type |
string (required): ipv4,ipv6 | Configures the address type of IPv4 or IPv6 routes | dellos6, dellos9, dellos10 |
redistribute.state |
string: absent,present* | Deletes the redistribution information if set to absent | dellos6, dellos9, dellos10 |
vrf |
dictionary | Enables VRF under BGP | dellos10 |
vrf.name |
string (Required) | Configures VRF name | dellos10 |
vrf.router_id |
string | Configures Router ID for VRF | dellos10 |
vrf.address_family |
dictionary | Enables address familyaddress | dellos10 |
vrf.address_family.type |
string (required): ipv4,ipv6 | Configures address type ipv4 or ipv6 | dellos10 |
vrf.redistribute |
dictionary | Enables redistribute option | dellos10 |
vrf.redistribute.route_type |
string (l2vpn, ospf, bgp, connected) | Configure redistribute type | dellos10 |
vrf.redistribute.address_type |
string (required): ipv4,ipv6 | Configures address type ipv4 or ipv6 | dellos10 |
vrf.redistribute.state |
string (required) | Configures the state as present or absent | dellos10 |
vrf.neighbor |
list | Configures IPv4 BGP neighbors under vrf | dellos10 |
vrf.neighbor.admin |
string: up,down | Configures the administrative state of the neighbor in vrf | dellos10 |
vrf.neighbor.type |
string : ipv4,ipv6 | Specifies the BGP neighbor type under vrf | dellos10 |
vrf.neighbor.ip |
string | Configures the IP address of the BGP neighbor in vrf | dellos10 |
vrf.neighbor.interface |
string | Configures the BGP neighbor interface in vrf | dellos10 |
vrf.neighbor.remote_asn |
integer | Configures the remote AS for the BGP peer in vrf | dellos10 |
bfd_all_neighbors |
dictionary | Enables BFD for all BGP neighbors | dellos10 |
bfd_all_neighbors.interval |
integer: 100 to 1000 | Configures time interval for sending control packets to BFD peers in ms | dellos10 |
bfd_all_neighbors.min_rx |
integer: 100 to 1000 | Configures maximum waiting time for receiving control packets from BFD peers in ms | dellos10 |
bfd_all_neighbors.multiplier |
integer: 3 to 50 | Configures maximum number of consecutive packets that are not received from BFD peers before session state changes to down | dellos10 |
bfd_all_neighbors.role |
string: active, passive | Configures BFD role | dellos10 |
bfd_all_neighbors.state |
string: absent,present* | Deletes BFD for all neighbors if set to absent | dellos10 |
state |
string: absent,present* | Deletes the local router BGP instance if set to absent | dellos6, dellos9, dellos10 |
vrf |
dictionary | Enables VRF for BGP neighbors | dellos10 |
vrf.name |
string (Required) | Configures VRF name | dellos10 |
vrf.address_type |
string (required): ipv4,ipv6 | Configures address type IPv4 or IPv6 | dellos10 |
vrf.redistribute |
dictionary | Enables redistribute option | dellos10 |
redistribute.route_type |
string (l2vpn, ospf, bgp, connected) | Configure redistribute type | dellos10 |
NOTE: Asterisk (*) denotes the default value if none is specified.
Ansible Dell EMC Networking roles require connection information to establish communication with the nodes in your inventory. This information can exist in the Ansible group_vars or host_vars directories or inventory, or in the playbook itself.
| Key | Required | Choices | Description |
|---|---|---|---|
ansible_host |
yes | Specifies the hostname or address for connecting to the remote device over the specified transport | |
ansible_port |
no | Specifies the port used to build the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_PORT option is used; it defaults to 22 | |
ansible_ssh_user |
no | Specifies the username that authenticates the CLI login for the connection to the remote device; if value is unspecified, the ANSIBLE_REMOTE_USER environment variable value is used | |
ansible_ssh_pass |
no | Specifies the password that authenticates the connection to the remote device | |
ansible_become |
no | yes, no* | Instructs the module to enter privileged mode on the remote device before sending any commands; if value is unspecified, the ANSIBLE_BECOME environment variable value is used, and the device attempts to execute all commands in non-privileged mode |
ansible_become_method |
no | enable, sudo* | Instructs the module to allow the become method to be specified for handling privilege escalation; if value is unspecified, the ANSIBLE_BECOME_METHOD environment variable value is used |
ansible_become_pass |
no | Specifies the password to use if required to enter privileged mode on the remote device; if ansible_become is set to no this key is not applicable |
|
ansible_network_os |
yes | dellos6/dellos9/dellos10, null* | Loads the correct terminal and cliconf plugins to communicate with the remote device |
NOTE: Asterisk (*) denotes the default value if none is specified.
The dellos-bgp role is built on modules included in the core Ansible code. These modules were added in Ansible version 2.2.0.
This example uses the dellos.dellos-bgp role to configure the BGP network and neighbors. It creates a hosts file with the switch details, a host_vars file with connection variables and the corresponding role variables.
When dellos_cfg_generate is set to true, the variable generates the configuration commands as a .part file in build_dir path. By default, the variable is set to false. This example writes a simple playbook that only references the dellos-bgp role. The sample host_vars given below is for dellos9.
Sample hosts file
leaf1 ansible_host= <ip_address>
Sample host_vars/leaf1
hostname: leaf1
ansible_become: yes
ansible_become_method: xxxxx
ansible_become_pass: xxxxx
ansible_ssh_user: xxxxx
ansible_ssh_pass: xxxxx
ansible_network_os: dellos9
build_dir: ../temp/dellos9
dellos_bgp:
asn: 11
router_id: 192.168.3.100
maxpath_ibgp: 2
maxpath_ebgp: 2
graceful_restart: true
vrf :
name: "GREEN"
router_id: 172.17.0.3
address_family:
type: ipv4
redistribute:
- route_type: l2vpn
address_type: ipv4
state: present
neighbor:
- type: ipv4
ip: "172.16.1.1"
remote_asn: 65400
admin: up
best_path:
as_path: ignore
ignore_router_id: true
med:
- attribute: confed
state: present
- attribute: missing-as-best
state: present
ipv4_network:
- address: 102.1.1.0/30
state: present
ipv6_network:
- address: "2001:4898:5808:ffa0::/126"
state: present
neighbor:
- ip: 192.168.10.2
type: ipv4
remote_asn: 12
timer: 5 10
adv_interval: 40
fall_over: present
default_originate: False
peergroup: per
peergroup_state: present
sender_loop_detect: false
src_loopback: 1
src_loopback_state: present
distribute_list:
in: aa
in_state: present
ebgp_multihop: 25
admin: up
state: present
- ip: 2001:4898:5808:ffa2::1
type: ipv6
remote_asn: 14
peergroup: per
peergroup_state: present
distribute_list:
in: aa
in_state: present
src_loopback: 0
src_loopback_state: present
ebgp_multihop: 255
admin: up
state: present
- name: peer1
type: peergroup
remote_asn: 14
distribute_list:
in: an
in_state: present
out: bb
out_state: present
passive: True
subnet: 10.128.4.192/27
subnet_state: present
state: present
redistribute:
- route_type: static
route_map_name: aa
state: present
address_type: ipv4
- route_type: connected
address_type: ipv6
state: present
state: present
Simple playbook to configure BGP - leaf.yaml
- hosts: leaf1
roles:
- Dell-Networking.dellos-bgp
Run
ansible-playbook -i hosts leaf.yaml
(c) 2017-2019 Dell Inc. or its subsidiaries. All Rights Reserved.