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
Interface Template → Create
AI-generatedOverview
This node interacts with the NetBox API to create an Interface Template within the DCIM domain. It is useful for network administrators and engineers who want to automate the creation of interface templates for device types in their network infrastructure. For example, it can be used to define standard interface templates for different device types to ensure consistency and streamline device provisioning.
Use Case Examples
- Creating an interface template for a specific device type with a defined interface type and name.
- Automating the addition of interface templates to device types in bulk to maintain uniformity across network devices.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is fixed to 'dcim' for Interface Templates. |
| Device Type ID | ID of the device type to which the interface template will be associated. Required if module type is not specified. |
| Name | Name of the interface template to be created. |
| Type | Type of the interface, such as virtual, bridge, or various physical interface standards. |
| Additional Fields | Optional additional fields such as module type ID, label, management only flag, and description for the interface template. |
Output
JSON
id- Unique identifier of the created interface template.name- Name of the created interface template.type- Type of the created interface template.device_type_id- ID of the device type associated with the interface template.module_type- ID of the module type if specified.label- Physical label of the interface template if provided.mgmt_only- Boolean indicating if the interface is management only.description- Description of the interface template.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Ensure the Device Type ID or Module Type ID is provided as required; missing these will cause errors.
- Verify that the interface type is valid and supported by NetBox to avoid API rejection.
- Check API credentials and network connectivity if authentication or connection errors occur.
- Error messages from the API will typically indicate missing required fields or invalid values; review the error details to correct input.
Links
- NetBox API Documentation - Interface Templates - Official documentation for the Interface Templates API in NetBox.