| single |
# Netbox Network Importer
Tool to analyze and synchronize an existing network with a Netbox (SOT).
The main use cases for the network importer:
- Import an existing network into a Netbox
- ~~Check the differences between the running network and the Netbox~~
---
## Install
1. Clone repository
- `git clone git@gitlab.cesnet.cz:701/done/netbox_network_importer.git`
2. Go into the repository
- `cd netbox_network_importer `
3. Create `virtualenv`
- `python3 -m venv venv`
3. Activate it
- `source venv/bin/activate`
3. Install the tool
- `pip install .`
---
## Pre-requisite
To operate, the Netbox Network Importer is dependent on the following
items:
- Access to Netbox API
- Access to Network Devices via SSH
- Created Custom Field on Netbox
```json
{
"display": "Ignore Importer",
"content_types": [
"dcim.interface",
],
"type": {
"value": "boolean",
"label": "Boolean (true/false)"
},
"object_type": null,
"data_type": "boolean",
"name": "ignore_importer",
"label": "Ignore Importer",
"description": "Will be ignored when processed by Network Importer",
"required": true,
"filter_logic": {
"value": "exact",
"label": "Exact"
},
"default": false,
"weight": 100,
}
```
---
## Inventory
A device inventory must be available in NetBox.
To be able to connect to the device the following information needs to be
defined :
- Primary ip address
- Platform (must be a one of the following ['iosxr', 'ios', 'iosxe'])
---
## Configuration file
The information to connect to NetBox must be provided via the configuration
file. The configuration file below presents all available options that can
be provided to control the behavior of the Netbox Network Importer.
Netbox Network Importer tries to find the configuration file at:
- `/home//.config/netbox_network_importer/config.yml`
- `/etc/netbox_network_importer/config.yml`
- Or you can set path to configuration file like:
- `netbox_network_importer --configs path_to_dir_with_config/
synchronize`
### Complete Configuration Example
```yaml
---
netbox:
NETBOX_API_TOKEN: "your_api_token_here"
NETBOX_INSTANCE_URL: "https://your-netbox-instance.com/"
NETBOX_GRAPHQL_URL: "https://your-netbox-instance.com/graphql/"
tacacs:
TACACS_USERNAME: "your_username"
TACACS_PASSWORD: "your_password"
config:
# Logging Configuration
LOG_DIR: "logs" # Directory for log files
LOG_LEVEL: "INFO" # Log level: DEBUG, INFO,
WARNING, ERROR, CRITICAL
# Output Configuration
OUTPUT_DIR: "outputs" # Directory for result files
(JSON/HTML)
# Network Behavior
SUPPRESS_CONNECTION_ERRORS: true # Suppress verbose
NAPALM/NETCONF/SSH logs
NORNIR_WORKERS: 20 # Number of parallel workers
(default: 20)
# Result Filtering
FILTER_EMPTY_UPDATE_RESULTS: true # Filter UPDATE actions with
|