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 → List
AI-generatedOverview
This node interacts with the NetBox API to list device bays within the DCIM domain. It is useful for retrieving information about device bays in a network infrastructure managed by NetBox, allowing users to filter results based on specific criteria such as device bay ID, device ID, name, or installed device ID. This can help network administrators or IT professionals to efficiently query and manage device bay data.
Use Case Examples
- List all device bays in the DCIM domain.
- Retrieve device bays filtered by a specific device ID or name.
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 returned. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Filters to narrow down the list of device bays based on criteria such as device bay ID, device ID, name, or installed device ID. |
Output
JSON
id- The unique identifier of the device bay.device_id- The identifier of the device associated with the device bay.name- The name of the device bay.installed_device_id- The identifier of the installed device in the device bay.
Dependencies
- NetBox API
- An API key credential for authentication
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; incorrect filter values may result in empty responses.
- If 'Return All' is set to false and the limit is too low, not all desired results may be returned. Adjust the limit or enable 'Return All' to retrieve more data.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.