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
Power Outlet → List
AI-generatedOverview
This node interacts with the NetBox API to list power outlets within the DCIM domain. It allows users to retrieve a list of power outlets with optional filtering, limiting, and ordering of results. This is useful for network and data center administrators who want to programmatically access and manage power outlet information in their infrastructure.
Use Case Examples
- Retrieve all power outlets in a specific data center.
- Filter power outlets by device ID or type to find specific outlets.
- Limit the number of power outlets returned to avoid overwhelming the system.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, 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 power outlet results to return when 'Return All' is false. |
| Filters | Collection of filters to narrow down the list of power outlets, such as by device ID, module ID, name, label, type, feed leg, power port ID, connection status, ID, ordering, and date filters. |
Output
JSON
id- Unique identifier of the power outlet.name- Name of the power outlet.label- Label assigned to the power outlet.type- Type of the power outlet (e.g., IEC 60320 C13, NEMA 5-15R).device_id- Identifier of the device to which the power outlet belongs.module_id- Identifier of the module to which the power outlet belongs.feed_leg- Feed leg of the power outlet (A, B, or C).power_port_id- Identifier of the associated power port.mark_connected- Boolean indicating if the outlet is marked as connected.created- Timestamp when the power outlet was created.last_updated- Timestamp when the power outlet was last updated.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key is correctly configured.
- Incorrect domain or resource selection can lead to no data being returned. Verify the domain is set to 'dcim' and resource to 'power-outlets' for this operation.
- Filters must be correctly formatted; invalid filter values may cause errors or empty results.
- If 'Return All' is false and the limit is set too low, not all desired results will be returned. Adjust the limit accordingly.
Links
- NetBox API Documentation - Power Outlets - Official documentation for the NetBox API endpoint related to power outlets.