Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesDevicesWiredVirtual Chassis

getSiteDeviceVirtualChassis

GET
/api/v1/sites/{site_id}/devices/{device_id}/vc

Get VC Status

The API returns a combined view of the VC status which includes topology and stats_

Authorization

Authorization<token>

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

site_id*string
Formatuuid
device_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/vc"
{  "config_type": "nonprovisioned",  "id": "00000000-0000-0000-1000-52d9107af289",  "mac": "52d9107af289",  "members": [    {      "boot_partition": "junos",      "cpld_version": "6",      "cpu_stat": {        "idle": 69,        "interrupt": 1,        "load_avg": [          0.8,          1.09,          1.07        ],        "system": 11,        "user": 19      },      "fans": [        {          "airflow": "out",          "name": "Fan Tray 0 Fan 0",          "rpm": 0,          "status": "ok"        },        {          "airflow": "out",          "name": "Fan Tray 1 Fan 0",          "rpm": 0,          "status": "ok"        }      ],      "fpc_idx": 0,      "mac": "52d9107af289",      "memory_stat": {        "usage": 42      },      "model": "EX2300-48P",      "pics": [        {          "index": 0,          "model_number": "EX2300-48P",          "port_groups": [            {              "count": 48,              "type": "GE"            }          ]        },        {          "index": 1,          "model_number": "EX2300-48P",          "port_groups": [            {              "count": 4,              "type": "SFP/SFP+"            }          ]        }      ],      "poe": {        "max_power": 750,        "power_draw": 40.4,        "status": "AT_MODE"      },      "poe_version": "2.1.1.19.3 (type1)",      "psus": [        {          "name": "Power Supply 0",          "status": "ok"        }      ],      "recovery_version": "21.4R3-S4.18",      "serial": "JW0000000000",      "temperatures": [        {          "celsius": 33,          "name": "CPU Sensor",          "status": "ok"        },        {          "celsius": 29,          "name": "PSU Sensor",          "status": "ok"        }      ],      "type": "fpc",      "uboot_version": "U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2",      "uptime": 27636720,      "vc_links": [        {          "neighbor_module_idx": 1,          "neighbor_port_id": "vcp-1/1/0",          "port_id": "vcp-0/1/0"        }      ],      "vc_mode": "HiGiG",      "vc_role": "master",      "vc_state": "present",      "version": "21.4R3-S4.18"    },    {      "boot_partition": "junos",      "cpld_version": "6",      "cpu_stat": {        "idle": 76,        "interrupt": 0,        "load_avg": [          0.96,          0.87,          0.76        ],        "system": 6,        "user": 17      },      "fans": [        {          "airflow": "out",          "name": "Fan Tray 0 Fan 0",          "rpm": 0,          "status": "ok"        },        {          "airflow": "out",          "name": "Fan Tray 1 Fan 0",          "rpm": 0,          "status": "ok"        }      ],      "fpc_idx": 1,      "mac": "d0dd4991652d",      "memory_stat": {        "usage": 18      },      "model": "EX2300-48P",      "pics": [        {          "index": 0,          "model_number": "EX2300-48P",          "port_groups": [            {              "count": 48,              "type": "GE"            }          ]        },        {          "index": 1,          "model_number": "EX2300-48P",          "port_groups": [            {              "count": 4,              "type": "SFP/SFP+"            }          ]        }      ],      "poe": {        "max_power": 750,        "power_draw": 21.2,        "status": "AT_MODE"      },      "poe_version": "2.1.1.19.3 (type1)",      "psus": [        {          "name": "Power Supply 0",          "status": "ok"        }      ],      "recovery_version": "21.4R3-S4.18",      "serial": "JW3619300922",      "temperatures": [        {          "celsius": 32,          "name": "CPU Sensor",          "status": "ok"        },        {          "celsius": 29,          "name": "PSU Sensor",          "status": "ok"        }      ],      "type": "fpc",      "uboot_version": "U-Boot 2016.01-rc1 (Nov 11 2016 - 14:26:00 -0800)  1.3.2",      "uptime": 27636720,      "vc_links": [        {          "neighbor_module_idx": 0,          "neighbor_port_id": "vcp-0/1/0",          "port_id": "vcp-1/1/0"        }      ],      "vc_mode": "HiGiG",      "vc_role": "backup",      "vc_state": "present",      "version": "21.4R3-S4.18"    }  ],  "model": "EX2300-48P",  "num_routing_engines": 1,  "org_id": "1e9a61a9-bc42-42ca-bf67-1ad87443d9b8",  "serial": "JW3619300157",  "site_id": "ab0aca7a-d45c-469b-b3bb-4fe240642d0b",  "status": "connected",  "type": "switch",  "vc_mac": "52d9107af289"}

convertSiteVirtualChassisToVirtualMac POST

Converts an FPC0-based VC to a Virtualmac VC, removing the limitation where the device ID must change whenever FPC0 is renumbered or removed. HTTP400 Error possible reasons: - The device is not an OC device - Virtualmac VC is disabled in the Org Knob settings - The VC is already a Virtualmac VC - The VC is currently disconnected - The device is standalone - A new FPC0 exists with its own device config, causing ambiguity.

createSiteVirtualChassis POST

For models (e.g. EX3400 and up) having dedicated VC ports, it is easier to form a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new VC and update the inventory. In case that the user would like to choose the dedicated switch as a VC master or for EX2300-C-12P and EX2300-C-12T which doesn't have dedicated VC ports, below are procedures to automate the VC creation: 1. Power on the switch that is chosen as the VC master first, and then powering on the other member switches. 2. Claim or adopt all these switches under the same organization's Inventory 3. Assign these switches into the same Site 4. Wait for all the switches to be connected to Mist 5. Invoke vc command on the switch chosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically. 6. Connect the cables to the VC ports for these switches 7. Wait for the VC to be formed. The Org's inventory will be updated for the new VC.