This document is a guide on how to use my free Lab Configuration Generator(LCG) API. The LCG API is a tool that I have been working on that can autogenerate configuration based on the node_type.
In this demo, we will create a simple cisco configuration file
To see a live demo check out the youtube link below:
- Computer running Python3
- requests library installed
- Clone the repo and execute "python lcg_access.py".
git clone "https://github.com/byt3-m3/LCG_DEMO.git"GET Example - Use this example to get a blank data model to use for POST request.
try:
import requests
except Exception:
raise Exception("Install the requests library using 'pip install requests'")
resp = requests.get("http://apps.cbaxterjr.com/api/v1/lcg/config?node_type=ios_rtr")RESPONSE:
{
"data": {
"domain": "",
"hostname": "",
"interfaces": [
{
"description": "",
"ipv4_addrs": [
{
"address": "",
"netmask": ""
}
],
"ipv6_addrs": [
{
"ipv6_address": ""
}
],
"link_id": "lo0"
},
{
"bandwidth": "",
"description": "",
"ipv4_addrs": [
{
"address": "",
"netmask": ""
}
],
"ipv6_addrs": [
{
"ipv6_address": ""
}
],
"link_id": "Gi1",
"mpls": {
"ldp": false,
"mpls_te": false
},
"ospf": {
"area_id": "100",
"auth": {
"message_digest": [
{
"key_id": "1",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
},
{
"key_id": "2",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
}
]
},
"network_type": "point-to-point",
"p_id": "1",
"priority": "0"
}
},
{
"bandwidth": "50",
"description": "R2",
"dot1q": "99",
"ipv4_addrs": [
{
"address": "10.1.2.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"ipv6_address": "2001:1:2::1/64"
}
],
"link_id": "Gi1.99",
"mpls": {
"ldp": true,
"mpls_te": true
},
"ospf": {
"area_id": "100",
"auth": {
"message_digest": [
{
"key_id": "1",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
},
{
"key_id": "2",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
}
]
},
"network_type": "point-to-point",
"p_id": "1",
"priority": "0"
}
}
],
"node_type": "",
"snmpv2": [
{
"access_list": "",
"community": "",
"group_type": ""
}
],
"snmpv3": [
{
"group_name": "",
"mode": "",
"peer": "",
"username": ""
},
{
"auth_alg": "",
"auth_pw": "",
"group_name": "",
"mode": "",
"peer": "",
"username": ""
},
{
"auth_alg": "",
"auth_pw": "",
"group_name": "",
"mode": "",
"peer": "",
"priv_alg": "",
"priv_pw": "",
"username": ""
}
]
},
"opts": {
"dev_name": "",
"lab_name": "",
"resp_type": "text"
}
}POST Example - (python3 lcg_access.py)
try:
import requests
except Exception:
raise Exception("Install the requests library using 'pip install requests'")
cisco_model = {
"opts": {
"lab_name": "L3VPN_EXAMPLE",
"dev_name": "R1"
},
"data": {
"node_type": "ios_rtr",
"hostname": "R1-CA-CORE",
"domain": "bits.local",
"snmpv3": [
{
"mode": "noAuthNoPriv",
"username": "CISCO_MGMT1",
"group_name": "CISCO_MGMT_GRP1",
"peer": "10.0.0.1"
},
{
"mode": "AuthNoPriv",
"username": "CISCO_MGMT2",
"group_name": "CISCO_MGMT_GRP2",
"peer": "10.0.0.1",
"auth_alg": "md5",
"auth_pw": "033bd94b1168d7e4f0d644c3c95e35bf"
},
{
"mode": "AuthPriv",
"username": "CISCO_MGMT3",
"group_name": "CISCO_MGMT_GRP3",
"peer": "10.0.0.1",
"auth_alg": "md5",
"auth_pw": "033bd94b1168d7e4f0d644c3c95e35bf",
"priv_alg": "aes_192",
"priv_pw": "033bd94b1168d7e4f0d644c3c95e35bf"
}
],
"snmpv2": [
{
"community": "BITS_RW",
"group_type": "rw",
"access_list": "CORE_MGMT"
},
{
"community": "BITS_RO",
"group_type": "ro"
}
],
"interfaces": [
{
"link_id": "lo0",
"description": "MGMT Interface",
"ipv4_addrs": [
{
"address": "10.0.0.50",
"netmask": "255.255.255.255"
},
{
"address": "10.0.1.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"ipv6_address": "2001::1/128"
}
]
},
{
"link_id": "Gi1",
"bandwidth": "50",
"description": "R2",
"mpls": {
"ldp": True,
"mpls_te": True
},
"ospf": {
"p_id": "1",
"area_id": "100",
"network_type": "point-to-point",
"priority": "0",
"auth": {
"message_digest": [
{
"key_id": "1",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
},
{
"key_id": "2",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
}
]
}
},
"ipv4_addrs": [
{
"address": "10.1.2.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"ipv6_address": "2001:1:2::1/64"
}
]
},
{
"link_id": "Gi2",
"bandwidth": "75",
"description": "R3",
"mpls": {
"ldp": True,
"mpls_te": False
},
"ospf": {
"p_id": "1",
"area_id": "30",
"network_type": "point-to-multipoint",
"priority": "2",
"auth": {
"key_chain": "TEST_CHAIN"
}
},
"ipv4_addrs": [
{
"address": "10.1.3.155",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"eui_64": "2001:1:3::/64"
}
]
},
{
"link_id": "Gi3",
"bandwidth": "30",
"description": "R4",
"mpls": {
"ldp": False,
"mpls_te": True
},
"ospf": {
"p_id": "1",
"area_id": "30",
"network_type": "point-to-multipoint",
"priority": "2",
"auth": {
"is_null": True
}
},
"ipv4_addrs": [
{
"address": "10.1.4.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"link_local": "fe80::1"
}
]
},
{
"link_id": "Gi4",
"bandwidth": "45",
"description": "R5",
"ipv4_addrs": [
{
"address": "10.1.5.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"anycast": "2001:6500::1/64"
}
]
},
{
"link_id": "Gi1.99",
"dot1q": "99",
"bandwidth": "50",
"description": "R2",
"mpls": {
"ldp": True,
"mpls_te": True
},
"ospf": {
"p_id": "1",
"area_id": "100",
"network_type": "point-to-point",
"priority": "0",
"auth": {
"message_digest": [
{
"key_id": "1",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
},
{
"key_id": "2",
"val": "033bd94b1168d7e4f0d644c3c95e35bf"
}
]
}
},
"ipv4_addrs": [
{
"address": "10.1.2.1",
"netmask": "255.255.255.255"
}
],
"ipv6_addrs": [
{
"ipv6_address": "2001:1:2::1/64"
}
]
}
]
}
}
if __name__ == "__main__":
LCG_URL = "http://apps.cbaxterjr.com:8080/api/v1/lcg/config"
response = requests.post(url=LCG_URL,
json=cisco_model,
# Although the data varible is of dict type, we use the "json" arg for the request because it will automaticly convert the python dicontary into an JSON str that can be serialized accross the wire.
headers={"Content-Type": "application/json"})
resp_str = response.content.decode() # We execute the decode method because the http response received from the server returns the content in byte format. This will conver it to UTF-8.
print(resp_str)RESPONSE:
enable
config t
hostname R1-CA-CORE
!
no ip domain-lookup
!
ip domain name bits.local
!
snmp-server community BITS_RW rw CORE_MGMT
snmp-server community BITS_RO ro
!
snmp-server group CISCO_MGMT_GRP1 v3 noauth
snmp-server user CISCO_MGMT1 CISCO_MGMT_GRP1 remote 10.0.0.1
!
snmp-server group CISCO_MGMT_GRP2 v3 auth
snmp-server user CISCO_MGMT2 CISCO_MGMT_GRP2 remote 10.0.0.1 v3 auth md5 033bd94b1168d7e4f0d644c3c95e35bf
!
snmp-server group CISCO_MGMT_GRP3 v3 auth
snmp-server user CISCO_MGMT3 CISCO_MGMT_GRP3 remote 10.0.0.1 v3 auth md5 033bd94b1168d7e4f0d644c3c95e35bf
snmp-server user CISCO_MGMT3 CISCO_MGMT_GRP3 remote 10.0.0.1 v3 auth md5 033bd94b1168d7e4f0d644c3c95e35bf priv aes 192 033bd94b1168d7e4f0d644c3c95e35bf
!
!
interface lo0
description MGMT Interface
ip address 10.0.0.50 255.255.255.255
ip address 10.0.1.1 255.255.255.255 secondary
ipv6 address 2001::1/128
no shutdown
!
interface Gi1
description R2
bandwidth 50000
mpls ip
mpls traffic-eng tunnels
ip address 10.1.2.1 255.255.255.255
ipv6 address 2001:1:2::1/64
ip ospf 1 area 100
ip ospf network point-to-point
ip ospf priority 0
ip ospf authentication message-digest
ip ospf message-digest-key 1 md5 033bd94b1168d7e4f0d644c3c95e35bf
ip ospf message-digest-key 2 md5 033bd94b1168d7e4f0d644c3c95e35bf
no shutdown
!
interface Gi2
description R3
bandwidth 75000
mpls ip
ip address 10.1.3.155 255.255.255.255
ipv6 address 2001:1:3::/64 eui_64
ip ospf 1 area 30
ip ospf network point-to-multipoint
ip ospf priority 2
ip ospf authentication key-chain TEST_CHAIN
no shutdown
!
interface Gi3
description R4
bandwidth 30000
mpls traffic-eng tunnels
ip address 10.1.4.1 255.255.255.255
ipv6 address fe80::1 link_local
ip ospf 1 area 30
ip ospf network point-to-multipoint
ip ospf priority 2
ip ospf authentication null
no shutdown
!
interface Gi4
description R5
bandwidth 45000
ip address 10.1.5.1 255.255.255.255
ipv6 address 2001:6500::1/64 anycast
no shutdown
!
interface Gi1.99
encapsulation dot1Q 99
description R2
bandwidth 50000
mpls ip
mpls traffic-eng tunnels
ip address 10.1.2.1 255.255.255.255
ipv6 address 2001:1:2::1/64
ip ospf 1 area 100
ip ospf network point-to-point
ip ospf priority 0
ip ospf authentication message-digest
ip ospf message-digest-key 1 md5 033bd94b1168d7e4f0d644c3c95e35bf
ip ospf message-digest-key 2 md5 033bd94b1168d7e4f0d644c3c95e35bf
no shutdown
!
line con 0
exec-timeout 0 0
logging synchronous
stopbits 1
exit
end
wr
Process finished with exit code 0