Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
SitesDevicesWiredVirtual Chassis

createSiteVirtualChassis

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

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.

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

Request Body

application/json

Request Body

Virtual Chassis creation or configuration request

members?array<>

Virtual Chassis members and their expected roles and VC ports

preprovisioned?boolean

Whether to create the Virtual Chassis in pre-provisioned mode

Defaultfalse

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/vc" \  -H "Content-Type: application/json" \  -d '{    "members": [      {        "mac": "aff827549235",        "vc_ports": [          "xe-0/1/0"        ],        "vc_role": "master"      },      {        "mac": "8396cd006c8c",        "vc_ports": [          "xe-0/1/0",          "xe-0/1/1"        ],        "vc_role": "backup"      },      {        "mac": "8396cd00888c",        "vc_ports": [          "xe-0/1/0"        ],        "vc_role": "linecard"      }    ]  }'
Empty

getSiteDeviceVirtualChassis GET

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

deleteSiteVirtualChassis DELETE

When all the member switches of VC are removed and only member ID 0 is left, the cloud would detect this situation and automatically changes the single switch to non-VC role. For some unexpected cases that the VC is gone and disconnected, the API below could be used to change the state of VC’s switches to be standalone. After it is executed, all the switches will be shown as standalone switches under Inventory.