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 → Create
AI-generatedOverview
This node interacts with the NetBox API to create a new Console Port Template within the DCIM domain. It is useful for network administrators who want to automate the creation of console port templates for device types or module types in their network infrastructure management system. For example, it can be used to define physical port templates with specific labels, types, and descriptions for devices managed in NetBox.
Use Case Examples
- Creating a console port template named 'Main Console Port' for a specific device type with a DE-9 connector and a descriptive label.
- Automating the addition of console port templates for new device types or modules in bulk via workflow automation.
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. |
| Name | The name of the console port template to be created. |
| Additional Fields | Optional additional fields to specify details about the console port template such as device type ID, module type ID, physical label, port connector type, and description. |
Output
JSON
id- Unique identifier of the created console port template.name- Name of the created console port template.device_type- ID of the device type associated with the console port template, if specified.module_type- ID of the module type associated with the console port template, if specified.label- Physical label of the port as specified.type- Physical type of the port connector.description- Description of the console port template.
Dependencies
- NetBox API
- An API key credential for authenticating with the NetBox API
Troubleshooting
- Ensure the domain is set to 'dcim' as console port templates belong to this domain.
- If neither device type ID nor module type ID is provided, the API may reject the creation request; provide at least one.
- Check that the API key credential is valid and has permissions to create console port templates.
- Common errors include validation errors from missing required fields or invalid field values; verify input data before execution.
Links
- NetBox API Documentation for Console Port Templates - Official documentation for the Console Port Templates endpoint in the NetBox API.