Skip to content

Commit

Permalink
docs: 📝 update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bile0026 committed Dec 16, 2024
1 parent 5949b2f commit 83888bb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/admin/integrations/librenms_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ The way you add your LibreNMS server instance is through the "External Integrati

Once this is created, go into the Extensibility Menu and select `External Integrations`. Add an External Intergration with the Remote URL being your LibreNMS server URL (including http(s)://), set the method to `GET`, and select any other headers/settings you might need for your specific instance. Select the secrets group you created as this will inject the API token. Once created, you will select this External Integration when you run the LibreNMS to Nautobot SSoT job.

![LibreNMS External Integration](../../images/librenms-external-integration.png)

#### LibreNMS as DataTarget

NotYetImplemented
Expand Down
Binary file added docs/images/librenms-external-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/user/integrations/librenms.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@

### LibreNMS as DataSource

The LibreNMS SSoT integration is built as part of the [Nautobot Single Source of Truth (SSoT)](https://github.com/nautobot/nautobot-app-ssot) app. the SSoT app enables Nautobot to be the aggregation point for data coming from multiple systems of record (SoR).

#### Job Options

- Debug: Additional Logging
- Librenms Server: External integration object pointing to the required LibreNMS instance.
- hostname_field: Which LibreNMS field to use as the hostname in Nautobot. sysName or hostanme.
- sync_location_parents: Whether to lookup City and State to add parent locations for geo locations.

From LibreNMS into Nautobot, the app synchronizes devices, their interfaces, associated IP addresses, and Locations. Here is a table showing the data mappings when syncing from LibreNMS.

| LibreNMS objects | Nautobot objects |
| ----------------------- | ---------------------------- |
| geo location | Location `*` |
| device | Device |
| interface | Interface |
| device os | Platform/Manufacturer `**` |
| os version | Software/SoftwareImage |
| ip address | IPAddress |
| hardware | DeviceType |

`*` geo locations are looked up gia the [geocode api](https://geocode.xyz) if gps coordinates are set in LibreNMS and Regions will be created for City and State as parents for the actual location.

`**` Device OS from LibreNMS is not standardized and therefore there is a mapping that can be updated in the `constants.py` file for the integration as more device manufacturers and platforms need to be added.

### LibreNMS as DataTarget

Expand Down

0 comments on commit 83888bb

Please sign in to comment.