#synchronization #netbox #networking #netshot

app netbox2netshot

Synchronization tool between netbox and netshot

9 releases

0.1.12 Jun 5, 2023
0.1.10 Feb 17, 2022
0.1.8 Nov 17, 2021
0.1.6 Sep 22, 2021
0.0.1 Apr 27, 2021

#249 in Command line utilities

46 downloads per month

Apache-2.0

37KB
794 lines

Netbox2Netshot

Introduction

Netbox2Netshot is a tool that allows you to synchronize your Netbox DCIM (using specific criterias) to Netshot so your devices would automatically get backed up by Netshot once added in Netbox.

The tool is coded in Rust and doesn't required any runtime dependency installed

How to use

Installation

Gather a pre-built binary, deb or rpm package or install it using Cargo

cargo install netbox2netshot

Parameters

Most parameters can be set either via command line arguments or environment variables

netbox2netshot [FLAGS] [OPTIONS] --netbox-url <netbox-url> --netshot-domain-id <netshot-domain-id> --netshot-token <netshot-token> --netshot-url <netshot-url>

FLAGS:
    -c, --check      Check mode, will not push any change to Netshot
    -d, --debug      Enable debug/verbose mode
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --netbox-devices-filter <netbox-devices-filter>
            The querystring to use to select the devices from netbox [env: NETBOX_DEVICES_FILTER=]  [default: ]

        --netbox-proxy <netbox-proxy>
            HTTP(s) proxy to use to connect to Netbox [env: NETBOX_PROXY=]

        --netbox-tls-client-certificate <netbox-tls-client-certificate>
            The TLS certificate to use to authenticate to Netbox (PKCS12 format) [env: NETBOX_TLS_CLIENT_CERTIFICATE=]

        --netbox-tls-client-certificate-password <netbox-tls-client-certificate-password>
            The optional password for the netbox PKCS12 file [env: NETBOX_TLS_CLIENT_CERTIFICATE_PASSWORD=]

        --netbox-token <netbox-token>
            The Netbox token [env: NETBOX_TOKEN]

        --netbox-url <netbox-url>
            The Netbox API URL [env: NETBOX_URL=]

        --netbox-vms-filter <netbox-vms-filter>
            The querystring to use to select the VM from netbox [env: NETBOX_VMS_FILTER=]

        --netshot-domain-id <netshot-domain-id>
            The domain ID to use when importing a new device [env: NETSHOT_DOMAIN_ID=]

        --netshot-proxy <netshot-proxy>
            HTTP(s) proxy to use to connect to Netshot [env: NETSHOT_PROXY=]

        --netshot-tls-client-certificate <netshot-tls-client-certificate>
            The TLS certificate to use to authenticate to Netshot (PKCS12 format) [env: NETSHOT_TLS_CLIENT_CERTIFICATE=]

        --netshot-tls-client-certificate-password <netshot-tls-client-certificate-password>
            The optional password for the netshot PKCS12 file [env: NETSHOT_TLS_CLIENT_CERTIFICATE_PASSWORD=]

        --netshot-token <netshot-token>
            The Netshot token [env: NETSHOT_TOKEN]

        --netshot-url <netshot-url>
            The Netshot API URL [env: NETSHOT_URL=]

The query-string format need to be like this (url query string without the ?):

status=active&platform=cisco-ios&platform=cisco-ios-xe&platform=cisco-ios-xr&platform=cisco-nx-os&platform=juniper-junos&has_primary_ip=true&tenant_group=network

If you plan to use TLS authentication, please provide a PKCS12 formatted identity file (.pfx or .p12), they can be created from .pem/.key/.crt using the following command:

openssl pkcs12 -export -out my.pfx -inkey my.key -in my.crt

Dependencies

~8–22MB
~346K SLoC