# Cisco NetBox Onboarding
  
A Python script to streamline the onboarding of Cisco devices into [NetBox](https://netbox.dev/), a popular IP address management (IPAM) and data center infrastructure management (DCIM) tool. This tool leverages the NetBox API to automate the creation of sites, devices, interfaces, and IP addresses based on a YAML configuration file.
—
## Overview
The cisco_netbox_onboarding script simplifies the process of adding Cisco network devices to NetBox. By defining device details in a YAML file, users can efficiently populate NetBox with accurate inventory data, reducing manual entry and potential errors. This is particularly useful for network engineers managing Cisco-powered infrastructures.
—
## Features
Automated Onboarding: Creates NetBox objects (sites, devices, interfaces, IPs) from a YAML config.
Cisco-Focused: Tailored for Cisco devices with platform support (e.g., cisco_ios).
Flexible Configuration: Define multiple devices, interfaces, and IP assignments in a single YAML file.
API Integration: Utilizes the NetBox REST API for seamless data insertion.
Error Handling: Basic validation and feedback for API interactions.
—
## Prerequisites
Before using this script, ensure you have:
Python 3.x installed on your system.
A running NetBox instance with API access enabled.
A valid NetBox API token (generated from the NetBox UI under your user profile).
Access to the repository’s required Python packages (listed in requirements.txt).
—
## Installation
To install Cisco NetBox Onboarding, simply use pip:
` $ pip install cisco_netbox_onboarding `
or
Clone the Repository: `bash git clone https://github.com/tkdebnath/cisco_netbox_onboarding.git cd cisco_netbox_onboarding `
Set Up a Virtual Environment (optional but recommended): `bash python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate `
Install Dependencies:: `bash python3 -m pip install -r requirements.txt `
Configure Environment Variables: `plaintext URL=http://<your-netbox>/ API_KEY=<your-api-token> NETMIKO_USERNAME= NETMIKO_PASSWORD= `
## Usage/Examples Check USAGE.md
1 maintainer
Metadata
1 maintainer
Release files for cisco-netbox-onboarding 0.0.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cisco_netbox_onboarding-0.0.11.tar.gz | 52.3 kB | With provenance | Details for cisco_netbox_onboarding-0.0.11.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cisco_netbox_onboarding-0.0.11-py3-none-any.whl | Python 3 | none | any | Details for cisco_netbox_onboarding-0.0.11-py3-none-any.whl |
Total release size: 95.2 kB
Release files / cisco_netbox_onboarding-0.0.11.tar.gz
| Download URL | cisco_netbox_onboarding-0.0.11.tar.gz |
|---|---|
| Size | 52.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ff2e829e59bca439d14ee8fd4d47c8ee54062476afa38fa116b55c6f8207a29
|
|
BLAKE2b-256 checksum How to use checksums |
418fc35d9bfda4c1d972e6caaa2c34d5ca6a1ac62996daf64571754df86c939a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 8, 2025.
Transparency logRelease files / cisco_netbox_onboarding-0.0.11-py3-none-any.whl
| Download URL | cisco_netbox_onboarding-0.0.11-py3-none-any.whl |
|---|---|
| Size | 42.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6bd529616759bfb802acbd79e8cba4e13e88a90a37463e8a9446065a3041f053
|
|
BLAKE2b-256 checksum How to use checksums |
8d4ff1ade80e043ffd740d172fbe81db30c38e8a85931b68a2f1e1db9fab1444
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 8, 2025.
Transparency logSecurity for cisco-netbox-onboarding 0.0.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for cisco_netbox_onboarding-0.0.11.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 8, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
