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 → List
AI-generatedOverview
This node interacts with the NetBox API to list Virtual Chassis resources within the DCIM domain. It allows users to retrieve a collection of virtual chassis, which are groups of interconnected network devices managed as a single entity. This is useful for network administrators who want to automate the retrieval and management of virtual chassis data from NetBox.
Use Case Examples
- A network engineer wants to fetch all virtual chassis in their data center to monitor device groupings.
- An automation workflow needs to list virtual chassis with specific filters like name or master device ID to integrate with other network management tools.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management. |
| Return All | Determines whether to return all results or limit the number of results returned. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Optional filters to narrow down the list of virtual chassis, including Virtual Chassis ID, Name, Domain, and Master Device ID. |
Output
JSON
id- The unique identifier of the virtual chassis.name- The name of the virtual chassis.domain- The domain associated with the virtual chassis.master_id- The ID of the master device in the virtual chassis.otherProperties- Additional properties returned by the NetBox API for each virtual chassis.
Dependencies
- NetBox API
- An API key credential for authenticating with the NetBox API
Troubleshooting
- Common issues include authentication failures due to invalid API credentials, which can be resolved by verifying the API key.
- Incorrect filter parameters may result in no data returned; ensure filter values are valid and exist in NetBox.
- Network connectivity issues to the NetBox server can cause request failures; check network settings and server availability.
Links
- NetBox API Documentation for Virtual Chassis - Official documentation for the Virtual Chassis endpoint in the NetBox API, detailing available fields and usage.