NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port Template → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Power Port Template within the DCIM domain. It is useful for users who need to fetch detailed data about power port templates in their network infrastructure management system. For example, a network administrator can use this node to get the configuration details of a power port template by providing its ID.

Use Case Examples

  1. Retrieve a power port template by specifying its ID to get its configuration details.
  2. Use the node to fetch power port template data for inventory or auditing purposes.

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.
ID The unique identifier of the power port template to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the retrieved power port template.
  • name - The name of the power port template.
  • description - Description of the power port template.
  • type - Type of the power port template.
  • maximum_draw - Maximum power draw of the power port template.
  • allocated_draw - Allocated power draw of the power port template.
  • available_draw - Available power draw of the power port template.
  • tags - Tags associated with the power port template.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the provided power port template ID is correct and exists in the NetBox instance.
  • Verify that the API key credential has sufficient permissions to access the DCIM domain and power port templates.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authentication failures, resource not found (404), and permission denied (403). Resolving these involves verifying credentials, IDs, and user permissions.

Links

Discussion