LibreNMS

LibreNMS is a network monitoring solution that provides auto-discovery for network hardware and operating systems including Cisco, Linux, Juniper, Foundry, and more.

Types of Assets Fetched

This adapter fetches the following types of assets:

• Devices, Network Devices, Networks

Parameters

1. LibreNMS Domain (required) - Keep as 'https://librenms.org'.
2. API Key (required) - Use the authentication token you have generated for a user that has site viewer access to LibreNMS. For more details, see Using the API - LibreNMS Docs.
3. Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
4. HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.

Advanced Settings

• Prefer "hostname" field for device hostname - When enabled, uses the "hostname" field as the device hostname. When disabled (default), uses "sysName", falling back to "hostname". Enable this setting when your LibreNMS "hostname" field contains the actual device hostname you want to use for correlation, rather than the SNMP sysName field. This is useful when sysName might not match your DNS hostname or asset management naming conventions.
• Use "display" field as device name - When enabled, uses the "display" field as the device name, falling back to "hostname", then "sysName", then device ID. When disabled (default), device ID is used as the name. Enable this setting when you've configured custom display names in LibreNMS that are more user-friendly than the default device IDs. This provides better readability in the Axonius UI when viewing and querying devices.
• Parse ports as network interfaces (default: disabled) - Select this option to request the port status, speed, MTU, MAC address, and VLAN columns and populate the device network interfaces.
• Fill the device ARP table (default: disabled) - Select this option to populate each device's ARP table from the ARP entries already retrieved for that device.
• Fetch LLDP/CDP links (default: disabled) - Select this option to retrieve LLDP/CDP link data and populate the connected-device details.
• Fetch VLANs (default: disabled) - Select this option to retrieve VLANs and create a Network asset for each device VLAN.
• Fetch BGP peers (default: disabled) - Select this option to retrieve BGP peer details for each device.
• Fetch OSPF neighbors (default: disabled) - Select this option to retrieve OSPF neighbor details for each device.

APIs

Axonius uses the LibreNMS API (v0). The adapter calls the following endpoints:

• GET /api/v0/devices - Retrieves the list of devices.
• GET /api/v0/devices/{device_id}/fdb - Retrieves the forwarding database (MAC address table) of a device.
• GET /api/v0/devices/{device_id}/ip - Retrieves the IP addresses of a device.
• GET /api/v0/ports - Retrieves ports.
• GET /api/v0/resources/ip/arp/all - Retrieves ARP entries.
• GET /api/v0/resources/links - Retrieves LLDP/CDP links. Called only when Fetch LLDP/CDP links is enabled.
• GET /api/v0/resources/vlans - Retrieves VLANs. Called only when Fetch VLANs is enabled.
• GET /api/v0/bgp - Retrieves BGP peers. Called only when Fetch BGP peers is enabled.
• GET /api/v0/ospf - Retrieves OSPF neighbors. Called only when Fetch OSPF neighbors is enabled.