LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The node integrates with the LibreNMS network monitoring system, specifically providing operations related to network devices. The "Get Maintenance Status" operation retrieves the current maintenance status of a specified device by its hostname or device ID. This is useful for network administrators who want to programmatically check if a device is under maintenance, helping in automation workflows such as alert suppression, maintenance scheduling, or reporting.

Practical examples include:

  • Automatically pausing alerts for devices currently under maintenance.
  • Generating reports on device maintenance windows.
  • Triggering notifications or workflows when a device enters or exits maintenance mode.

Properties

Name Meaning
Device The hostname or unique ID of the device whose maintenance status you want to retrieve.

Output

The output JSON will contain the maintenance status information of the specified device. This typically includes fields indicating whether the device is currently under maintenance, start and end times of the maintenance window, and possibly additional metadata about the maintenance event.

If the node supports binary data output (not indicated here), it would represent any associated files or logs related to the maintenance status, but this is not evident from the provided code.

Dependencies

  • Requires an active connection to a LibreNMS instance via its API.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL of the LibreNMS API must be set in the credentials.
  • Optionally, SSL certificate validation can be disabled based on credential settings.

Troubleshooting

  • Common issues:

    • Invalid or missing device identifier leading to no data returned.
    • Authentication failures due to incorrect or expired API keys.
    • Network connectivity problems between n8n and the LibreNMS server.
    • SSL certificate errors if the LibreNMS server uses self-signed certificates and validation is not disabled.
  • Error messages:

    • Unauthorized or 401 errors indicate issues with API credentials.
    • 404 errors may mean the device ID or hostname does not exist in LibreNMS.
    • Timeout or network errors suggest connectivity problems.
  • Resolutions:

    • Verify the device identifier is correct and exists in LibreNMS.
    • Check and update API credentials.
    • Ensure network access and firewall rules allow communication.
    • Adjust SSL validation settings if using self-signed certificates.

Links and References

Discussion