LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The node integrates with the LibreNMS network monitoring system, specifically allowing users to update the description of a network device port. This operation is useful for network administrators who want to maintain accurate and up-to-date metadata about their network ports directly from an automation workflow. For example, after physically changing or repurposing a port on a switch, an administrator can use this node to update the port's description to reflect its new role or location.

Properties

Name Meaning
Port ID The unique identifier of the port to update. This is required to specify which port's description will be changed.
Description The new description text to assign to the specified port.

Output

The node outputs JSON data representing the result of the update operation. Typically, this includes confirmation that the port description was successfully updated, possibly returning the updated port object or status information. The output does not include binary data.

Dependencies

  • Requires 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 derived from the provided credentials.

Troubleshooting

  • Invalid Port ID: If the specified Port ID does not exist, the node may return an error indicating the port was not found. Verify the Port ID is correct.
  • Authentication Errors: Failure to authenticate with the LibreNMS API will prevent updates. Ensure the API key credential is valid and has sufficient permissions.
  • Network Issues: Connectivity problems between n8n and LibreNMS can cause timeouts or request failures. Check network access and firewall rules.
  • Permission Denied: The API user must have rights to modify port descriptions; otherwise, the update will fail.
  • Malformed Description: Providing invalid characters or overly long descriptions might cause errors depending on LibreNMS constraints.

Links and References

Discussion