LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The "Search by Field" operation under the "Ports" resource allows users to search for network device ports in LibreNMS by specifying a search term and the particular port field to search within. This node is useful for network administrators who want to quickly find ports based on interface names, descriptions, or aliases. For example, you might use it to locate all ports with a specific alias or to find interfaces matching a certain naming pattern.

Properties

Name Meaning
Search Term The text string to search for within the selected port field.
Search Field The port field to perform the search on. Options: Interface Name, Interface Description, Interface Alias.
Options Additional optional parameters:
• Columns: Comma-separated list of columns to return (e.g., ifName,port_id,ifAlias).

Output

The node outputs JSON data containing the search results from LibreNMS. Each item in the output corresponds to a port that matches the search criteria. The fields returned depend on the specified columns option; if no columns are specified, default fields are returned. The output does not include binary data.

Dependencies

  • Requires an active connection to a LibreNMS instance.
  • Needs an API key credential configured in n8n to authenticate requests to the LibreNMS API.
  • The base URL and SSL certificate validation settings are taken from the credential configuration.

Troubleshooting

  • Empty Results: If no ports are returned, verify that the search term and field are correct and that the LibreNMS instance contains matching data.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid Columns: Specifying non-existent column names in the "Columns" option may cause errors or empty fields in the response.
  • Connection Issues: Check network connectivity and SSL settings if the node cannot reach the LibreNMS API.

Links and References

Discussion