Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
Installer

createInstallerVirtualChassis

POST
/api/v1/installer/orgs/{org_id}/devices/{fpc0_mac}/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. Invoke vc command on the switch chosen to be the VC master. For EX2300-C-12P, VC ports will be created automatically.
  5. Connect the cables to the VC ports for these switches
  6. 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

org_id*string
Formatuuid
fpc0_mac*string

FPC0 MAC address

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/installer/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/aff827549235/vc" \  -H "Content-Type: application/json" \  -d '{    "members": [      {        "mac": "aff827549235",        "vc_ports": [          "xe-0/1/0",          "xe-0/1/1"        ],        "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",          "xe-0/1/1"        ],        "vc_role": "linecard"      }    ]  }'
{  "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"}

getInstallerDeviceVirtualChassis GET

Return Virtual Chassis status for an installer-managed switch, including topology and member statistics. The response is a combined view of the Virtual Chassis state.

updateInstallerVirtualChassisMember PUT

The VC creation and adding member switch API will update the device’ s virtual chassis config which is applied after VC is formed to create JUNOS pre-provisioned virtual chassis configuration. ## Change to use preprovisioned VC To switch the VC to use preprovisioned VC, enable preprovisioned in virtual_chassis config. Both vc_role master and backup will be matched to routing-engine role in Junos preprovisioned VC config. In this config, fpc0 has to be the same as the mac of device_id. Use renumber if you want to replace fpc0 which involves device_id change. Notice: to configure preprovisioned VC, every member of the VC must be in the inventory. ## Add new members For models (e.g. EX4300 and up) having dedicated VC ports, it is easier to add new member switches into a VC by just connecting cables with the dedicated VC ports. Cloud will detect the new members and update the inventory. For EX2300 VC, adding new members requires to follow the procedures below: 1. Powering on the new member switches and ensuring cables are not connected to any VC ports. 2. Claim or adopt all new member switches under the VC’s organization Inventory 3. Assign all new member switches to the same Site as the VC 4. Invoke vc command to add switches to the VC. 5. Connect the cables to the VC ports for these switches 6. After a while, the Org’s Inventory shows this new switches has been added into the VC. ## Removing member switch To remove a member switch from the VC, following the procedures below: 1. Ensuring the VC is connected to the cloud first 2. Unplug the cable from the VC port of the switch 3. Waiting for the VC state (vc_state) of this switch is changed to not-present 4. Invoke update_vc with remove to remove this switch from the VC 5. The Org’s Inventory shows the switch is removed. Please notice that member ID 0 (fpc0) cannot be removed. When a VC has two switches left, unplugging the cable may result in the situation that fpc0 becomes a line card (LC). When this situation is happening, please re-plug in the cable, wait for both switches becoming present (show virtual-chassis) and then removing the cable again. ## Renumber a member switch When a member switch doesn't' work properly and needed to be replaced, the renumber API could be used. The following two types of renumber are supported: 1. Replace a non-fpc0 member switch 2. Replace fpc0. When fpc0 is replaced, PAPI device config and JUNOS config will be both updated. For renumber to work, the following procedures are needed: 1. Ensuring the VC is connected to the cloud and the state of the member switch to be replaced must be non present. 2. Adding the new member switch to the VC 3. Waiting for the VC state (vc_state) of this VC to be updated to API server 4. Invoke vc with renumber to replace the new member switch from fpc X to ## Perprovision VC members By specifying "preprovision" op, you can convert the current VC to pre-provisioned mode, update VC members as well as specify vc_ports when adding new members for device models without dedicated vc ports. Use renumber for fpc0 replacement which involves device_id change. Note: 1. vc_ports is used for adding new members and not needed if * the device model has dedicated vc ports, or * no new member is added 2. New VC members to be added should exist in the same Site as the VC Update Device’s VC config can achieve similar purpose by directly modifying current virtual_chassis config. However, it cannot fulfill requests to enabling vc_ports on new members that are yet to belong to current VC.