Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Console Port → List
AI-generatedOverview
This node interacts with the NetBox API to list console ports within the DCIM domain. It is useful for retrieving detailed information about console ports in a network infrastructure managed by NetBox, such as for inventory management, auditing, or monitoring purposes. Users can filter the list by various criteria like ID, device ID, module ID, name, label, port type, speed, and timestamps, and can choose to return all results or limit the number of results.
Use Case Examples
- Retrieve all console ports for a specific device to audit connectivity.
- List console ports filtered by port type and speed for network performance analysis.
- Fetch a limited number of console ports created after a certain date for recent changes review.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management. |
| Return All | Boolean flag to determine whether to return all console port results or limit the number of results. |
| Limit | Maximum number of console port results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of console ports based on various attributes such as ID, device ID, module ID, name, label, port type, speed, connection status, ordering, and creation or update timestamps. |
Output
JSON
id- Unique identifier of the console port.device_id- Identifier of the device to which the console port belongs.module_id- Identifier of the module associated with the console port.name- Name of the console port.label- Label assigned to the console port.type- Type of the console port (e.g., DE-9, RJ-45, USB types).speed- Baud rate speed of the console port.mark_connected- Boolean flag indicating if the port is marked as connected.created- Timestamp when the console port was created.last_updated- Timestamp when the console port was last updated.
Dependencies
- NetBox API
- API authentication token or API key credential
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key or token is correctly configured.
- Filtering parameters may cause no results if values do not match existing console ports; verify filter values.
- API rate limits or network connectivity issues may cause request failures; check network and API usage limits.
- Error messages from the NetBox API will be returned in the output if 'Continue on Fail' is enabled, otherwise the node will throw an error.
Links
- NetBox API Documentation - Console Ports - Official NetBox API documentation for console ports resource, detailing available filters and response structure.