LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The node integrates with the LibreNMS network monitoring system, specifically enabling users to search for device ports based on a given search term. This operation is useful in scenarios where network administrators need to quickly locate ports matching certain criteria, such as interface names or aliases, within their monitored infrastructure.

For example, a user might want to find all ports whose names contain "eth0" or have a specific alias set, facilitating troubleshooting or inventory management tasks.

Properties

Name Meaning
Search Term The string term used to search for matching ports.
Options Additional optional parameters:
   Columns Comma-separated list of port data columns to return (e.g., ifName, port_id, ifAlias).

Output

The node outputs JSON data representing the search results for ports. Each item in the output corresponds to a port that matches the search term, containing fields as specified by the optional "Columns" property. The structure typically includes port identifiers, names, aliases, and other relevant port attributes.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a LibreNMS instance via its API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL and SSL certificate validation settings are configurable through credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or empty search term may result in no results returned.
    • Specifying non-existent column names in the "Columns" option could lead to incomplete or empty data fields.
  • Error Messages:

    • Authentication errors typically indicate issues with the API key or URL configuration.
    • Network errors may occur if the LibreNMS server is unreachable or SSL certificates are not trusted.
  • Resolutions:

    • Verify API credentials and endpoint URL.
    • Ensure the search term is correctly specified and not empty.
    • Use valid column names as per LibreNMS API documentation.

Links and References

Discussion