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 Server Port Template → Update
AI-generatedOverview
This node interacts with the NetBox API to update a Console Server Port Template within the DCIM domain. It is useful for automating updates to console server port templates, such as changing the name, device type, module type, label, port type, or description. For example, it can be used to programmatically update port template details in a network infrastructure management workflow.
Use Case Examples
- Updating the name and label of a console server port template to reflect new hardware changes.
- Modifying the physical port type of a console server port template to match updated device specifications.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management. |
| Console Server Port Template ID | The unique identifier of the console server port template to update. |
| Update Fields | Collection of fields that can be updated on the console server port template, including name, device type ID, module type ID, label, port type, and description. |
Output
JSON
id- ID of the updated console server port template record.name- Name of the updated console server port template.device_type- Device type ID associated with the updated port template.module_type- Module type ID associated with the updated port template.label- Physical label of the updated port.type- Physical type of the port connector after update.csptDescription- Description of the updated console server port template.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Ensure the Console Server Port Template ID is correct and exists in NetBox to avoid 'not found' errors.
- Verify that the API key credential has sufficient permissions to update console server port templates.
- Check that the domain is set to 'dcim' as this resource is only available under the DCIM domain.
- If the update fields are empty or invalid, the API may reject the request; ensure valid data is provided.
Links
- NetBox API Documentation - Console Server Port Templates - Official NetBox API documentation for managing console server port templates.