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
Module Bay Template → List
AI-generatedOverview
This node interacts with the NetBox API to list Module Bay Templates within the DCIM domain. It is useful for retrieving information about module bay templates, which are predefined configurations for module bays in devices. Users can filter the results by various criteria such as module bay template ID, device type ID, module type ID, and name. It supports returning all results or limiting the number of results returned.
Use Case Examples
- Retrieve all module bay templates for a specific device type to automate inventory management.
- Filter module bay templates by name to find a specific template configuration.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is fixed to 'dcim' for Module Bay 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 module bay templates. Includes filters for module bay template ID, device type ID, module type ID, and name. |
Output
JSON
id- The unique identifier of the module bay template.device_type_id- The identifier of the device type associated with the module bay template.module_type_id- The identifier of the module type associated with the module bay template.name- The name of the module bay template.otherProperties- Additional properties returned by the NetBox API for each module bay template.
Dependencies
- NetBox API
- An API key credential for authenticating with the NetBox API
Troubleshooting
- Common issues include authentication errors due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Filtering parameters must be valid and correspond to existing entities in NetBox; otherwise, the API may return empty results.
- If 'Return All' is set to false and the limit is too low, not all desired results will be returned. Adjust the limit accordingly.
Links
- NetBox API Documentation for Module Bay Templates - Official documentation for the Module Bay Templates endpoint in the NetBox API.