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 → List
AI-generatedOverview
This node interacts with the NetBox API to list module bays within the DCIM domain. It is useful for retrieving information about module bays in network devices, such as their IDs, associated device IDs, names, and positions. This can help network administrators manage and audit hardware components in their infrastructure.
Use Case Examples
- List all module bays in the DCIM domain to get an overview of available module bays.
- Filter module bays by device ID to see all module bays associated with a specific device.
- Limit the number of module bays returned to a specific count for pagination or performance reasons.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, 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 module bay results to return when 'Return All' is false. |
| Filters | Filters to narrow down the list of module bays based on specific criteria such as module bay ID, device ID, name, or position. |
Output
JSON
id- The unique identifier of the module bay.device_id- The identifier of the device to which the module bay belongs.name- The name of the module bay.position- The position of the module bay within the device.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Ensure the NetBox API credentials are correctly configured and have the necessary permissions to access the DCIM domain and module bays resource.
- If the node returns an error, check the filter values for correctness and ensure they match existing module bay attributes.
- If no results are returned, verify that the filters are not too restrictive or that the module bays exist in the NetBox instance.
Links
- NetBox API Documentation - Module Bays - Official documentation for the Module Bays resource in the DCIM domain of the NetBox API.