NetBox icon

NetBox

Consume NetBox API

Actions243

Power Port → Update

AI-generated

Overview

This node updates a Power Port resource in the NetBox API under the DCIM domain. It is useful for network administrators or IT professionals who need to modify details of power ports in their infrastructure management system. For example, updating the name, device association, type, or power draw specifications of a power port.

Use Case Examples

  1. Updating the label and maximum power draw of a specific power port on a device.
  2. Changing the type of a power port to match new hardware specifications.
  3. Adding or modifying custom fields or tags for better categorization and management.

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 to update.
Update Fields A collection of fields to update on the power port, including name, device ID, module ID, label, type, maximum draw, allocated draw, connection status, description, tags, and custom fields.

Output

JSON

  • id - The unique identifier of the updated power port.
  • name - The name of the updated power port.
  • device - The device ID associated with the updated power port.
  • module - The module ID associated with the updated power port.
  • label - The label of the updated power port.
  • type - The type of the updated power port.
  • maximum_draw - The maximum power draw (in watts) of the updated power port.
  • allocated_draw - The allocated power draw (in watts) of the updated power port.
  • mark_connected - Indicates if the power port is marked as connected.
  • description - Description of the updated power port.
  • tags - Tags associated with the updated power port.
  • custom_fields - Custom fields data in JSON format.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the power port ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to update power port resources.
  • Check the format of custom fields JSON to avoid parsing errors.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

Discussion