Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Power Port → Get
AI-generatedOverview
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
- Retrieve details of a power port by its ID to check its status and attributes.
- 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
- NetBox API Documentation - Power Ports - Official documentation for the Power Ports endpoint in the NetBox API.