Configure MPLS L3VPN service on PE router using REST-API (IOS-XE)

Size: px

Start display at page:

Download "Configure MPLS L3VPN service on PE router using REST-API (IOS-XE)"

Roy Garrett
5 years ago
Views:

1 Configure MPLS L3VPN service on PE router using REST-API (IOS-XE) Contents Introduction Prerequisites Configuration Network Diagram Configuration Procedure 1. Retrieve token-id 2. Create VRF 3. Move interface into a VRF 4. Assign IP address to interface 5. Create VRF aware bgp 6. Define BGP neighbor under VRF address family References Acronyms Used: Introduction This document demonstrates the use of Python programming to provision a MPLS L3VPN on a service Provider Edge (PE) router using REST API. This example uses Cisco CSR1000v (IOS-XE) routers as PE routers. Contributed by: Anuradha Perera Edited by: Kumar Sridhar Prerequisites REST API management access to CSR1000v routers (pleae refer to the References at the end of this document). Python (Version 2.x or 3.x) and "Requests" Python library installed on the computer used for configuring the routers. Some basic knowledge Python programming. Configuration Network Diagram

2 In this example focus is on configuring required MPLS L3VPN service parameters on PE-1 router, which are highlighted in pink color. Configuration Procedure The Configuration task is divided in to a number of sub-tasks and each sub-task is implemented under a user defined function. In this way functions can be re-used when required. All the functions use "Requests" library to access REST APIs on the router and data format is JSON. In HTTP requests verify parameter is set to False to ignore validating SSL certificate. 1. Retrieve token-id Before proceeding with any configuration on a router you need to have a valid token-id obtained from the router. This function initiates HTTP request to authenticate and obtain a token-id so that it can invoke other APIs using this token. Response of this request includes a token-id. def gettoken (ip, port, username, password): import base64 url = " + ip + ":"+ port + "/api/v1/auth/token-services" 'content-type': "application/json", 'authorization': "Basic " + base64.b64encode((username + ":" + password).encode('utf- 8')).decode('ascii'),

3 response = requests.request("post", url, headers=headers, verify=false ) if response.status_code == 200: return response.json()['token-id'] 2. Create VRF This function will create the VRF on PE router with required route distinguisher (RD) and import/export route targets (RT) def createvrf (ip, port, tokenid, vrfname, RD, importrt, exportrt): url = " + ip + ":"+ port + "/api/v1/vrf" 'content-type': "application/json", data = { 'name': vrfname, 'rd': RD, 'route-target' : [ { 'action' : "import",

4 'community' : importrt, { 'action' : "export", 'community' : exportrt ] response = requests.request("post", url, headers=headers, json=data, verify=false ) if response.status_code == 201: return "successful" 3. Move interface into a VRF This function will move a given interface into a VRF. def addinterfacetovrf (ip, port, tokenid, vrfname, interfacename, RD, importrt, exportrt): url = " + ip + ":"+ port + "/api/v1/vrf/" + vrfname 'content-type': "application/json", data = {

5 'rd': RD, 'forwarding': [ interfacename ], 'route-target' : [ { 'action' : "import", 'community' : importrt, { 'action' : "export", 'community' : exportrt ] response = requests.request("put", url, headers=headers, json=data, verify=false ) if response.status_code == 204: return "successful" 4. Assign IP address to interface This function will assign ip address to the interface. def assigninterfaceip (ip, port, tokenid, interfacename, interfaceip, interfacesubnet): url = " + ip + ":"+ port + "/api/v1/interfaces/" + interfacename

6 'content-type': "application/json", data = { 'type': "ethernet", 'if-name': interfacename, 'ip-address': interfaceip, 'subnet-mask': interfacesubnet response = requests.request("put", url, headers=headers, json=data, verify=false ) if response.status_code == 204: return "successful" 5. Create VRF aware bgp This will enable VRF address family ipv4. def createvrfbgp (ip, port, tokenid, vrfname, ASN): url = " + ip + ":"+ port + "/api/v1/vrf/" + vrfname + "/routing-svc/bgp" 'content-type': "application/json",

7 data = { 'routing-protocol-id': ASN response = requests.request("post", url, headers=headers, json=data, verify=false ) if response.status_code == 201: return "successful" 6. Define BGP neighbor under VRF address family This function will define BGP neighbor under VRF address family IPV4. def definevrfbgpneighbour (ip, port, tokenid, vrfname, ASN, neighbourip, remoteas): url = " + ip + ":"+ port + "/api/v1/vrf/" + vrfname + "/routing-svc/bgp/" + ASN +"/neighbors" 'content-type': "application/json", data = { 'routing-protocol-id': ASN, 'address': neighbourip, 'remote-as': remoteas response = requests.request("post", url, headers=headers, json=data, verify=false ) if response.status_code == 201:

8 return "successful" Description and values of input parameters ip = " " port = "55443" username = "cisco" privilege level 15. password = "cisco" tokenid = <value returned> vrfname = "VRF-A" RD = "3:3" importrt = "34:34" exportrt = "34:34" interfacename = "GigabitEthernet3" interfaceip = " " interfacesubnet = " " ASN = "34" neighbourip = " " remoteas = "11" # ip address of the router # REST API port on router # username to login.this should be configured with # password associated with username # Token ID obtained from router using gettoken function # name of the VRF # Route Distinguisher for VRF # Import Route Target # export Route Target # name of the customer edge (CE) facing interface # IP address of CE facing interface # subnet of CE facing interface # BGP AS number of PE router # BGP peering IP of CE router # AS number of CE router In all the above functions, dedicated APIs were called for each configuation setp. The example below demonstrates how to pass IOS-XE CLI, in general, in the body of REST API call. This can be used as a workaround to automate if particular API is not available. In the above functions 'content-type' is set to 'application/json', but in the below example, 'content-type' is set to 'text/plain' as it is parsing standard CLI input. This exmaple defines interface description for interface GigabitEthernet3. Configuration can be customized by changing the "cliinput" parameter. def passcliinput (ip, port, tokenid):

9 url = " + ip + ":"+ port + "/api/v1/global/running-config" 'content-type': "text/plain", line1 = "Interface GigabitEthernet 3" line2 = "description Customer Facing Interface" cliinput = line1 + "\r\n" + line2 response = requests.request("put", url, headers=headers, data=cliinput, verify=false ) print(response.text) if response.status_code == 204: return "sucessful" References - Cisco CSR 1000v Series Cloud Services Router Software Configuration Guide guration_guide /b_csr1000v_configuration_guide_chapter_01101.html - Cisco IOS XE REST API Management Reference Guide Acronyms Used: MPLS - Multi Protocol Label Switching L3 - Layer 3 VPN - Virtual Private Network

10 VRF - Virtual Route Forwarding BGP - Border Gateway Protocol REST - Representational State Transfer API - Application Program Interface JSON - Java Script Object Notation HTTP - Hyper Text Transfer Protocol

MPLS over GRE. Finding Feature Information. Prerequisites for MPLS VPN L3VPN over GRE

MPLS over GRE. Finding Feature Information. Prerequisites for MPLS VPN L3VPN over GRE The feature provides a mechanism for tunneling Multiprotocol Label Switching (MPLS) packets over a non-mpls network. This feature utilizes MPLS over generic routing encapsulation (MPLSoGRE) to encapsulate