Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Virtual Chassis → Create
AI-generatedOverview
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
- Creating a new virtual chassis named 'Chassis-01' with a specified master device ID and description to organize network devices logically.
- 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
- NetBox API Documentation for Virtual Chassis - Official documentation for the Virtual Chassis resource in the NetBox API, detailing available fields and usage.