LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The node integrates with the LibreNMS network monitoring system, specifically focusing on the "Switching" resource for operations related to VLANs, links, and switching data. The "List FDB" operation retrieves entries from the Forwarding Database (FDB), which contains MAC address table information used by network switches to map MAC addresses to physical ports.

This node is beneficial in scenarios where network administrators need to:

  • Query the MAC address forwarding table to troubleshoot connectivity issues.
  • Monitor which devices are connected to specific switch ports.
  • Filter FDB entries by MAC address to locate a particular device on the network.

For example, a user can list all FDB entries or filter them by a specific MAC address to find out which port a device is connected to.

Properties

Name Meaning
MAC Address Optional string to filter the FDB entries by a specific MAC address (e.g., 00:11:22:33:44:55)

Output

The output JSON contains the list of FDB entries retrieved from LibreNMS. Each entry typically includes details such as:

  • MAC address
  • Associated switch port
  • VLAN information
  • Possibly other metadata related to the forwarding database entry

If binary data were involved (e.g., device images or logs), it would be summarized accordingly, but this operation focuses on JSON data representing network switching information.

Dependencies

  • Requires an API key credential for authenticating with the LibreNMS API.
  • Needs the LibreNMS instance URL configured in the credentials.
  • The node uses the LibreNMS REST API v0 endpoints under /api/v0.
  • SSL certificate validation can be optionally skipped based on credential settings.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect LibreNMS URL or network connectivity issues may prevent API calls.
    • Filtering by MAC address requires correct formatting; invalid MAC formats might return no results.
  • Error Messages:
    • Authentication errors usually indicate problems with the API key or permissions.
    • HTTP 404 or 400 errors suggest incorrect endpoint usage or malformed requests.
    • Timeout errors may occur if the LibreNMS server is unreachable.

To resolve these, verify API credentials, ensure the LibreNMS server is accessible, and confirm that the MAC address filter (if used) is correctly formatted.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions.

Discussion