nornir-scrapli-eos-lab
Network automation lab using nornir, scrapli, and containerlab with Arista EOS.
Objectives
- Deploy base configs to 4xArista devices via scrapli
- Deploy interface configs
- Deploy underlay BGP configs to
- Deploy overlay BGP EVPN configs
- Provision vxlan across leaf nodes with user-defined parameters
Tools
- Containerlab (https://containerlab.srlinux.dev/)
- nornir (https://github.com/nornir-automation/nornir)
- nornir_utils (https://github.com/nornir-automation/nornir_utils)
- nornir-jinja2 (https://github.com/nornir-automation/nornir_jinja2)
- nornir-scrapli (https://github.com/scrapli/nornir_scrapli)
My environment
- Ubuntu Server 20.04 LTS x86_64 with 32GB RAM running in VirtualBox (Windows 10 Pro). This lab only consumes a bit less than 4GB of RAM.
- Containerlab version 0.16.2 (any later version should do)
- Docker 20.10.8
Containerlab
Containerlab provides a CLI for orchestrating and managing container-based networking labs. Follow the instruction in the containerlab website to install it for Linux. https://containerlab.srlinux.dev/install/
Arista ceos images
Arista is kind enough to provide docker images of their EOS routing platform for learning and testing purpose via their website together with the instruction to get it to work with Docker. I'm using ceosimage:4.26.1F
Setup
Clone the repo:
git clone https://github.com/vireakouk/nornir-scrapli-eos-lab.git
Create a Python3 virtual environment in the project directory:
python3 -m venv env
Activate virtual environment:
source env/bin/activate
and install the following:
pip install nornir
pip install nornir-scrapli
pip install nornir_utils
pip install nornir-jinja2
or use requirements.txt
pip install -r requirements.txt
Spinning up the lab
cd containerlab/
sudo containerlab deploy -t eos.clab.yml
(use "sudo containerlab deploy -t eos.clab.yml --reconfigure" to do a clean boot if you run it not for the first time.)
Wait for a minute or two for all devices to boot up and make sure you can ssh to each device using admin/admin credential. Scrapli in this case use ssh port 22 as transport.
Deploy base config (deploy_baseconfig.py)
cd nornir-scrapli-eos-lab/
python deploy_baseconfig.py
This simple script achieves the following:
- create a user account,
- enable ip routing,
- config loopback0 interface with ipv4 and ipv6,
It does those by:
- Generate a temporary config per device by filling the template file templates/base.j2 with the hosts variables in the inventory files (hosts.yml, groups.yml, and defaults.yml)
r = task.run(task=template_file,
template="base.j2",
path="./templates")
- Store the resultant config to each specific host variable dictionary with an abitary key "config" :
task.host["config"] = r.result
- Send the config to device using scrapli send_config method:
task.run(task=send_config,
name="Deploy base configuration on the device.",
dry_run=False,
config=task.host["config"])
- Display the new changed config using scrapli send_command method:
task.run(task=send_commands,
name="Show new config and copy running config to startup config.",
commands=["show run", "write memory"])
Deploy interface configs (deploy_interfaces.py)
cd nornir-scrapli-eos-lab/
python deploy_interfaces.py
This simple script achieves the following:
- config interfaces with description, ipv4, ipv6, disable switchport
- enable the interface with "no shutdown"
It does those by:
- Generate a temporary config per device by filling the template file templates/interfaces.j2 by looping through interface values in hosts variables in the inventory files (hosts.yml)
r = task.run(task=template_file,
template="interfaces.j2",
path="./templates")
- Store the resultant config to each specific host variable dictionary with an abitary key "config" :
task.host["config"] = r.result
- Send the config to device using scrapli send_config method:
task.run(task=send_config,
name="Configuring interfaces!",
dry_run=False,
config=task.host["config"])
- Display the new changed config using scrapli send_command method:
task.run(task=send_commands,
name="Show new config and copy running config to startup config.",
commands=["show run", "write memory"])
Verify results of interface configs
After the deployment, if there is no error, you should be able to ping adjacent interfaces. If you can't, check the nornir.log for clues on the errors.
Deploy underlay BGP configs (deploy_underlay.py)
Follow the same concepts as the two previous tasks but using "templates/underlay.j2" instead.
Verify results of underlay configs
After the deployment, if there is no error, you should see all bgp adjacencies established.
spine1#show ip bgp summary
BGP summary information for VRF default
Router identifier 1.1.1.1, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
10.1.1.1 4 65001 9 8 0 0 00:02:36 Estab 2 2
10.1.1.3 4 65002 8 9 0 0 00:02:36 Estab 2 2
spine1#show ipv6 bgp summary
BGP summary information for VRF default
Router identifier 1.1.1.1, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
2010:1:1:2::1 4 65001 22 22 0 0 00:11:37 Estab 3 3
2010:1:1:2::3 4 65002 20 19 0 0 00:11:38 Estab 3 3
spine1#
spine2#show ip bgp sum
BGP summary information for VRF default
Router identifier 1.1.1.2, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
10.1.1.5 4 65001 18 17 0 0 00:10:19 Estab 3 3
10.1.1.7 4 65002 19 20 0 0 00:10:19 Estab 3 3
spine2#show ipv6 bgp sum
BGP summary information for VRF default
Router identifier 1.1.1.2, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
2010:1:1:2::5 4 65001 19 21 0 0 00:12:04 Estab 2 2
2010:1:1:2::7 4 65002 19 19 0 0 00:12:04 Estab 2 2
spine2#
leaf1#show ip bgp summary
BGP summary information for VRF default
Router identifier 1.1.1.3, local AS number 65001
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
10.1.1.0 4 65000 18 18 0 0 00:10:46 Estab 2 2
10.1.1.4 4 65000 18 19 0 0 00:10:45 Estab 2 2
leaf1#show ipv6 bgp sum
BGP summary information for VRF default
Router identifier 1.1.1.3, local AS number 65001
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
2010:1:1:2:: 4 65000 22 23 0 0 00:12:22 Estab 3 3
2010:1:1:2::4 4 65000 21 20 0 0 00:12:22 Estab 3 3
leaf1#
leaf2#show ip bgp summary
BGP summary information for VRF default
Router identifier 1.1.1.4, local AS number 65002
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
10.1.1.2 4 65000 19 18 0 0 00:11:13 Estab 3 3
10.1.1.6 4 65000 21 20 0 0 00:11:13 Estab 3 3
leaf2#show ipv6 bgp summary
BGP summary information for VRF default
Router identifier 1.1.1.4, local AS number 65002
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
2010:1:1:2::2 4 65000 20 22 0 0 00:12:44 Estab 2 2
2010:1:1:2::6 4 65000 20 20 0 0 00:12:43 Estab 2 2
leaf2#
leaf1#show ip bgp
BGP routing table information for VRF default
Router identifier 1.1.1.3, local AS number 65001
Route status codes: s - suppressed, * - valid, > - active, E - ECMP head, e - ECMP
S - Stale, c - Contributing to ECMP, b - backup, L - labeled-unicast
% - Pending BGP convergence
Origin codes: i - IGP, e - EGP, ? - incomplete
RPKI Origin Validation codes: V - valid, I - invalid, U - unknown
AS Path Attributes: Or-ID - Originator ID, C-LST - Cluster List, LL Nexthop - Link Local Nexthop
Network Next Hop Metric AIGP LocPref Weight Path
* > 1.1.1.1/32 10.1.1.0 0 - 100 0 65000 i
* > 1.1.1.2/32 10.1.1.4 0 - 100 0 65000 i
* > 1.1.1.3/32 - - - - 0 i
* >Ec 1.1.1.4/32 10.1.1.0 0 - 100 0 65000 65002 i
* ec 1.1.1.4/32 10.1.1.4 0 - 100 0 65000 65002 i
leaf1#
Deploy overlay BGP configs (deploy_overlay.py)
Follow the same concepts as the two previous tasks but using "templates/overlay.j2" instead.
Verify results of overlay configs
spine1#show bgp evpn summary
BGP summary information for VRF default
Router identifier 1.1.1.1, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
1.1.1.3 4 65001 23 24 0 0 00:16:51 Estab 0 0
1.1.1.4 4 65002 23 24 0 0 00:16:51 Estab 0 0
2001:1:1:1::3 4 65001 23 23 0 0 00:16:51 Estab 0 0
2001:1:1:1::4 4 65002 23 23 0 0 00:16:51 Estab 0 0
spine1#
spine2#show bgp evpn summary
BGP summary information for VRF default
Router identifier 1.1.1.2, local AS number 65000
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
1.1.1.3 4 65001 25 25 0 0 00:17:24 Estab 0 0
1.1.1.4 4 65002 24 24 0 0 00:17:24 Estab 0 0
2001:1:1:1::3 4 65001 23 24 0 0 00:17:24 Estab 0 0
2001:1:1:1::4 4 65002 24 26 0 0 00:17:24 Estab 0 0
spine2#
leaf1#show bgp evpn summary
BGP summary information for VRF default
Router identifier 1.1.1.3, local AS number 65001
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
1.1.1.1 4 65000 22 21 0 0 00:15:13 Estab 0 0
1.1.1.2 4 65000 22 22 0 0 00:15:13 Estab 0 0
2001:1:1:1::1 4 65000 21 21 0 0 00:15:13 Estab 0 0
2001:1:1:1::2 4 65000 22 21 0 0 00:15:13 Estab 0 0
leaf1#
leaf2#show bgp evpn summary
BGP summary information for VRF default
Router identifier 1.1.1.4, local AS number 65002
Neighbor Status Codes: m - Under maintenance
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State PfxRcd PfxAcc
1.1.1.1 4 65000 25 25 0 0 00:18:04 Estab 0 0
1.1.1.2 4 65000 24 25 0 0 00:18:04 Estab 0 0
2001:1:1:1::1 4 65000 25 25 0 0 00:18:03 Estab 0 0
2001:1:1:1::2 4 65000 26 26 0 0 00:18:04 Estab 0 0
leaf2#
Provision Vxlan (provision_l2vxlan.py)
The script takes user inputs such as vlan ID, VNI, name, A-end device, and B-end. It stores the user input in the host dictionary with abitrary key ["vxlan"] and deploy the configs to devices of user's inputs in A-end and B-end.
from nornir import InitNornir
from nornir.core.task import Task, Result
from nornir.core.filter import F
from nornir_utils.plugins.functions import print_result
from nornir_jinja2.plugins.tasks import template_file
from nornir_scrapli.tasks import send_commands, send_config
def deploy_l2vxlan(task: Task, data: dict) -> Result:
task.host["vxlan"] = data
r = task.run(task=template_file,
template="l2vxlan.j2",
path="./templates")
task.host["config"] = r.result
task.run(task=send_config,
name="Provisioning L2 VXLAN!",
dry_run=False,
config=task.host["config"])
task.run(task=send_commands,
name="Show new config and copy running config to startup config.",
commands=["show run", "write memory"])
def get_input() -> dict:
print("*"*62)
print("* This script will provision L2 VxLAN circuit in leaf nodes. *")
print("*"*62)
data = {}
data["vlan_id"] = input("Enter the vlan ID (ex: 10): ")
data["vlan_name"] = input("Enter the vlan name (ex: CUST-ABC): ")
data["vni"] = input("Enter the vni (ex: 10010): ")
data["a_end"] = input("Enter the A-end switch name: ")
data["b_end"] = input("Enter the B-end switch name: ")
return data
if __name__ == "__main__":
user_input = get_input()
nr = InitNornir(config_file="config.yml")
try:
nr = nr.filter(F(switchname=user_input["a_end"]) | F(switchname=user_input["b_end"]))
r = nr.run(task=deploy_l2vxlan, data=user_input)
print_result(r)
except KeyError as e:
print(f"Could not find device: {e}")
~/projects/nornir-scrapli-eos-lab master* ❯ python provision_l2vxlan.py 8s nornir-scrapli-eos-lab
**************************************************************
* This script will provision L2 VxLAN circuit in leaf nodes. *
**************************************************************
Enter the vlan ID (ex: 10): 11
Enter the vlan name (ex: CUST-ABC): CUST-TEST
Enter the vni (ex: 10010): 10011
Enter the A-end switch name: leaf1
Enter the B-end switch name: leaf2
/home/vireak/projects/nornir-scrapli-eos-lab/env/lib/python3.8/site-packages/scrapli/helper.py:290: UserWarning:
******************************************************************************************** Authentication Warning! *********************************************************************************************
scrapli will try to escalate privilege without entering a password but may fail.
Set an 'auth_secondary' password if your device requires a password to increase privilege, otherwise ignore this message.
******************************************************************************************************************************************************************************************************************
warn(warning_message)
deploy_l2vxlan******************************************************************
* leaf1.eos ** changed : True **************************************************
vvvv deploy_l2vxlan ** changed : False vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv INFO
---- template_file ** changed : False ------------------------------------------ INFO
vlan 11
name CUST-TEST
!
interface vxlan 1
vxlan vlan 11 vni 10011
vxlan source-int loopback0
vxlan udp-port 4789
vxlan learn-restrict any
!
router bgp 65001
!
vlan 11
rd 65001:10011
route-target both 11:10011
redistribute learned
!
---- Provisioning L2 VXLAN! ** changed : True ---------------------------------- INFO
vlan 11
name CUST-TEST
!
interface vxlan 1
vxlan vlan 11 vni 10011
vxlan source-int loopback0
vxlan udp-port 4789
vxlan learn-restrict any
!
router bgp 65001
!
vlan 11
rd 65001:10011
route-target both 11:10011
redistribute learned
!
---- Show new config and copy running config to startup config. ** changed : False INFO
Verify vxlan provisioning
leaf1>show interfaces vxlan 1
Vxlan1 is up, line protocol is up (connected)
Hardware is Vxlan
Source interface is Loopback0 and is active with 1.1.1.3
Replication/Flood Mode is headend with Flood List Source: EVPN
Remote MAC learning via EVPN
VNI mapping to VLANs
Static VLAN to VNI mapping is
[64, 10064]
Note: All Dynamic VLANs used by VCS are internal VLANs.
Use 'show vxlan vni' for details.
Static VRF to VNI mapping is not configured
Headend replication flood vtep list is:
64 1.1.1.4
MLAG Shared Router MAC is 0000.0000.0000
leaf1>show vxlan vtep
Remote VTEPS for Vxlan1:
VTEP Tunnel Type(s)
------------- --------------
1.1.1.4 flood
Total number of remote VTEPS: 1
leaf1>
leaf2#show interfaces vxlan 1
Vxlan1 is up, line protocol is up (connected)
Hardware is Vxlan
Source interface is Loopback0 and is active with 1.1.1.4
Replication/Flood Mode is headend with Flood List Source: EVPN
Remote MAC learning via EVPN
VNI mapping to VLANs
Static VLAN to VNI mapping is
[11, 10011] [64, 10064]
Note: All Dynamic VLANs used by VCS are internal VLANs.
Use 'show vxlan vni' for details.
Static VRF to VNI mapping is not configured
Headend replication flood vtep list is:
11 1.1.1.3
64 1.1.1.3
MLAG Shared Router MAC is 0000.0000.0000
leaf2#show vxlan vtep
Remote VTEPS for Vxlan1:
VTEP Tunnel Type(s)
------------- --------------
1.1.1.3 flood
Total number of remote VTEPS: 1
leaf2#
Extension of script functionality
The template is standard jinja2 template which you can add more parameters to the base or interface configs. For example in base config, we can add further template for aaa, logging, ntp, logging..etc.
More configuration tasks
(coming soon)
170 Dec 02, 2022
37 Sep 23, 2022
9.6k Jan 02, 2023
249 Dec 14, 2022
299 Dec 24, 2022
8 Mar 13, 2022
1 Dec 13, 2021
7 Feb 02, 2022
76 Nov 25, 2022
212 Dec 24, 2022
5 Dec 31, 2021
255 Jan 04, 2023
7.7k Jan 07, 2023
546 Dec 22, 2022
4 Jan 21, 2022
4 Aug 26, 2022
31 Dec 24, 2022
2.3k Jan 04, 2023
4 Mar 30, 2022