From ab1a5f32efb19ef85afe3d34f0947694522325d2 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 30 Aug 2021 11:51:18 -0400 Subject: [PATCH] Update references to NAPALM in docs --- docs/additional-features/napalm.md | 2 +- docs/configuration/optional-settings.md | 2 +- docs/installation/3-netbox.md | 2 +- docs/models/dcim/platform.md | 2 +- docs/release-notes/version-2.1.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/additional-features/napalm.md b/docs/additional-features/napalm.md index 957a5a214..2efaa839e 100644 --- a/docs/additional-features/napalm.md +++ b/docs/additional-features/napalm.md @@ -1,6 +1,6 @@ # NAPALM -NetBox supports integration with the [NAPALM automation](https://napalm-automation.net/) library. NAPALM allows NetBox to serve a proxy for operational data, fetching live data from network devices and returning it to a requester via its REST API. Note that NetBox does not store any NAPALM data locally. +NetBox supports integration with the [NAPALM automation](https://github.com/napalm-automation/napalm) library. NAPALM allows NetBox to serve a proxy for operational data, fetching live data from network devices and returning it to a requester via its REST API. Note that NetBox does not store any NAPALM data locally. The NetBox UI will display tabs for status, LLDP neighbors, and configuration under the device view if the following conditions are met: diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 5bd7d1c95..e324f3d46 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -343,7 +343,7 @@ Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Pr ## NAPALM_PASSWORD -NetBox will use these credentials when authenticating to remote devices via the [NAPALM library](https://napalm-automation.net/), if installed. Both parameters are optional. +NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../additional-features/napalm.md), if installed. Both parameters are optional. !!! note If SSH public key authentication has been set up on the remote device(s) for the system account under which NetBox runs, these parameters are not needed. diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index f0887aa4e..e0e823aec 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -200,7 +200,7 @@ All Python packages required by NetBox are listed in `requirements.txt` and will ### NAPALM -The [NAPALM automation](https://napalm-automation.net/) library allows NetBox to fetch live data from devices and return it to a requester via its REST API. The `NAPALM_USERNAME` and `NAPALM_PASSWORD` configuration parameters define the credentials to be used when connecting to a device. +Integration with the [NAPALM automation](../additional-features/napalm.md) library allows NetBox to fetch live data from devices and return it to a requester via its REST API. The `NAPALM_USERNAME` and `NAPALM_PASSWORD` configuration parameters define the credentials to be used when connecting to a device. ```no-highlight sudo sh -c "echo 'napalm' >> /opt/netbox/local_requirements.txt" diff --git a/docs/models/dcim/platform.md b/docs/models/dcim/platform.md index a860904b5..65188fa6e 100644 --- a/docs/models/dcim/platform.md +++ b/docs/models/dcim/platform.md @@ -4,6 +4,6 @@ A platform defines the type of software running on a device or virtual machine. Platforms may optionally be limited by manufacturer: If a platform is assigned to a particular manufacturer, it can only be assigned to devices with a type belonging to that manufacturer. -The platform model is also used to indicate which [NAPALM](https://napalm-automation.net/) driver and any associated arguments NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform. +The platform model is also used to indicate which [NAPALM](../../additional-features/napalm.md) driver and any associated arguments NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform. The assignment of platforms to devices is an optional feature, and may be disregarded if not desired. diff --git a/docs/release-notes/version-2.1.md b/docs/release-notes/version-2.1.md index e5fa41d82..d4804661f 100644 --- a/docs/release-notes/version-2.1.md +++ b/docs/release-notes/version-2.1.md @@ -121,7 +121,7 @@ A new API endpoint has been added at `/api/ipam/prefixes//available-ips/`. A #### NAPALM Integration ([#1348](https://github.com/netbox-community/netbox/issues/1348)) -The [NAPALM automation](https://napalm-automation.net/) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py. +The [NAPALM automation](https://github.com/napalm-automation/napalm) library provides an abstracted interface for pulling live data (e.g. uptime, software version, running config, LLDP neighbors, etc.) from network devices. The NetBox API has been extended to support executing read-only NAPALM methods on devices defined in NetBox. To enable this functionality, ensure that NAPALM has been installed (`pip install napalm`) and the `NETBOX_USERNAME` and `NETBOX_PASSWORD` [configuration parameters](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#netbox_username) have been set in configuration.py. ### Enhancements