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
Console Port Template → Update
AI-generatedOverview
This node updates a Console Port Template resource in the NetBox API under the DCIM domain. It is useful for managing and modifying existing console port templates by changing their properties such as name, device type ID, module type ID, label, port type, and description. For example, a user can update the label or type of a console port template to reflect changes in hardware or documentation.
Use Case Examples
- Updating the label and type of a console port template to match new hardware specifications.
- Changing the device type ID associated with a console port template to link it to a different device model.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with, here it is 'dcim' for device and component management. |
| Console Port Template ID | The unique identifier of the console port template to update. |
| Update Fields | The fields to update on the console port template, including name, device type ID, module type ID, label, type, and description. |
Output
JSON
id- The ID of the updated console port template.name- The name of the updated console port template.device_type- The device type ID associated with the updated console port template.module_type- The module type ID associated with the updated console port template.label- The physical label of the updated console port template.type- The physical type of the port connector of the updated console port template.description- The description of the updated console port template.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Ensure the Console Port Template ID is correct and exists in the NetBox instance.
- Verify that the API key credential has sufficient permissions to update console port templates.
- Check that the domain is set to 'dcim' as this resource is under the DCIM domain.
- Common error messages include authentication failures, resource not found, or validation errors on update fields. Verify the input data and credentials to resolve these.
Links
- NetBox API Documentation for Console Port Templates - Official API documentation for managing console port templates in NetBox.