NetBox icon

NetBox

Consume NetBox API

Actions243

Cable Termination → Update

AI-generated

Overview

This node updates a Cable Termination record in the NetBox API under the DCIM domain. It is useful for network administrators who need to modify details of cable terminations, such as changing the cable ID, cable end (A or B), termination type, or termination ID. For example, if a cable termination needs to be reassigned to a different cable or interface, this node facilitates that update via the NetBox API.

Use Case Examples

  1. Updating the cable ID and cable end of a specific cable termination to reflect physical changes in the network.
  2. Changing the termination type and termination ID to correct or update the connection details of a cable termination.

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 Termination ID The unique identifier of the cable termination record to update.
Update Fields A collection of fields that can be updated for the cable termination, including Cable ID, Cable End (A or B), Termination Type, and Termination ID.

Output

JSON

  • id - The unique identifier of the updated cable termination record.
  • cable - The ID of the cable associated with the termination.
  • cable_end - Indicates which end of the cable (A or B) the termination is on.
  • termination_type - The content type of the termination object.
  • termination_id - The ID of the termination object linked to the cable termination.

Dependencies

  • NetBox API with appropriate credentials for authentication

Troubleshooting

  • Ensure the Cable Termination ID provided exists in the NetBox instance; otherwise, the update will fail.
  • Verify that the API credentials have sufficient permissions to update cable termination records.
  • Check that the fields in 'Update Fields' are valid and correctly formatted to avoid API errors.

Links

Discussion