NetBox icon

NetBox

Consume NetBox API

Actions243

Virtual Chassis → Create

AI-generated

Overview

This node interacts with the NetBox API to create a new Virtual Chassis within the DCIM domain. It is useful for network administrators and engineers who want to automate the management of virtual chassis configurations in their network infrastructure. For example, it can be used to programmatically add a new virtual chassis with specific attributes such as name, master device ID, description, comments, tags, and custom fields.

Use Case Examples

  1. Creating a new virtual chassis named 'Chassis-01' with a specified master device ID and description to organize network devices logically.
  2. Adding comments and tags to a virtual chassis for better documentation and categorization within the NetBox system.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, fixed to 'dcim' for this resource.
Virtual Chassis Name The name assigned to the virtual chassis being created.
Additional Fields Optional additional attributes for the virtual chassis such as domain name, master device ID, description, comments, tags, and custom fields.

Output

JSON

  • id - Unique identifier of the created virtual chassis.
  • name - Name of the created virtual chassis.
  • master - ID of the master device in the created virtual chassis.
  • description - Description of the created virtual chassis.
  • comments - Comments associated with the created virtual chassis.
  • tags - Tags linked to the created virtual chassis.
  • custom_fields - Custom fields set on the created virtual chassis.

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to create virtual chassis in the NetBox instance.
  • Verify that the 'Virtual Chassis Name' is provided and is unique to avoid conflicts.
  • Check that the master device ID, if provided, corresponds to an existing device in NetBox.
  • Common error messages may include authentication failures, validation errors for missing or incorrect fields, and network connectivity issues. Resolving these involves verifying credentials, input data correctness, and network access to the NetBox API endpoint.

Links

Discussion