NetBox icon

NetBox

Consume NetBox API

Actions243

Rack Role → Update

AI-generated

Overview

This node updates an existing Rack Role record in the NetBox API under the DCIM domain. It is useful for modifying attributes of a Rack Role such as its name, slug, color, description, tags, and custom fields. For example, you can update the color or description of a Rack Role to better organize and document your data center racks.

Use Case Examples

  1. Updating the color and description of a Rack Role to reflect a new organizational scheme.
  2. Modifying the tags associated with a Rack Role to improve searchability and categorization.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management.
ID The unique identifier of the Rack Role record to update.
Update Fields Collection of fields to update on the Rack Role record, including name, slug, color (hex), description, tags (comma-separated), and custom fields (JSON format).

Output

JSON

  • id - The unique identifier of the updated Rack Role.
  • name - The name of the updated Rack Role.
  • slug - The slug of the updated Rack Role.
  • color - The color (hex) of the updated Rack Role.
  • description - The description of the updated Rack Role.
  • tags - Tags associated with the updated Rack Role.
  • custom_fields - Custom fields of the updated Rack Role.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Rack Role ID provided exists in the NetBox instance; otherwise, the update will fail with a not found error.
  • Validate the JSON format for custom fields to avoid parsing errors.
  • Check that the API key credential is correctly configured and has permissions to update Rack Role resources.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message as JSON.

Links

Discussion