NetBox icon

NetBox

Consume NetBox API

Actions243

Power Panel → Update

AI-generated

Overview

This node updates an existing Power Panel record in the NetBox API under the DCIM domain. It is useful for scenarios where you need to modify details of a power panel such as its site, name, location, description, tags, or custom fields. For example, updating the description or location of a power panel after maintenance or relocation.

Use Case Examples

  1. Updating the name and description of a power panel to reflect recent changes.
  2. Adding tags to a power panel for better categorization and searchability.
  3. Modifying custom fields of a power panel to include additional metadata.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management.
Power Panel ID The unique identifier of the power panel to update.
Update Fields Collection of fields to update on the power panel, including site ID, name, location ID, description, tags, and custom fields.

Output

JSON

  • id - ID of the updated power panel record.
  • name - Name of the updated power panel.
  • site - Site ID associated with the power panel.
  • location - Location ID of the power panel.
  • description - Description of the power panel.
  • tags - Tags associated with the power panel.
  • custom_fields - Custom fields of the power panel as a JSON object.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Power Panel 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 panel records.
  • Check the format of custom fields JSON to avoid parsing errors.
  • If the node throws an error, enabling 'Continue on Fail' will output the error message as JSON instead of stopping execution.

Links

Discussion