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
Cable → List
AI-generatedOverview
This node interacts with the NetBox API to list cables within the DCIM domain. It is useful for retrieving cable information such as IDs, status, type, color, label, tenant ID, length, and creation or update timestamps. This can help network administrators or engineers to manage and audit physical network connections efficiently.
Use Case Examples
- List all cables in the DCIM domain to get an overview of physical network connections.
- Filter cables by status (e.g., connected or planned) to monitor network infrastructure changes.
- Limit the number of cables returned to a specific count for pagination or performance reasons.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management. |
| Return All | Determines whether to return all cable results or limit the number of results. |
| Limit | Maximum number of cable results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the cable list based on various attributes such as ID, search query, status, type, color, label, tenant ID, length, length unit, ordering, and creation or update timestamps. |
Output
JSON
id- Unique identifier of the cable.status- Current status of the cable (e.g., connected, planned).type- Type of the cable.color- Color of the cable in hexadecimal format.label- Label assigned to the cable.tenant_id- Identifier of the tenant associated with the cable.length- Length of the cable.length_unit- Unit of measurement for the cable length.created- Timestamp when the cable was created.last_updated- Timestamp when the cable was last updated.
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 cables resource.
- If the node returns an error, check the network connectivity to the NetBox API endpoint.
- Verify that the filter parameters are valid and correctly formatted, especially date and numeric fields.
- If 'Return All' is set to false, ensure the 'Limit' value is a positive integer to avoid unexpected results.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.