Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node integrates with the NetBox API, specifically allowing users to list Virtual Chassis resources within the DCIM domain. It is designed to fetch and return information about virtual chassis configurations managed in a NetBox instance.
Typical use cases include:
- Retrieving all or filtered lists of virtual chassis for network inventory management.
- Automating audits or synchronization tasks by extracting virtual chassis data.
- Integrating NetBox virtual chassis data into workflows for monitoring or reporting.
For example, a user might want to list all virtual chassis with a specific master device ID or filter by name to find particular chassis setups.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. For this operation, it must be "DCIM". |
| Return All | Whether to return all results or limit the number of returned items. |
| Limit | Maximum number of results to return if "Return All" is false. |
| Filters | Collection of filters to narrow down the list of virtual chassis: |
| Virtual Chassis ID | Filter by the unique ID of the virtual chassis. |
| Name | Filter by the name of the virtual chassis. |
| Domain | Filter by domain string (likely a custom field or categorization). |
| Master Device ID | Filter by the ID of the master device in the virtual chassis. |
Output
The node outputs JSON data representing the list of virtual chassis retrieved from the NetBox API. Each item in the output array corresponds to a virtual chassis object with its properties as defined by the NetBox API schema.
If the node supports binary data output, it is not relevant for this operation since listing virtual chassis returns structured JSON data only.
Dependencies
- Requires an active connection to a NetBox instance via an API key credential configured in n8n.
- The node depends on the NetBox API being accessible and properly authenticated.
- No additional external services are required beyond the NetBox API.
Troubleshooting
Common Issues:
- Authentication failures due to invalid or missing API credentials.
- Network connectivity issues preventing access to the NetBox API.
- Incorrect filter values leading to empty result sets.
- Exceeding API rate limits imposed by the NetBox server.
Error Messages:
- Errors during execution will be logged and, if "Continue on Fail" is enabled, returned as part of the node output.
- Typical error messages may include authentication errors, HTTP request failures, or invalid parameter errors.
Resolutions:
- Verify that the API key credential is correctly set up and has sufficient permissions.
- Check network connectivity and firewall settings.
- Review filter parameters for correctness.
- Adjust usage to comply with any API rate limits.