Nodes

In general, a node can be any device in a network. This concept allows you to discover resources on the network. A node has a unique ID that allows an API to get information about it. OpenNMS also supports a mechanism to reference a foreign node by its own ID, such as a Space device ID. For more information about referencing a Space device ID as a foreign source and ID pair within OpenNMS APIs, see the "Mapping Space Device IDs to OpenNMS Node IDs" section of the Fault and Performance APIs topic.

APIs for Nodes

  • /api/space/opennms/nodes

    Returns a list of nodes that includes the ID and node label.

  • /api/space/opennms/nodes/{id}/ipinterfaces

    Returns a specific node by ID.

  • /api/space/opennms/nodes/{id}/ipinterfaces/{ipAddress}

    Returns the list of IP interfaces associated with the given node.

  • /api/space/opennms/nodes/{id}/ipinterfaces/{ipAddress}/services

    Returns the list of services associated with the given node and IP interface.

  • /api/space/opennms/nodes/{id}/ipinterfaces/{ipAddress}/services/{service}

    Returns the requested service associated with the given node, service name, and IP interface.

  • /api/space/opennms/nodes/{id}/snmpinterfaces

    Returns the list of SNMP interfaces associated with the given node.

  • /api/space/opennms/nodes/{id}/snmpinterfaces/{ifIndex}

    Returns the specific interface associated with the given node and ifIndex.

  • /api/space/opennms/nodes/{id}/categories

    Returns the list of categories associated with the given node.

  • /api/space/opennms/nodes/{id}/categories/{categoryName}

    Returns the category associated with the given node and category name.

  • /api/space/opennms/nodes/{id}/assetRecord

    Returns the asset record associated with the given node.