https://github.com/networktocode/ntc-rosetta
The missing bridge between industry standard CLIs and YANG
https://github.com/networktocode/ntc-rosetta
Last synced: 2 months ago
JSON representation
The missing bridge between industry standard CLIs and YANG
- Host: GitHub
- URL: https://github.com/networktocode/ntc-rosetta
- Owner: networktocode
- License: apache-2.0
- Created: 2019-05-29T09:33:55.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-08-30T00:12:27.000Z (almost 2 years ago)
- Last Synced: 2025-04-04T13:51:23.275Z (3 months ago)
- Language: Python
- Homepage: https://ntc-rosetta.readthedocs.io/en/latest/index.html
- Size: 883 KB
- Stars: 104
- Watchers: 55
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# ntc_rosetta
ntc_rosetta leverages [yangify](https://github.com/networktocode/yangify) to implement a set of "drivers" that can:
1. Transform network devices' native configuration/state into structured data that conform to YANG models
2. Transform data structures that conform to YANG models into network device's native configuration/data structures
3. Merge configurations
## Installing NTC Rosetta
### Pip Install
`pip install ntc-rosetta`
### Install From Source
- Clone ntc-rosetta (`git clone https://github.com/networktocode/ntc-rosetta.git`)
- cd into project root (`cd ntc-rosetta`)
- `pip install poetry`
- `poetry install`
## Ways to get started with NTC Rosetta
- Start Executing Jupyter Notebooks
- [Read the Docs](https://ntc-rosetta.readthedocs.io/en/latest/index.html)
### Start Executing Jupyter Notebooks
#### Step 1
Clone the repository:
`$ git clone https://github.com/networktocode/ntc-rosetta.git`
#### Step 2
Change directory into `ntc-rosetta`:
`$ cd ntc-rosetta`
#### Step 3
Build the containers:
`$ make build_test_containers`
#### Step 4
Start a container so you can run the Jupyter notebooks:
`$ make jupyter`
#### Step 5
Launch a browser and navigate to the following URL:
`http://127.0.0.1:8888/tree/docs/tutorials`
The same notebooks can be viewed without being interactive in the NTC Rosetta Read the Docs.
## Parsing
>>> from ntc_rosetta import get_driver
>>>
>>> ios = get_driver("ios", "openconfig")
>>> ios_driver = ios()
>>> with open("data/ios/config.txt", "r") as f:
>>> config = f.read()
>>> print(config)
interface FastEthernet1
description This is Fa1
shutdown
exit
!
vlan 10
name prod
no shutdown
exit
!
vlan 20
name dev
shutdown
exit
!
>>> parsed = ios_driver.parse(native={"dev_conf": config})
>>> import json
>>> print(json.dumps(parsed.raw_value(), indent=4))
{
"openconfig-interfaces:interfaces": {
"interface": [
{
"name": "FastEthernet1",
"config": {
"name": "FastEthernet1",
"type": "iana-if-type:ethernetCsmacd",
"description": "This is Fa1",
"enabled": false
},
"subinterfaces": {
"subinterface": [
{
"index": 1,
"config": {
"index": 1,
"description": "This is Fa1.1"
}
},
{
"index": 2,
"config": {
"index": 2,
"description": "This is Fa1.2"
}
}
]
}
},
]
},
"openconfig-network-instance:network-instances": {
"network-instance": [
{
"name": "default",
"config": {
"name": "default"
},
"vlans": {
"vlan": [
{
"vlan-id": 10,
"config": {
"vlan-id": 10,
"name": "prod",
"status": "ACTIVE"
}
},
{
"vlan-id": 20,
"config": {
"vlan-id": 20,
"name": "dev",
"status": "SUSPENDED"
}
}
]
}
}
]
}
}
## Translating
>>> from ntc_rosetta import get_driver
>>>
>>> ios = get_driver("ios", "openconfig")
>>> ios_processor = ios()
>>> data = {
>>> "openconfig-interfaces:interfaces": {
>>> "interface": [
>>> {
>>> "name": "FastEthernet1",
>>> "config": {
>>> "name": "FastEthernet1",
>>> "type": "iana-if-type:ethernetCsmacd",
>>> "description": "This is Fa1",
>>> "enabled": False
>>> },
>>> "subinterfaces": {
>>> "subinterface": [
>>> {
>>> "index": 1,
>>> "config": {
>>> "index": 1,
>>> "description": "This is Fa1.1"
>>> }
>>> },
>>> {
>>> "index": 2,
>>> "config": {
>>> "index": 2,
>>> "description": "This is Fa1.2"
>>> }
>>> }
>>> ]
>>> }
>>> },
>>> ]
>>> },
>>> "openconfig-network-instance:network-instances": {
>>> "network-instance": [
>>> {
>>> "name": "default",
>>> "config": {
>>> "name": "default"
>>> },
>>> "vlans": {
>>> "vlan": [
>>> {
>>> "vlan-id": 10,
>>> "config": {
>>> "vlan-id": 10,
>>> "name": "prod",
>>> "status": "ACTIVE"
>>> }
>>> },
>>> {
>>> "vlan-id": 20,
>>> "config": {
>>> "vlan-id": 20,
>>> "name": "dev",
>>> "status": "SUSPENDED"
>>> }
>>> }
>>> ]
>>> }
>>> }
>>> ]
>>> }
>>> }
>>> native = ios_processor.translate(candidate=data)
>>> print(native)
interface FastEthernet1
description This is Fa1
shutdown
exit
!
interface FastEthernet1.1
description This is Fa1.1
exit
!
interface FastEthernet1.2
description This is Fa1.2
exit
!
interface FastEthernet3
description This is Fa3
no shutdown
switchport mode access
switchport access vlan 10
exit
!
interface FastEthernet4
shutdown
switchport mode trunk
switchport trunk allowed vlan 10,20
exit
!
vlan 10
name prod
no shutdown
exit
!
vlan 20
name dev
shutdown
exit
!