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 Server Port Template → List
AI-generatedOverview
This node interacts with the NetBox API to list console server port templates within the DCIM domain. It is useful for retrieving detailed information about console server port templates, which are configurations for console server ports in network infrastructure management. Typical use cases include network inventory management, auditing, and automation of network device configurations.
Use Case Examples
- List all console server port templates in the DCIM domain.
- Retrieve a limited number of console server port templates with specific filters such as device type ID or port type.
- Search console server port templates by name or other attributes.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is fixed to 'dcim' for console server port templates. |
| 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 server port templates based on various attributes such as ID, search query, device type ID, module type ID, name, port type, ordering, and date filters. |
Output
JSON
id- Unique identifier of the console server port template.name- Name of the console server port template.type- Type of the console server port template port.device_type_id- ID of the device type associated with the template.module_type_id- ID of the module type associated with the template.created- Creation timestamp of the template.last_updated- Last updated timestamp of the template.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Ensure the NetBox API credentials are correctly configured and have sufficient permissions to access the DCIM domain and console server port templates resource.
- If the node returns an error, check the filter values for correctness, especially date formats and IDs.
- Network connectivity issues to the NetBox API endpoint can cause failures; verify network access and API endpoint URL.
- If 'Return All' is set to false and the limit is too low, you might not see all expected results; adjust the limit or enable 'Return All'.
Links
- NetBox API Documentation - Console Server Port Templates - Official NetBox API documentation for the console server port templates resource.