getOrgInventory
Get Org Inventory
VC (Virtual-Chassis) Management
Starting with the April release, Virtual Chassis devices in Mist will now use a cloud-assigned virtual MAC address as the device ID, instead of the physical MAC address of the FPC0 member.
Retrieving the device ID or Site ID of a Virtual Chassis:
-
Use this API call with the query parameters
vc=trueandmacset to the MAC address of the VC member. -
In the response, check the
vc_macandmacfields:-
If
vc_macis empty or not present, the device is not part of a Virtual Chassis. Thedevice_idandsite_idwill be available in the device information. -
If
vc_macdiffers from themacfield, the device is part of a Virtual Chassis but is not the device used to generate the Virtual Chassis ID. Use thevc_macvalue with the Get Org Inventory API call to retrieve thedevice_idandsite_id. -
If
vc_macmatches themacfield, the device is the device used to generate the Virtual Chassis ID and hedevice_idandsite_idwill be available in the device information.
This is the case if the device is the Virtual Chassis "virtual device" (MAC starting with020003) or if the device is the Virtual Chassis FPC0 and the Virtual Chassis is still using the FPC0 MAC address to generate the device ID.
-
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
Filter results by device serial number. Accepts multiple comma-separated values.
Filter results by device model. Accepts multiple comma-separated values.
Filter results by type. enum: ap, gateway, switch. Accepts multiple comma-separated values.
Filter results by MAC address. Accepts multiple comma-separated values.
Filter results by one site identifier. Use a single value; comma-separated values are not supported
uuidVirtual Chassis MAC address. Accepts multiple comma-separated values.
To display Virtual Chassis members
falseTo display Unassigned devices
trueFilter on inventory last modified time, in epoch
Filter results to devices that were last disconnected before this time, in epoch seconds
Maximum number of results to return per page
0 <= value100Select the page number to return when using page-based pagination; starts at 1
1 <= value1Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/inventory?type=switch%2Cap"[ { "connected": true, "created_time": 1542328276, "deviceprofile_id": "6f4bf402-45f9-2a56-6c8b-7f83d3bc98e9", "id": "00000000-0000-0000-0000-5c5b35000018", "last_disconnected": 1542828000, "mac": "5c5b35000018", "model": "AP41", "modified_time": 1542829778, "name": "hallway", "serial": "FXLH2015150025", "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b", "type": "ap" }]