Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Cable → Update
AI-generatedOverview
This node interacts with the NetBox API to update cable records within the DCIM domain. It allows users to modify various attributes of a cable, such as its terminations, type, status, label, color, length, tenant association, description, tags, and custom fields. This is useful in network management scenarios where cable details need to be kept current, for example, updating the physical type of a cable or changing its operational status after maintenance.
Use Case Examples
- Updating the physical type of a cable from CAT5e to CAT6 after replacement.
- Changing the status of a cable to 'decommissioning' when it is being retired.
- Adding or modifying the label and color of a cable for easier identification in documentation.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management. |
| Cable ID | The unique identifier of the cable record to update. |
| Update Fields | A collection of fields to update on the cable record, including terminations, type, status, label, color, length, tenant, description, tags, and custom fields. |
Output
JSON
id- The unique identifier of the updated cable record.type- The physical type of the cable after update.status- The operational status of the cable after update.label- The physical label of the cable after update.color- The color of the cable after update.length- The length of the cable after update.length_unit- The unit of measurement for the cable length after update.tenant- The tenant ID associated with the cable after update.description- The description of the cable after update.tags- Tags associated with the cable after update.custom_fields- Custom fields data of the cable after update.
Dependencies
- NetBox API with appropriate API key credentials
Troubleshooting
- Ensure the Cable ID provided exists in the NetBox instance; otherwise, the update will fail with a not found error.
- Validate JSON format for A Terminations and B Terminations fields to avoid parsing errors.
- Check that the API credentials have sufficient permissions to update cable records.
- If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message as JSON.
Links
- NetBox API Documentation for Cables - Official documentation for the NetBox API cable resource, including update operations.