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 → List
AI-generatedOverview
This node interacts with the NetBox API to list interface templates within the DCIM domain. It allows users to retrieve a list of interface templates with optional filtering, limiting, and ordering of results. This is useful for network administrators who want to programmatically access and manage interface template data from NetBox, such as fetching templates by device type, name, or interface type.
Use Case Examples
- A network engineer wants to retrieve all interface templates related to a specific device type to automate configuration management.
- An IT administrator needs to list interface templates with a specific name pattern to audit network configurations.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management. |
| Return All | Determines whether to return all results or limit the number of results. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of interface templates, such as by ID, search query, device type ID, module type ID, name, type, management only flag, and ordering field. |
Output
JSON
id- Unique identifier of the interface template.name- Name of the interface template.type- Type of the interface template.device_type_id- ID of the device type associated with the interface template.module_type_id- ID of the module type associated with the interface template.mgmt_only- Boolean indicating if the interface template is for management only.other_properties- Additional properties returned by the NetBox API for each interface template.
Dependencies
- NetBox API
- API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and interface templates resource.
- If the node returns an error, check the filter values for correctness, especially numeric IDs and option values.
- If no results are returned, verify that the filters are not too restrictive or that the interface templates exist in the NetBox instance.
- Common error messages may include authentication errors, invalid filter parameters, or network connectivity issues. Resolving these involves checking credentials, input parameters, and network access.
Links
- NetBox API Documentation - Interface Templates - Official NetBox API documentation for the interface templates resource in the DCIM domain.