Overview

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

1. List all cables in the DCIM domain to get an overview of physical network connections.
2. Filter cables by status (e.g., connected or planned) to monitor network infrastructure changes.
3. Limit the number of cables returned to a specific count for pagination or performance reasons.

Properties

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.