Overview

This node interacts with the NetBox API to retrieve console port information for devices within the DCIM domain. It is useful for network administrators or IT professionals who need to programmatically access console port details of devices managed in NetBox, such as for inventory management, auditing, or automation tasks.

Use Case Examples

1. Retrieve all console ports for devices in the DCIM domain to audit device connectivity.
2. Fetch a limited number of console ports to display in a custom dashboard or report.

Properties

Output

JSON

• id - Unique identifier of the console port.
• name - Name of the console port.
• device - Device to which the console port belongs.
• type - Type of the console port.
• status - Status of the console port.
• description - Description or notes about the console port.

Dependencies

• NetBox API
• An API key credential for authenticating with the NetBox API

Troubleshooting

• Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and device console ports.
• If the node returns an error, check the network connectivity to the NetBox server and verify the API endpoint URL is correct.
• If 'Return All' is false and the limit is set too low, you may not get all desired results; adjust the limit accordingly.

Links

• NetBox API Documentation - Console Ports - Official documentation for the NetBox API endpoint related to console ports.