NetBox icon

NetBox

Consume NetBox API

Actions243

Cable Termination → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new cable termination within the DCIM domain. It is useful for network administrators or automation engineers who need to programmatically add cable terminations to their network infrastructure management system. For example, when a new cable is installed, this node can automate the process of recording the termination details in NetBox.

Use Case Examples

  1. Creating a cable termination for a specific cable by specifying the cable ID, which end of the cable (A or B), the termination type (e.g., dcim.interface), and the termination object's ID.
  2. Automating network documentation by adding cable terminations as part of a larger workflow that manages network device configurations.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Cable ID The ID of the cable to which this termination belongs.
Cable End Specifies which end of the cable the termination is on, either 'A' or 'B'.
Termination Type The content type of the termination object, e.g., 'dcim.interface'.
Termination ID The ID of the termination object.

Output

JSON

  • id - The unique identifier of the created cable termination.
  • cable_id - The ID of the cable this termination belongs to.
  • termination_type - The content type of the termination object.
  • termination_id - The ID of the termination object.
  • cable_end - Which end of the cable the termination is on (A or B).
  • created - Timestamp when the cable termination was created.

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to create cable terminations in the NetBox instance.
  • Verify that the cable ID and termination ID provided exist in the NetBox system to avoid 'not found' errors.
  • Check that the termination type string is correctly formatted and corresponds to a valid content type in NetBox.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

Discussion