NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Power Port resource within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about power ports in their data center infrastructure management system, such as monitoring power connections or auditing power port configurations.

Use Case Examples

  1. Retrieve details of a power port by its ID to check its status and attributes.
  2. Fetch power port information to integrate with other infrastructure management tools or dashboards.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
ID The unique identifier of the power port to retrieve.

Output

JSON

  • id - The unique identifier of the power port.
  • name - The name of the power port.
  • description - Description or notes about the power port.
  • status - Current status of the power port.
  • device - The device to which the power port is connected.
  • type - Type of the power port.
  • allocated - Allocation status of the power port.
  • circuit_id - Associated circuit ID if applicable.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the provided power port 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 resources.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authentication failures, resource not found errors, and permission denied errors. Resolving these typically involves verifying credentials, IDs, and user permissions.

Links

Discussion