1
0
Fork
You've already forked nbcli
0
forked from nbcli/nbcli
Extensible CLI for Netbox using pynetbox module.
  • Python 97.9%
  • HTML 2.1%
Find a file
2024年10月10日 15:03:55 -05:00
.woodpecker fix python-publish.yml 2024年07月17日 14:22:36 -05:00
docs replace github repo urls with codeberg repo urls 2023年03月30日 11:43:21 -05:00
nbcli strip trailing spaces from table view #67 2024年08月29日 15:22:08 -05:00
overrides tweek demo setings in docs 2022年10月04日 12:33:25 -05:00
tests update testing docs 2022年10月04日 14:52:16 -05:00
.gitignore support newer versions of pynetbox #36 2022年09月21日 13:12:33 -05:00
LICENSE rename netbox-client to nbcli 2020年06月19日 13:10:43 -05:00
mkdocs.yml replace github repo urls with codeberg repo urls 2023年03月30日 11:43:21 -05:00
pyproject.toml Add setuptools as dependency. #68 2024年10月10日 15:03:55 -05:00
README.md update demo recording 2022年10月04日 12:25:14 -05:00

nbcli: NetBox Command-line Client

Extensible command-line interface for Netbox using the pynetbox module.

nbcli is still in development! Syntax of commands are subject to change!

asciicast

Quickstart

The full nbcli documentation can be found here.

$ pip install nbcli
$ nbcli init
Edit pynetbox 'url' and 'token' entries in user_config.yml:
 ~/.nbcli/user_config.yml

At the very minimum, you need to specify a url and token in the user_config.yml file

pynetbox:url:http://localhost:8080token:0123456789abcdef0123456789abcdef01234567

If you need to disable SSL verification, add (or uncomment) the following to your user_config.yml file.

requests:verify:false

Run a search of Netbox objects and show a table view of results.

$ nbcli search dmi01
Device
======
Name Status Tenant Site Rack Role Type IP Address
dmi01-akron-pdu01 Active Dunder-Mifflin, Inc. DM-Akron Comms closet PDU AP7901 -
dmi01-akron-rtr01 Active Dunder-Mifflin, Inc. DM-Akron Comms closet Router ISR 1111-8P -
dmi01-akron-sw01 Active Dunder-Mifflin, Inc. DM-Akron Comms closet Access Switch C9200-48P -
dmi01-albany-pdu01 Active Dunder-Mifflin, Inc. DM-Albany Comms closet PDU AP7901 -
dmi01-albany-rtr01 Active Dunder-Mifflin, Inc. DM-Albany Comms closet Router ISR 1111-8P -
dmi01-albany-sw01 Active Dunder-Mifflin, Inc. DM-Albany Comms closet Access Switch C9200-48P -
dmi01-binghamton-pdu01 Active Dunder-Mifflin, Inc. DM-Binghamton Comms closet PDU AP7901 -
dmi01-binghamton-rtr01 Active Dunder-Mifflin, Inc. DM-Binghamton Comms closet Router ISR 1111-8P -
dmi01-binghamton-sw01 Active Dunder-Mifflin, Inc. DM-Binghamton Comms closet Access Switch C9200-48P -
dmi01-buffalo-pdu01 Active Dunder-Mifflin, Inc. DM-Buffalo Comms closet PDU AP7901 -
dmi01-buffalo-rtr01 Active Dunder-Mifflin, Inc. DM-Buffalo Comms closet Router ISR 1111-8P -
dmi01-buffalo-sw01 Active Dunder-Mifflin, Inc. DM-Buffalo Comms closet Access Switch C9200-48P -
dmi01-camden-pdu01 Active Dunder-Mifflin, Inc. DM-Camden Comms closet PDU AP7901 -
dmi01-camden-rtr01 Active Dunder-Mifflin, Inc. DM-Camden Comms closet Router ISR 1111-8P -
dmi01-camden-sw01 Active Dunder-Mifflin, Inc. DM-Camden Comms closet Access Switch C9200-48P -
*** See all 39 results: '$ nbcli filter device dmi01 --dl' ***