Skip to content

Commit

Permalink
Extend README (#19)
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt authored Dec 4, 2024
1 parent 2618d7d commit b06f29e
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,40 @@
# netbox-manager

## Installation

```
$ pipenv shell
$ pip install netbox-manager
$ ansible-galaxy collection install -r requirements.yml
```

## Configuration

```toml
DEVICETYPE_LIBRARY = "example/devicetype-library"
IGNORE_SSL_ERRORS = true
RESOURCES = "example/resources"
TOKEN = ""
URL = "https://XXX.netbox.regio.digital"
VERBOSE = true
```

## Usage

```
$ pipenv shell
$ netbox-manager --help
Usage: netbox-manager [OPTIONS]
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --limit TEXT Limit files by prefix [default: None] │
│ --wait --no-wait Wait for NetBox service [default: wait] │
│ --skipdtl --no-skipdtl Skip device type library [default: no-skipdtl] │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

## Documentation

* https://docs.ansible.com/ansible/latest/collections/netbox/netbox/index.html
* https://github.com/netbox-community/devicetype-library

0 comments on commit b06f29e

Please sign in to comment.