From 0baf085d4b71c7a58d9f9cab63b02008a9caa608 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Wed, 9 Oct 2019 12:14:40 +0200 Subject: [PATCH] Copied over the relevant parts from the README --- NAPALM-Configuration.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 NAPALM-Configuration.md diff --git a/NAPALM-Configuration.md b/NAPALM-Configuration.md new file mode 100644 index 0000000..39bb23e --- /dev/null +++ b/NAPALM-Configuration.md @@ -0,0 +1,12 @@ +NAPALM is tightly integrated into Netbox. +NAPALM allows Netbox to fetch live data from devices and return it to a requester via its REST API. +To learn more about what NAPALM is and how it works, please see the documentation from the [libary itself][napalm-doc] or the documentation from [Netbox][netbox-napalm-doc] on how it is integrated. + +To enable this functionality, simply complete the following lines in `netbox.env` (or appropriate mechanism): + +* `NAPALM_USERNAME`: A common username that can be utilized for connecting to network devices in your environment. +* `NAPALM_PASSWORD`: The password to use in combintation with the username to connect to network devices. +* `NAPALM_TIMEOUT`: A value to use for when an attempt to connect to a device will timeout if no response has been recieved. + +[napalm-doc]: http://napalm.readthedocs.io/en/latest/index.html +[netbox-napalm-doc]: https://netbox.readthedocs.io/en/latest/configuration/optional-settings/#napalm_username \ No newline at end of file