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
Device Bay Template → List
AI-generatedOverview
This node interacts with the NetBox API to list Device Bay Templates within the DCIM domain. It is useful for retrieving information about device bay templates, which are predefined configurations for device bays in network infrastructure management. Users can filter the results by device bay template ID, device type ID, or name, and control the number of results returned or fetch all available results.
Use Case Examples
- A network administrator wants to retrieve all device bay templates to audit or update configurations.
- An automation workflow needs to fetch device bay templates filtered by a specific device type ID to ensure consistency in device deployments.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for device-related data. |
| 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 | Filters to narrow down the list of device bay templates by ID, device type ID, or name. |
Output
JSON
id- The unique identifier of the device bay template.device_type_id- The identifier of the device type associated with the device bay template.name- The name of the device bay template.otherProperties- Additional properties returned by the NetBox API for each device bay template.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Ensure the NetBox API credentials are correctly configured and have permissions to access the DCIM domain and device bay templates resource.
- If the node returns an error, check the filter values for correctness and ensure the NetBox instance is reachable.
- If 'Return All' is set to false and the limit is too low, you might not get all expected results; adjust the limit accordingly.
Links
- NetBox API Documentation - Device Bay Templates - Official NetBox API documentation for the Device Bay Templates resource.