upgradeSiteMultipleDevices
POST https://{{host}}/api/v1/sites/:site_id/devices/upgrade
Body Parameters
| Name | Type | Description |
|---|
version | string | pecific version / stable, default is to use the latest |
enable_p2p | boolean | whether to allow local AP-to-AP FW upgrade |
p2p_parallelism | int | number of parallel p2p download batches to create, default is 1 |
p2p_cluster_size | int | size to split the devices for p2p, default 10 |
strategy | string | big_bang(upgrade all at once), serial(one at a time), canary or rrm, default is big_bang |
canary_phases | array of ints | phases for canary deployment. Each phase represents percentage of devices that need to be upgraded in that phase. default is [1, 10, 50, 100] |
max_failures | array of ints | number of failures allowed within each phase. Only applicable for canary. Array length should be same as canaryphases. Will be used if provided, else maxfailure_percentage will be used |
max_failure_percentage | int | percentage of failures allowed across the entire upgrade(not applicable for big_bang), default is 5 |
rrm_node_order | string | fringetocenter or centertofringe (default fringetocenter). Used in rrm to determine whether to start upgrade from fringe or center AP’s |
rrm_slow_ramp | boolean | true will make rrm batch sizes slowly ramp up |
rrm_max_batch_percentage | int | max percentage of AP’s that need to be present in each rrm batch |
rrm_first_batch_percentage | int | percentage of AP’s that need to be present in the first rrm batch |
rrm_mesh_upgrade | string | sequential or parallel (default parallel). Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade |
start_time | long | firmware download start time in epoch seconds, default is now |
reboot_at | long | reboot start time in epoch seconds, default is start_time |
force | bool | true will force upgrade when requested version is same as running version |
Body Response
| Parameter | Type | Description |
|---|
| timestamp | float | timestamp |
| status | string | starting / inprogress / success / error / scheduled |
| status_id | int | the internal status id |
Request Body
{"version"=>"3.1.5", "enable_p2p"=>false, "p2p_parallelism"=>2, "p2p_cluster_size"=>10, "device_ids"=>["00000000-0000-0000-1000-5c5b35584a6f"], "models"=>["AP41"], "strategy"=>"canary", "canary_phases"=>[5, 25, 50, 100], "max_failures"=>[1, 1, 5], "max_failure_percentage"=>5, "start_time"=>1624399840, "reboot_at"=>1624399840, "force"=>true, "rrm_node_order"=>"fringe_to_center", "rrm_slow_ramp"=>true, "rrm_max_batch_percentage"=>10, "rrm_first_batch_percentage"=>2, "rrm_mesh_upgrade"=>"parallel"}
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
X-CSRFToken | string | | |
Content-Type | string | | |