NetBox icon

NetBox

Consume NetBox API

Actions243

Rack → Update

AI-generated

Overview

This node updates a Rack resource in the NetBox API under the DCIM domain. It allows users to modify various attributes of a rack such as site ID, name, status, dimensions, location, tenant, role, rack type, serial number, asset tag, description, tags, and custom fields. This is useful for managing and maintaining accurate rack information in a data center or network infrastructure environment.

Use Case Examples

  1. Updating the name and status of a specific rack by its ID.
  2. Changing the location and tenant of a rack to reflect physical or organizational changes.
  3. Adding custom fields or tags to a rack for better categorization and tracking.

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 to update.
Update Fields Collection of fields to update on the rack, including site ID, name, status, width, height, location, tenant, role, rack type, serial, asset tag, description, tags, and custom fields.

Output

JSON

  • id - ID of the updated rack record.
  • name - Name of the updated rack.
  • status - Status of the updated rack.
  • site - Site ID associated with the rack.
  • location - Location ID of the rack.
  • tenant - Tenant ID associated with the rack.
  • role - Role ID assigned to the rack.
  • rack_type - Rack type ID.
  • serial - Serial number of the rack.
  • asset_tag - Asset tag of the rack.
  • description - Description of the rack.
  • tags - Tags associated with the rack.
  • custom_fields - Custom fields data in JSON format.

Dependencies

  • NetBox API
  • API key credential for authentication

Troubleshooting

  • Ensure the rack ID provided exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to update rack resources.
  • Check that the update fields are correctly formatted, especially JSON for custom fields, to prevent request failures.
  • If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and data structures.

Discussion