NetBox icon

NetBox

Consume NetBox API

Actions243

Cable Termination → List

AI-generated

Overview

This node interacts with the NetBox API to list cable terminations within the DCIM domain. It is useful for retrieving detailed information about cable terminations in a network infrastructure managed by NetBox. Users can filter results by various criteria such as cable termination ID, cable ID, cable end (A or B), termination type, termination ID, and date filters. It supports returning all results or limiting the number of results returned.

Use Case Examples

  1. Retrieve all cable terminations in the DCIM domain to audit network connections.
  2. Filter cable terminations by cable ID to find specific cable endpoints.
  3. List cable terminations created after a certain date to monitor recent changes.

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 cable termination results or limit the number of results.
Limit Maximum number of cable termination results to return when 'Return All' is false.
Filters Collection of filters to narrow down the list of cable terminations based on specific criteria.

Output

JSON

  • id - Unique identifier of the cable termination.
  • cable_id - Identifier of the cable associated with the termination.
  • cable_end - Specifies which end of the cable (A or B) the termination represents.
  • termination_type - Content type of the termination object, e.g., dcim.interface.
  • termination_id - Identifier of the termination object.
  • created - Timestamp when the cable termination was created.
  • last_updated - Timestamp when the cable termination was last updated.

Dependencies

  • NetBox API
  • API authentication token or key

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key or token is correctly configured.
  • Incorrect filter values may result in no data returned; verify filter parameters are valid and correctly formatted.
  • Network connectivity issues to the NetBox server can cause request failures; check network access and server status.
  • If the node throws errors, enabling 'Continue on Fail' can help handle errors gracefully by returning error messages as output.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.

Discussion