NetBox icon

NetBox

Consume NetBox API

Actions243

Virtual Chassis → Update

AI-generated

Overview

This node updates an existing Virtual Chassis record in the NetBox API under the DCIM domain. It is useful for managing and modifying virtual chassis configurations in a network infrastructure, such as changing the name, domain, master device, description, comments, tags, or custom fields of a virtual chassis.

Use Case Examples

  1. Updating the name and description of a virtual chassis to reflect new organizational changes.
  2. Changing the master device ID of a virtual chassis to designate a new master device.
  3. Adding tags or comments to a virtual chassis for better categorization and documentation.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is 'dcim' for data center infrastructure management.
Virtual Chassis ID The unique identifier of the virtual chassis to update.
Update Fields A collection of fields to update on the virtual chassis, including name, domain, master device ID, description, comments, tags, and custom fields.

Output

JSON

  • id - ID of the updated virtual chassis record
  • name - Name of the updated virtual chassis
  • domain - Domain of the updated virtual chassis
  • master - ID of the master device in the updated virtual chassis
  • description - Description of the updated virtual chassis
  • comments - Comments about the updated virtual chassis
  • tags - Tags associated with the updated virtual chassis
  • custom_fields - Custom fields of the updated virtual chassis

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Virtual Chassis ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential is valid and has sufficient permissions to update virtual chassis records.
  • Check that the update fields are correctly formatted, especially custom fields which should be valid JSON.
  • 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