NetBox icon

NetBox

Consume NetBox API

Actions243

Cable → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific cable within the DCIM domain. It is useful for network administrators or IT professionals who need to fetch detailed data about cables managed in NetBox, such as cable attributes or status, by specifying the cable's unique ID.

Use Case Examples

  1. Retrieve details of a cable by providing its Cable ID in the DCIM domain of NetBox.
  2. Use this node to get cable information for network documentation or troubleshooting.

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.
Cable ID The unique identifier of the cable to retrieve from NetBox.

Output

JSON

  • id - The unique identifier of the cable record.
  • status - The status of the cable.
  • type - The type of cable.
  • length - The length of the cable.
  • termination_a - Details about one end of the cable termination.
  • termination_b - Details about the other end of the cable termination.
  • label - Label or name of the cable.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Cable ID provided is valid and exists in the NetBox instance.
  • Verify that the API credentials have sufficient permissions to access cable data in the DCIM domain.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authentication failures, resource not found (404), or permission denied (403). Resolving these involves verifying credentials, Cable ID correctness, and user permissions.

Links

Discussion