nbcli


Namenbcli JSON
Version 0.10.0.dev2 PyPI version JSON
download
home_pageNone
SummaryCLI for netbox using pynetbox module
upload_time2024-10-10 20:12:32
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseGPLv3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # nbcli: NetBox Command-line Client

Extensible command-line interface for [Netbox](https://netbox.readthedocs.io/en/stable/) 
using the [pynetbox](https://pynetbox.readthedocs.io/en/latest/) module. 

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

[![asciicast](https://asciinema.org/a/525610.svg)](https://asciinema.org/a/525610)

## Quickstart

The full nbcli documentation can be found [here](https://ericgeldmacher.github.io/nbcli/).

```
$ 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

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

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

```yaml
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' ***
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nbcli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Eric Geldmacher <egeldmacher@wustl.edu>",
    "download_url": "https://files.pythonhosted.org/packages/dd/8e/8932f1607060d285bce28d51f270b5d37effc226c1b4a70dcbbb4549b7de/nbcli-0.10.0.dev2.tar.gz",
    "platform": null,
    "description": "# nbcli: NetBox Command-line Client\n\nExtensible command-line interface for [Netbox](https://netbox.readthedocs.io/en/stable/) \nusing the [pynetbox](https://pynetbox.readthedocs.io/en/latest/) module. \n\n***nbcli is still in development!*** \n***Syntax of commands are subject to change!***\n\n[![asciicast](https://asciinema.org/a/525610.svg)](https://asciinema.org/a/525610)\n\n## Quickstart\n\nThe full nbcli documentation can be found [here](https://ericgeldmacher.github.io/nbcli/).\n\n```\n$ pip install nbcli\n$ nbcli init\nEdit pynetbox 'url' and 'token' entries in user_config.yml:\n        ~/.nbcli/user_config.yml\n```\n\nAt the very minimum, you need to specify a url and token in the user_config.yml file\n\n```yaml\npynetbox:\n  url: http://localhost:8080\n  token: 0123456789abcdef0123456789abcdef01234567\n```\n\nIf you need to disable SSL verification, add (or uncomment) the following to your user_config.yml file. \n\n```yaml\nrequests:\n  verify: false\n```\n\nRun a search of Netbox objects and show a table view of results.\n\n```\n$ nbcli search dmi01\n\nDevice\n======\nName                    Status  Tenant                Site           Rack          Role           Type         IP Address\ndmi01-akron-pdu01       Active  Dunder-Mifflin, Inc.  DM-Akron       Comms closet  PDU            AP7901       -\ndmi01-akron-rtr01       Active  Dunder-Mifflin, Inc.  DM-Akron       Comms closet  Router         ISR 1111-8P  -\ndmi01-akron-sw01        Active  Dunder-Mifflin, Inc.  DM-Akron       Comms closet  Access Switch  C9200-48P    -\ndmi01-albany-pdu01      Active  Dunder-Mifflin, Inc.  DM-Albany      Comms closet  PDU            AP7901       -\ndmi01-albany-rtr01      Active  Dunder-Mifflin, Inc.  DM-Albany      Comms closet  Router         ISR 1111-8P  -\ndmi01-albany-sw01       Active  Dunder-Mifflin, Inc.  DM-Albany      Comms closet  Access Switch  C9200-48P    -\ndmi01-binghamton-pdu01  Active  Dunder-Mifflin, Inc.  DM-Binghamton  Comms closet  PDU            AP7901       -\ndmi01-binghamton-rtr01  Active  Dunder-Mifflin, Inc.  DM-Binghamton  Comms closet  Router         ISR 1111-8P  -\ndmi01-binghamton-sw01   Active  Dunder-Mifflin, Inc.  DM-Binghamton  Comms closet  Access Switch  C9200-48P    -\ndmi01-buffalo-pdu01     Active  Dunder-Mifflin, Inc.  DM-Buffalo     Comms closet  PDU            AP7901       -\ndmi01-buffalo-rtr01     Active  Dunder-Mifflin, Inc.  DM-Buffalo     Comms closet  Router         ISR 1111-8P  -\ndmi01-buffalo-sw01      Active  Dunder-Mifflin, Inc.  DM-Buffalo     Comms closet  Access Switch  C9200-48P    -\ndmi01-camden-pdu01      Active  Dunder-Mifflin, Inc.  DM-Camden      Comms closet  PDU            AP7901       -\ndmi01-camden-rtr01      Active  Dunder-Mifflin, Inc.  DM-Camden      Comms closet  Router         ISR 1111-8P  -\ndmi01-camden-sw01       Active  Dunder-Mifflin, Inc.  DM-Camden      Comms closet  Access Switch  C9200-48P    -\n*** See all 39 results: '$ nbcli filter device dmi01 --dl' ***\n```\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "CLI for netbox using pynetbox module",
    "version": "0.10.0.dev2",
    "project_urls": {
        "Bug Tracker": "https://codeberg.org/nbcli/nbcli/issues",
        "Documentation": "https://nbcli.codeberg.page",
        "Repository": "https://codeberg.org/nbcli/nbcli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2dc03c47b4e5732b938196bd229d12b6652860c289545228148d04f9f72dd5e",
                "md5": "73f5c05c56cc7562aaac6cf75019bf22",
                "sha256": "1d3f7188d3dfb5576ca8d7070e45676e009681af44c98ade716aa610a558a928"
            },
            "downloads": -1,
            "filename": "nbcli-0.10.0.dev2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73f5c05c56cc7562aaac6cf75019bf22",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 41926,
            "upload_time": "2024-10-10T20:12:31",
            "upload_time_iso_8601": "2024-10-10T20:12:31.190057Z",
            "url": "https://files.pythonhosted.org/packages/e2/dc/03c47b4e5732b938196bd229d12b6652860c289545228148d04f9f72dd5e/nbcli-0.10.0.dev2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd8e8932f1607060d285bce28d51f270b5d37effc226c1b4a70dcbbb4549b7de",
                "md5": "d6f4abae2716384c272b2fa64430ac3d",
                "sha256": "480d27c691cb01fc4f748808d4d4d43bdf321e9a017bf5de3a4e6650488e44bd"
            },
            "downloads": -1,
            "filename": "nbcli-0.10.0.dev2.tar.gz",
            "has_sig": false,
            "md5_digest": "d6f4abae2716384c272b2fa64430ac3d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 35142,
            "upload_time": "2024-10-10T20:12:32",
            "upload_time_iso_8601": "2024-10-10T20:12:32.397840Z",
            "url": "https://files.pythonhosted.org/packages/dd/8e/8932f1607060d285bce28d51f270b5d37effc226c1b4a70dcbbb4549b7de/nbcli-0.10.0.dev2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 20:12:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": true,
    "codeberg_user": "nbcli",
    "codeberg_project": "nbcli",
    "lcname": "nbcli"
}
        
Elapsed time: 0.70360s