LibreNMS

This integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to add a LibreNMS instance to Home Assistant.

Prerequisites

You need to obtain an API key (token) for your LibreNMS instance.

Configuration

To add the LibreNMS service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select LibreNMS.

  • Follow the instructions on screen to complete the setup.

URL

The URL of your LibreNMS instance. For example https://librenms.example.com.

API key

API key of your user account to connect to your LibreNMS instance.

Verify SSL certificate

Whether to verify the SSL certificate when SSL encryption is used to connect to your LibreNMS instance.

Data updates

The integration polls data every 60 seconds.

Binary sensors

The following binary_sensorA binary sensor is an entity that reports one of two mutually exclusive states, on or off. The device class determines how those states are labeled in the UI. For example, open/closed for a door or detected/clear for motion. [Learn more] entities are created.

Entity Description Default enabled
Status Shows the status if the device is connected or not

Troubleshooting

When reporting an issue, enable debug logging, restart the integration, and once the issue recurs, disable debug logging again (the debug log download starts automatically). If possible, also download the diagnostics data, and include both the debug log and diagnostics data with your issue report.

Known limitations

There are no known limitations.

Remove the integration

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three dots menu. Then, select Delete.

If you no longer use the API key, you can remove it from your LibreNMS instance.