Overview

This node interacts with the NetBox API to retrieve information about a connected device within the DCIM domain. It is useful for scenarios where you need to fetch details about a device connected to another device, such as in network infrastructure management or data center asset tracking. For example, you can get the peer device and peer interface details of a connected device to understand network topology or troubleshoot connectivity issues.

Use Case Examples

1. Retrieve the connected device details by specifying the peer device name and peer interface name within the DCIM domain.
2. Use the node to fetch connected device information to automate network documentation or monitoring workflows.

Properties

Output

JSON

• id - ID of the connected device record.
• device - Details of the device connected.
• interface - Interface details of the connected device.
• connection_status - Status of the connection between devices.
• peer_device - Name of the peer device.
• peer_interface - Name of the peer interface on the peer device.

Dependencies

• NetBox API
• An API key credential for authentication

Troubleshooting

• Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and connected device resources.
• Verify that the peer device and peer interface names are correctly specified and exist in the NetBox instance.
• Common error messages may include authentication failures, resource not found, or invalid parameters. Check the error message details and adjust the input parameters accordingly.
• If 'Continue on Fail' is enabled, errors will be returned as output instead of stopping execution.