Overview

This node interacts with the NetBox API to retrieve information about a specific interface within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about network interfaces managed in NetBox, such as for network inventory management, monitoring, or automation workflows.

Use Case Examples

1. Retrieve details of a network interface by providing its Interface ID within the DCIM domain.
2. Use the node to get interface information to integrate with other network management tools or dashboards.

Properties

Output

JSON

• id - The unique identifier of the interface record.
• name - The name of the interface.
• status - The current status of the interface.
• description - Description or notes about the interface.
• mac_address - MAC address assigned to the interface.
• mtu - Maximum Transmission Unit size for the interface.
• speed - Speed of the interface.
• type - Type or category of the interface.
• connected_device - Details about the device connected to this interface.

Dependencies

• NetBox API with appropriate credentials

Troubleshooting

• Ensure the Interface ID is correct and exists in the NetBox instance to avoid 'not found' errors.
• Verify that the API credentials have sufficient permissions to access the DCIM domain and interface resources.
• Check network connectivity to the NetBox API endpoint to prevent connection errors.
• If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

• NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.