LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

This node integrates with the LibreNMS network monitoring system, specifically allowing users to update the description of a BGP (Border Gateway Protocol) session. It is useful in network management scenarios where administrators need to document or modify metadata about BGP sessions dynamically, such as updating notes or descriptions for clarity or operational purposes.

A practical example would be updating the description of a BGP session after a network topology change or maintenance activity, helping keep network documentation current and accessible directly from an automation workflow.

Properties

Name Meaning
BGP Session ID The unique identifier of the BGP session to update. This is required to specify which BGP session's description will be changed.
BGP Description The new description text to assign to the specified BGP session. This updates the metadata associated with the BGP session.

Output

The node outputs JSON data representing the result of the update operation on the BGP session description. Typically, this includes confirmation of the update and possibly the updated BGP session details as returned by the LibreNMS API.

If the node supports binary data output, it would generally relate to raw response data or logs, but based on the provided code and context, the primary output is structured JSON reflecting the updated BGP session state.

Dependencies

  • Requires connection to a LibreNMS instance via its REST API.
  • Needs an API key credential configured in n8n to authenticate requests against LibreNMS.
  • The base URL of the LibreNMS API must be set correctly in the credentials.
  • Optionally, SSL certificate validation can be disabled if using self-signed certificates.

Troubleshooting

  • Common Issues:

    • Incorrect or missing BGP Session ID will cause the update to fail because the target session cannot be identified.
    • Invalid or expired API credentials will prevent successful authentication.
    • Network connectivity issues between n8n and LibreNMS server can cause request failures.
    • Insufficient permissions on the API key may block update operations.
  • Error Messages:

    • "Unauthorized" or "Authentication failed": Check API key validity and permissions.
    • "BGP session not found": Verify the BGP Session ID is correct and exists in LibreNMS.
    • "Request timeout": Ensure network connectivity and LibreNMS server availability.

Resolving these typically involves verifying input parameters, checking API credentials, and ensuring the LibreNMS server is reachable and properly configured.

Links and References

Discussion