NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple Power Port records within the DCIM domain. It is useful for users who need to fetch a list of power ports with optional filtering, pagination, and sorting capabilities. For example, a network administrator can use this node to get all power ports associated with specific devices or modules, or to search power ports by name or label.

Use Case Examples

  1. Retrieve all power ports for a specific device ID.
  2. Get a limited number of power ports with a specific type or label.
  3. Search power ports by name or other attributes.

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 returned.
Limit Maximum number of results to return when 'Return All' is false.
Filters Collection of optional filters to narrow down the list of power ports, such as device ID, module ID, name, label, type, mark connected status, search query, ID, ordering, creation date, and last updated date.

Output

JSON

  • id - Unique identifier of the power port.
  • name - Name of the power port.
  • label - Label of the power port.
  • type - Type of the power port.
  • device_id - Identifier of the device associated with the power port.
  • module_id - Identifier of the module associated with the power port.
  • mark_connected - Boolean indicating if the power port is marked as connected.
  • created - Timestamp when the power port was created.
  • last_updated - Timestamp when the power port was last updated.

Dependencies

  • NetBox API with an 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 can lead to no data being returned. Verify that the domain is set to 'dcim' and the resource to 'power-ports'.
  • 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

Discussion