NetBox icon

NetBox

Consume NetBox API

Actions243

Power Feed → List

AI-generated

Overview

This node interacts with the NetBox API to list power feed resources within the DCIM domain. It allows users to retrieve a list of power feeds with optional filtering, pagination, and sorting capabilities. This is useful for scenarios where users need to manage or monitor power feeds in their data center infrastructure, such as fetching all power feeds, filtering by status or type, or limiting the number of results returned.

Use Case Examples

  1. Retrieve all power feeds in the DCIM domain.
  2. Filter power feeds by status (e.g., active or planned).
  3. Limit the number of power feeds returned to a specific count.
  4. Search power feeds by name or associated rack ID.

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 results to return when 'Return All' is false.
Filters Collection of optional filters to refine the list of power feeds, including search query, power panel ID, rack ID, name, status, type, supply, phase, voltage, amperage, max utilization, ID, ordering, and date filters.

Output

JSON

  • id - Unique identifier of the power feed.
  • name - Name of the power feed.
  • status - Current status of the power feed (e.g., active, planned).
  • type - Type of the power feed (primary or redundant).
  • supply - Power supply type (AC or DC).
  • phase - Phase of the power feed (single-phase or three-phase).
  • voltage - Voltage value of the power feed.
  • amperage - Amperage value of the power feed.
  • max_utilization - Maximum utilization percentage of the power feed.
  • power_panel_id - Identifier of the associated power panel.
  • rack_id - Identifier of the associated rack.
  • created - Creation timestamp of the power feed.
  • last_updated - Last updated timestamp of the power feed.

Dependencies

  • NetBox API
  • API key credential for authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Incorrect domain or resource selection may result in no data or errors. Verify the domain is set to 'dcim' and resource to 'power-feeds' for this operation.
  • Filters with invalid values or types may cause the API to reject the request. Validate filter inputs before execution.
  • If the node returns an error, check the error message for details and ensure the NetBox instance is reachable and the API endpoint is correct.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.

Discussion