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 Server Port → List
AI-generatedOverview
This node interacts with the NetBox API to list console server ports within the DCIM domain. It is useful for retrieving detailed information about console server ports in a network infrastructure managed by NetBox, allowing users to filter and limit the results based on various criteria.
Use Case Examples
- A network administrator wants to retrieve all console server ports associated with a specific device or module.
- A user needs to search for console server ports by name or label to audit or manage network equipment connections.
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 | Determines whether to return all results or limit the number of results returned. |
| Limit | Maximum number of console server port results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of console server ports based on various attributes such as ID, device ID, module ID, name, label, type, speed, connection status, ordering, and creation or update timestamps. |
Output
JSON
id- Unique identifier of the console server port.device_id- Identifier of the device associated with the console server port.module_id- Identifier of the module associated with the console server port.name- Name of the console server port.label- Label assigned to the console server port.type- Type of the console server port (e.g., DE-9, DB-25, RJ-45, USB types).speed- Baud rate speed of the console server port.mark_connected- Boolean flag indicating if the port is marked as connected.created- Timestamp when the console server port was created.last_updated- Timestamp when the console server port was last updated.
Dependencies
- NetBox API
- API key credential for authentication
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Incorrect filter values or unsupported filter fields may result in empty or error responses. Verify filter parameters against NetBox API documentation.
- Network connectivity issues to the NetBox server can cause request failures. Check network access and server availability.
- If the node throws errors, enabling 'Continue on Fail' allows the workflow to proceed and outputs the error message for debugging.
Links
- NetBox API Documentation - Official documentation for the NetBox API endpoints and parameters.