Switch Connector

A python server which provides an Abstraction layer for interacting with Cisco switches.

Technical challenge

Configuring network appliances requires knowledge about it's cli syntax and semanthics. Every device also has different protocol to interact (ssh, restconf, gnmi and so on)

Proposed solution

Design and develop a mediator which abstract model specific syntax, allowing a user to be agnostic of OS and required CLI command to perform various operation. Hiding the protocol being used to configure the device (ssh or restconf) and output a standardized message is a unique challenge.

Technologies, tools and libraries used

• Python
• Flask
• Genie Parser
• Scrapli
• Cisco Interface Name Converter

Install and run

Requirements:

• A Linux (or MacOS) based system is mandatory. A required library (Genie/PyATS) is not being distributed for Windows systems
• Python version 3.9 an above
• Pip

On a cmd shell:

1. Clone the repo

    git clone https://github.com/VEMSistemispa/switch-connector-devnet.git

2. Move into project folder

    cd switch-connector-devnet

3. Create a virtual enviroment

    python -m venv sc-venv

4. Activate it. (note: this is for linux based system) See here for more.

    source ./sc-venv/bin/activate

5. Install project's dependencies

    pip install -r requirements.txt

6. Run Switch-Connector

    python -m swagger_server

How to use

Flask server is running on port 8080 and listening to localhost interface. You can configure default port by setting (PORT=8090) enviroment variable. We recommend using Postman to try and interact with this solution. In this readme we'll include cURL examples which is also fine

Device Inventory

First thing first we need to provide a device inventory; a list of devices info that Switch Connector needs in order to interact and configure devices. Prepare and POST a JSON to http://localhost:8080/inventory

curl --location 'http://localhost:8080/inventory' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
    {
        "ip": "192.168.0.10",
        "username": "admin",
        "password": "your_switch_password"
    },
    {
        "ip": "192.168.0.20",
        "username": "admin",
        "password": "your_switch_password"
    }]'

Other endpoints

Gathering hardware info from a target device

Endpoint: /switch/hardware/info

Query parameters: ip (ip of the device to be queried)

curl --location 'http://localhost:8080/switch/hardware/info?ip=192.168.0.10'

Expected output

{
    "chassis": "C9200L-24P-4G",
    "chassis_sn": "XXXXXXXXXXX",
    "hostname": "C9200-1",
    "image_id": "CAT9K_LITE_IOSXE",
    "management_protocol": "RESTCONF",
    "platform": "Catalyst L3 Switch",
    "version": "17.6.4"
}

Gathering vlan list of vlan db from a target device

Endpoint: GET /switch/vlan

Query parameters: ip (ip of the device to be queried)

curl --location 'http://localhost:8080/switch/vlan?ip=192.168.0.10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Expected output

[
    {
        "id": 1,
        "name": "default"
    },
    {
        "id": 12,
        "name": "MGMT"
    },
    {
        "id": 200,
        "name": "TEST200"
    },
    {
        "id": 300,
        "name": "TEST300"
    },
    {
        "id": 500,
        "name": "RSPAN"
    }
]

Gathering switchport configuration of a specific interface on a target device

Endpoint: GET /switch/interfaces/{interface}/switchport-conf

Query parameters: ip (ip of the devices to be queried)

Route parameters: interface from which gather info (MUST be URL encoded)

curl --location --request GET 'http://localhost:8080/switch/interfaces/Gi1%2F0%2F23/switchport-conf?ip=192.168.0.10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Note that Gi1/0/23 is passed as a route parameer and MUST be URL encoded Expected output

{
    "mode": "trunk",
    "vlans": "1,12,200,300,600"
}

Changing switchport mode of a specific interface on a target device

Endpoint: POST /switch/interfaces/{interface}/switchport-mode Query parameters:

• ip (ip of the device to be queried)
• mode (interface mode to be set: "access" or "trunk")

Route parameters: interface from which gather info (MUST be URL encoded)

curl --location 'http://localhost:8080/switch/interfaces/Gi1%2F0%2F23/switchport-mode?ip=192.168.0.10&mode=access' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Note that Gi1/0/23 is passed as a route parameer and MUST be URL encoded Expected output: HTTP 200 if configuration was applied successfully

Interface tagging on target device

Endpoint: POST /switch/interfaces/{interface}/vlan-tag

Route parameters: interface to configure (MUST be URL encoded)

Body parameters:

• ip (ip of the devices to be queried)
• vlan_ids (vlan id the be setted or replaced) type: str (vlan ids are separated by a comma 1,200,300)
• append (append vlan_ids or replace them)

curl --location 'http://localhost:8080/switch/interfaces/Gi1%2F0%2F23/vlan-tag' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "ip":"10.255.3.1",
    "vlan_ids": "680",
    "append": true
}' 

Expected output

{
    "mode": "trunk",
    "vlans": "1,12,200,300,680"
}

Interface UNtagging on target device

Endpoint: DELETE /switch/interfaces/{interface}/vlan-tag

Route parameters: interface to configure (MUST be URL encoded)

Query parameters:

• ip (ip of the devices to be queried)
• vlan_id (vlan id the be removed)

curl --location 'http://localhost:8080/switch/interfaces/Gi1%2F0%2F23/vlan-tag?ip=192.168.0.10&vlan_id=680' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

Expected output

{
    "result": "Vlan 680 removed from interface Gi1/0/23 on device 192.168.0.10"
}