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 Device Context → List
AI-generatedOverview
This node interacts with the NetBox API to list virtual device contexts within the DCIM domain. It is useful for retrieving information about virtual device contexts, such as their IDs, associated device IDs, names, statuses, and tenant IDs. This can help in network management and inventory tasks where virtual device contexts need to be queried and analyzed.
Use Case Examples
- List all virtual device contexts in the DCIM domain.
- Filter virtual device contexts by status or tenant ID.
- Limit the number of virtual device contexts returned for performance optimization.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, 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. |
| Limit | Maximum number of virtual device contexts to return when 'Return All' is false. |
| Filters | Optional filters to narrow down the list of virtual device contexts based on criteria such as ID, device ID, name, status, and tenant ID. |
Output
JSON
id- The unique identifier of the virtual device context.device_id- The identifier of the device associated with the virtual device context.name- The name of the virtual device context.status- The status of the virtual device context (e.g., active, planned, offline).tenant_id- The identifier of the tenant associated with the virtual device context.
Dependencies
- NetBox API
- An API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has sufficient permissions to access the DCIM domain and virtual device contexts.
- If the node returns an error, check the filter values for correctness and compatibility with the NetBox API.
- If 'Return All' is set to false and the limit is too low, you might not get all expected results; adjust the limit accordingly.
Links
- NetBox API Documentation for Virtual Device Contexts - Official documentation for the virtual device contexts endpoint in the NetBox API.