LibreNMS icon

LibreNMS

Interact with LibreNMS network monitoring system

Overview

The "Devices - Create" operation in this LibreNMS node allows users to add a new network device into the LibreNMS monitoring system via its API. This is useful for network administrators who want to automate the onboarding of devices for monitoring, avoiding manual entry through the LibreNMS web interface.

Typical use cases include:

  • Automatically adding newly provisioned devices to LibreNMS for monitoring.
  • Bulk importing devices from an external inventory or provisioning system.
  • Integrating device creation as part of a larger automated network management workflow.

For example, you could create a device by specifying its hostname or IP address and SNMP credentials, enabling LibreNMS to start polling it for status and metrics.

Properties

Name Meaning
Hostname The device's hostname or IP address to be added to LibreNMS.
SNMP Version The SNMP protocol version used to communicate with the device. Options: v1, v2c, v3.
Community String (For SNMP v1/v2c) The community string used for SNMP authentication, defaulting to "public".
SNMP v3 Username (For SNMP v3) The username for SNMPv3 authentication.
Authentication Level (For SNMP v3) The security level for SNMPv3. Options: No Auth, No Priv, Auth, No Priv, Auth, Priv.
Authentication Protocol (For SNMP v3 with auth) The authentication protocol used. Options: MD5, SHA.
Authentication Password (For SNMP v3 with auth) The password for authentication.
Privacy Protocol (For SNMP v3 with privacy) The privacy protocol used. Options: DES, AES.
Privacy Password (For SNMP v3 with privacy) The password for privacy encryption.
Additional Fields A collection of optional fields:
• Display Name: Friendly name for the device.
• Port: SNMP port number (default 161).
• Transport: SNMP transport protocol (UDP, TCP, UDP6, TCP6).
• Force Add: Boolean to skip validation checks and add device directly.

Output

The node outputs JSON data representing the response from the LibreNMS API after attempting to create the device. This typically includes details about the newly created device such as its ID, hostname, and other metadata returned by LibreNMS.

If the device creation fails, the output will contain error information describing what went wrong.

This node does not output binary data.

Dependencies

  • Requires access to a LibreNMS instance with API enabled.
  • Needs an API key credential configured in n8n to authenticate requests to LibreNMS.
  • The LibreNMS API base URL and SSL certificate validation settings are configured via credentials.
  • SNMP connectivity to the target device must be possible from the LibreNMS server for successful monitoring after creation.

Troubleshooting

  • Common Issues:

    • Incorrect SNMP credentials or version can cause device addition to fail.
    • Network connectivity issues between LibreNMS and the device may prevent successful polling.
    • Missing or invalid API key credential will result in authentication errors.
    • If "Force Add" is false, device validation failures (e.g., duplicate hostname) will block creation.
  • Error Messages:

    • Authentication errors indicate problems with the API key or permissions.
    • Validation errors often specify missing required fields or invalid SNMP parameters.
    • Network timeouts or connection refused errors suggest connectivity problems to the LibreNMS server or device.
  • Resolutions:

    • Verify API key correctness and permissions.
    • Confirm SNMP credentials and version match the device configuration.
    • Ensure LibreNMS server can reach the device on the specified SNMP port and transport.
    • Use "Force Add" cautiously to bypass validation if you understand the risks.

Links and References

Discussion