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 → List
AI-generatedOverview
This node interacts with the NetBox API to list console port templates within the DCIM domain. It is useful for retrieving a collection of console port template records, which can be filtered and limited according to user-defined criteria. Typical use cases include inventory management, auditing, or integration with other systems that require up-to-date information about console port templates in a network infrastructure.
Use Case Examples
- Retrieve all console port templates without limit to get a complete list.
- Fetch a limited number of console port templates with specific filters such as name or type to narrow down the results.
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 console port templates based on various attributes such as ID, name, type, device type ID, module type ID, creation date, and last updated date. |
Output
JSON
id- Unique identifier of the console port template.name- Name of the console port template.type- Type of the console port template port.device_type_id- ID of the device type associated with the console port template.module_type_id- ID of the module type associated with the console port template.created- Creation timestamp of the console port template.last_updated- Timestamp of the last update to the console port template.
Dependencies
- NetBox API
- API key credential for authentication
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 being returned or errors. Verify that the domain is set to 'dcim' and the resource to 'console-port-templates' for this operation.
- Filters must be correctly formatted; invalid filter values may cause the API to reject the request.
- If 'Return All' is false and the limit is set too low, the user might not see all expected results. Adjust the limit or enable 'Return All' as needed.
Links
- NetBox API Documentation for Console Port Templates - Official documentation for the NetBox API endpoint related to console port templates.