NetBox icon

NetBox

Consume NetBox API

Actions243

Power Outlet → Update

AI-generated

Overview

This node updates a power outlet record in the NetBox API under the DCIM domain. It is useful for managing and modifying details of power outlets in a data center or network infrastructure environment. For example, you can update the device ID, name, module ID, label, outlet type, feed leg, associated power port, connection status, description, tags, and custom fields of a specific power outlet by providing its ID and the fields to update.

Use Case Examples

  1. Updating the name and label of a power outlet to reflect new physical labeling.
  2. Changing the associated device or module ID for a power outlet after hardware changes.
  3. Marking a power outlet as connected or disconnected in the system.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management.
Power Outlet ID The unique identifier of the power outlet to update.
Update Fields A collection of fields to update on the power outlet, including device ID, name, module ID, label, type, feed leg, power port ID, connection status, description, tags, and custom fields.

Output

JSON

  • id - ID of the updated power outlet record
  • device - Device ID associated with the power outlet
  • name - Name of the power outlet
  • module - Module ID installed in the power outlet
  • label - Physical label on the power outlet
  • type - Type of the power outlet
  • feed_leg - Feed leg for three-phase power
  • power_port - Associated power port ID
  • mark_connected - Connection status of the power outlet
  • description - Description of the power outlet
  • tags - Tags associated with the power outlet
  • custom_fields - Custom fields of the power outlet

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include providing an invalid power outlet ID, which results in a not found error from the API.
  • Incorrect or missing authentication credentials can cause authorization errors.
  • Invalid field values or types in the update fields can cause validation errors from the API.

Links

Discussion