NetBox icon

NetBox

Consume NetBox API

Actions243

Power Outlet Template → List

AI-generated

Overview

This node interacts with the NetBox API to list power outlet templates within the DCIM domain. It allows users to retrieve a list of power outlet templates with optional filtering, limiting, and ordering of results. This is useful for network administrators or data center managers who want to automate the retrieval of power outlet template data from NetBox for inventory, auditing, or integration purposes.

Use Case Examples

  1. Retrieve all power outlet templates without limit to get a complete inventory.
  2. List power outlet templates filtered by type or device type ID to find specific templates.
  3. Limit the number of results returned to manage data volume in workflows.

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 narrow down the list of power outlet templates, including search query, device type ID, module type ID, name, type, feed leg, ID, and ordering.

Output

JSON

  • id - Unique identifier of the power outlet template.
  • name - Name of the power outlet template.
  • type - Type of the power outlet template.
  • feed_leg - Feed leg of the power outlet template.
  • device_type_id - Associated device type ID.
  • module_type_id - Associated module type ID.
  • other_properties - Additional properties returned by the NetBox API for each power outlet template.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the NetBox API credentials are correctly configured and have sufficient permissions to access the DCIM domain and power outlet 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 network access and API endpoint availability.

Links

Discussion