Commit 6afcd4e3 authored by Morten Brekkevold's avatar Morten Brekkevold

update readme

parent 991dc574
Synchronization of equipment from Kind to NAV
=============================================
usage: kindnavsync [-h] [--dry-run] [--kind-only] [--debug]
[--api-url API_URL] [--api-token API_TOKEN]
Synchronizes devices in NAV with those from Kind
optional arguments:
-h, --help show this help message and exit
--dry-run, -n don't change anything in NAV, just print what would
have been done
--kind-only only check contents of Kind, do not talk to NAV
--debug, -d enable debug logging
--api-url API_URL, -a API_URL
URL to the NAV API. Default=http://localhost/api/1
--api-token API_TOKEN, -t API_TOKEN
NAV API Token
Since Kind only stores names of devices, while NAV requires specific IP
addresses, up-to-date DNS entries are required.
usage: kindnavsync [-h] [--dry-run] [--kind-only] [--debug]
[--api-url API_URL] [--api-token API_TOKEN]
[--no-timestamps]
Synchronizes devices in NAV with those from Kind
optional arguments:
-h, --help show this help message and exit
--dry-run, -n don't change anything in NAV, just print what would
have been done
--kind-only only check contents of Kind, do not talk to NAV
--debug, -d enable debug logging
--api-url API_URL, -a API_URL
URL to the NAV API. Default=http://localhost/api/1
--api-token API_TOKEN, -t API_TOKEN
NAV API Token
--no-timestamps Don't add timestamps to log output
Since Kind only stores names of devices, while NAV requires specific IP
addresses, up-to-date DNS entries are required. If the environment variable
SLACK_URL is set, this program will post log messages to Slack using this as a
webhook URL.
Supported environment variables
-------------------------------
- `NAV_API_URL`: URL to NAV API
- `NAV_API_TOKEN`: NAV API token, providing at least read/write access for the
`/netbox` and `/room` endpoints.
- `SLACK_URL`: If set, log output will be posted to this slack webhook URL. See
<https://api.slack.com/incoming-webhooks> for details.
Notes
-----
......@@ -33,5 +47,4 @@ Notes
Bugs
----
- Only adds and removes equipment. Does not update details of changed
equipment.
- Doesn't update IP addresses in NAV if DNS changes.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment