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
Front Port Template → List
AI-generatedOverview
This node interacts with the NetBox API to list front port templates within the DCIM domain. It allows users to retrieve a collection of front port templates, optionally filtered and limited by various criteria such as ID, device type ID, module type ID, name, port type, color, and ordering. This is useful for network administrators or engineers who want to programmatically access and manage front port template data from NetBox for inventory, configuration, or auditing purposes.
Use Case Examples
- A network engineer wants to retrieve all front port templates related to a specific device type to audit the available port configurations.
- An automation workflow needs to fetch a limited number of front port templates filtered by name or type to update documentation or perform batch operations.
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 returned. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of front port templates based on criteria such as ID, search query, device type ID, module type ID, name, port type, color, and ordering. |
Output
JSON
id- Unique identifier of the front port template.name- Name of the front port template.type- Type of the front port template port.color- Color associated with the front port template.device_type_id- ID of the device type associated with the front port template.module_type_id- ID of the module type associated with the front port template.additional_properties- Other properties returned by the NetBox API for each front port template.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Incorrect domain or resource selection can lead to no data or errors; verify that 'dcim' domain and 'front-port-templates' resource are selected.
- Filters with invalid values or types may cause the API to return errors; validate filter inputs before execution.
- If the node throws errors, enabling 'Continue on Fail' can allow workflows to handle errors gracefully by returning error messages as output.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.