NetBox icon

NetBox

Consume NetBox API

Actions243

Console Port → Trace

AI-generated

Overview

This node interacts with the NetBox API to perform operations related to console ports within the DCIM domain. Specifically, the 'Trace' operation for the 'Console Port' resource allows users to trace the connection path or details of a specific console port by providing its ID. This is useful for network administrators or engineers who need to track or troubleshoot console port connections in their infrastructure.

Use Case Examples

  1. Tracing a console port connection by providing its Console Port ID to understand its connection path or status within the network.
  2. Using the node to fetch detailed trace information of a console port for diagnostics or documentation purposes.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, e.g., DCIM, IPAM, Tenancy, etc. For this operation, it is set to 'dcim'.
Console Port ID The unique identifier of the console port to trace. This is required to specify which console port's trace information is to be retrieved.

Output

JSON

  • traceDetails - The detailed trace information of the specified console port returned from the NetBox API.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Console Port ID is valid and exists in the NetBox instance; invalid IDs will cause errors.
  • Verify that the API credentials provided have sufficient permissions to access console port data.
  • If the node throws an error, check network connectivity to the NetBox API endpoint.
  • Enable 'Continue on Fail' option to handle errors gracefully and receive error messages as output instead of stopping execution.

Discussion