NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port Template → Get Many

AI-generated

Overview

This node interacts with the NetBox API to retrieve multiple Power Port Template records from the DCIM domain. It is useful for users who want to fetch a list of power port templates with optional filtering and pagination controls. For example, a network administrator can use this node to get all power port templates or limit the results to a specific number, applying filters such as device type ID or name to narrow down the search.

Use Case Examples

  1. Retrieve all power port templates without limit.
  2. Fetch up to 50 power port templates filtered by device type ID.
  3. Get power port templates matching a specific name or type.

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 Optional filters to narrow down the list of power port templates, such as device type ID, module type ID, name, type, search query, ID, and ordering.

Output

JSON

  • id - Unique identifier of the power port template.
  • name - Name of the power port template.
  • type - Type of the power port template.
  • device_type_id - Identifier for the device type associated with the power port template.
  • module_type_id - Identifier for the module type associated with the power port template.
  • additional_properties - Other properties returned by the NetBox API for each power port template.

Dependencies

  • NetBox API with appropriate API key credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have permissions to access the DCIM domain and power port templates resource.
  • If the node returns an error, check the filter values for correctness and compatibility with the NetBox API.
  • Network connectivity issues to the NetBox server can cause failures; verify the server URL and network access.
  • If 'Return All' is false and no results are returned, try increasing the 'Limit' value or enabling 'Return All'.

Links

Discussion