Skip to content

Commit

Permalink
v0.4.38
Browse files Browse the repository at this point in the history
  • Loading branch information
tmunzer committed Jan 27, 2025
1 parent be1819f commit 6b3aa00
Show file tree
Hide file tree
Showing 20 changed files with 57 additions and 57 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

## Introduction

> Version: **2412.1.25**
> Version: **2412.1.26**
>
> Date: **January 23, 2024**
> Date: **January 27, 2024**
---

Expand Down
14 changes: 7 additions & 7 deletions doc/controllers/utilities-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -1058,10 +1058,10 @@ orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

body := models.UpgradeOrgDevices{
Force: models.ToPointer(false),
MaxFailurePercentage: models.ToPointer(float64(5)),
MaxFailurePercentage: models.ToPointer(5),
P2pClusterSize: models.ToPointer(0),
Reboot: models.ToPointer(false),
RebootAt: models.ToPointer(float64(1624399840)),
RebootAt: models.ToPointer(1624399840),
RrmFirstBatchPercentage: models.ToPointer(2),
RrmMaxBatchPercentage: models.ToPointer(10),
RrmMeshUpgrade: models.ToPointer(models.DeviceUpgradeRrmMeshUpgradeEnum("sequential")),
Expand All @@ -1079,7 +1079,7 @@ body := models.UpgradeOrgDevices{
},
},
Snapshot: models.ToPointer(false),
StartTime: models.ToPointer(float64(1624399840)),
StartTime: models.ToPointer(1624399840),
Strategy: models.ToPointer(models.DeviceUpgradeStrategyEnum("big_bang")),
Version: models.ToPointer("3.1.5"),
}
Expand Down Expand Up @@ -1250,7 +1250,7 @@ body := models.MxedgeUpgradeMulti{
MxedgeIds: []uuid.UUID{
uuid.MustParse("387804a7-3474-85ce-15a2-f9a9684c9c90"),
},
StartTime: models.ToPointer(float64(1624399840)),
StartTime: models.ToPointer(1624399840),
Strategy: models.ToPointer(models.MxedgeUpgradeStrategyEnum("serial")),
Versions: models.ToPointer(models.MxedgeUpgradeVersion{
Mxagent: "latest",
Expand Down Expand Up @@ -1397,10 +1397,10 @@ siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")

body := models.UpgradeSiteDevices{
Force: models.ToPointer(false),
MaxFailurePercentage: models.ToPointer(float64(5)),
MaxFailurePercentage: models.ToPointer(5),
P2pClusterSize: models.ToPointer(0),
Reboot: models.ToPointer(false),
RebootAt: models.ToPointer(float64(1624399840)),
RebootAt: models.ToPointer(1624399840),
RrmFirstBatchPercentage: models.ToPointer(2),
RrmMaxBatchPercentage: models.ToPointer(10),
RrmMeshUpgrade: models.ToPointer(models.DeviceUpgradeRrmMeshUpgradeEnum("sequential")),
Expand All @@ -1418,7 +1418,7 @@ body := models.UpgradeSiteDevices{
},
},
Snapshot: models.ToPointer(false),
StartTime: models.ToPointer(float64(1624399840)),
StartTime: models.ToPointer(1624399840),
Strategy: models.ToPointer(models.DeviceUpgradeStrategyEnum("big_bang")),
Version: models.ToPointer("3.1.5"),
}
Expand Down
4 changes: 2 additions & 2 deletions doc/models/device-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@

| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `Reboot` | `*bool` | Optional | For Junos devices only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*int` | Optional | For Junos devices only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `Reboot` | `*bool` | Optional | For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*int` | Optional | For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `Snapshot` | `*bool` | Optional | For Junos devices only. Perform recovery snapshot after device is rebooted<br>**Default**: `false` |
| `StartTime` | `*int` | Optional | firmware download start time in epoch |
| `Version` | `string` | Required | specific version / `stable`, default is to use the latest<br>**Default**: `"stable"` |
Expand Down
2 changes: 1 addition & 1 deletion doc/models/mxedge-upgrade-multi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
| `Distro` | `*string` | Optional | distro upgrade, optional, to specific codename (e.g. bullseye) with highest qualified versions |
| `MaxFailurePercentage` | `*int` | Optional | Failure threshold before we stop the upgrade and mark it as failed<br>**Default**: `5` |
| `MxedgeIds` | `[]uuid.UUID` | Required | list of mxedge IDs to upgrade. If not specified, it means all the org mxedges. |
| `StartTime` | `*float64` | Optional | upgrade start time in epoch seconds, default is now |
| `StartTime` | `*int` | Optional | upgrade start time in epoch seconds, default is now |
| `Strategy` | [`*models.MxedgeUpgradeStrategyEnum`](../../doc/models/mxedge-upgrade-strategy-enum.md) | Optional | enum:<br><br>* `big_bang`: upgrade all at once, no orchestration<br>* `serial`: one at a time'<br>* `canary`: upgrade in phases<br>**Default**: `"big_bang"` |
| `Versions` | [`*models.MxedgeUpgradeVersion`](../../doc/models/mxedge-upgrade-version.md) | Optional | version to upgrade for each service, `current` / `latest` / `default` / specific version (e.g. `2.5.100`).\nIgnored if distro upgrade, `tunterm`, `radsecproxy`, `mxagent`, `mxocproxy`, `mxdas` or `mxnacedge` |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |
Expand Down
4 changes: 2 additions & 2 deletions doc/models/response-auto-placement-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
| --- | --- | --- | --- |
| `EndTime` | `*float64` | Optional | time when autoplacement completed or was manually stopped |
| `EstTimeLeft` | `*float64` | Optional | (Only when inprogress) estimate of the time to completion |
| `StartTime` | `*float64` | Optional | time when autoplacement process was last queued for this map |
| `StartTime` | `*int` | Optional | time when autoplacement process was last queued for this map |
| `Status` | [`*models.AutoPlacementInfoStatusEnum`](../../doc/models/auto-placement-info-status-enum.md) | Optional | the status of autoplacement for a given map. enum: `done`, `error`, `inprogress`, `pending` |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |

Expand All @@ -23,7 +23,7 @@
{
"end_time": 184.76,
"est_time_left": 52.68,
"start_time": 23.88,
"start_time": 84,
"status": "done",
"exampleAdditionalProperty": {
"key1": "val1",
Expand Down
2 changes: 1 addition & 1 deletion doc/models/response-site-device-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| `MaxFailurePercentage` | `*int` | Optional | percentage of failures allowed |
| `MaxFailures` | `[]int` | Optional | number of failures allowed within a canary phase or serial rollout |
| `RebootAt` | `*int` | Optional | reboot start time in epoch |
| `StartTime` | `*float64` | Optional | firmware download start time in epoch |
| `StartTime` | `*int` | Optional | firmware download start time in epoch |
| `Status` | [`*models.DeviceUpgradeStatusEnum`](../../doc/models/device-upgrade-status-enum.md) | Optional | status upgrade is in. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `upgrading` |
| `Strategy` | [`*models.DeviceUpgradeStrategyEnum`](../../doc/models/device-upgrade-strategy-enum.md) | Optional | For APs only. enum: `big_bang` (upgrade all at once), `canary`, `rrm`, `serial` (one at a time)<br>**Default**: `"big_bang"` |
| `TargetVersion` | `*string` | Optional | version to upgrade to<br>**Constraints**: *Minimum Length*: `1` |
Expand Down
2 changes: 1 addition & 1 deletion doc/models/response-upgrade-org-device.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6",
"upgrade": {
"id": "000016ac-0000-0000-0000-000000000000",
"start_time": 2.28,
"start_time": 228,
"status": "downloaded",
"targets": {
"download_requested": [
Expand Down
2 changes: 1 addition & 1 deletion doc/models/ssr-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `Channel` | [`*models.SsrUpgradeChannelEnum`](../../doc/models/ssr-upgrade-channel-enum.md) | Optional | upgrade channel to follow. enum: `alpha`, `beta`, `stable`<br>**Default**: `"stable"` |
| `RebootAt` | `*int` | Optional | eboot start time in epoch seconds, default is start_time, -1 disables reboot |
| `RebootAt` | `*int` | Optional | reboot start time in epoch seconds, default is start_time, -1 disables reboot |
| `StartTime` | `*int` | Optional | 128T firmware download start time in epoch seconds, default is now, -1 disables download |
| `Version` | `string` | Required | 128T firmware version to upgrade (e.g. 5.3.0-93)<br>**Default**: `"stable"`<br>**Constraints**: *Minimum Length*: `1` |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |
Expand Down
4 changes: 2 additions & 2 deletions doc/models/upgrade-org-device-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| Name | Type | Tags | Description |
| --- | --- | --- | --- |
| `Id` | `*uuid.UUID` | Optional | Unique ID of the object instance in the Mist Organnization |
| `StartTime` | `*float64` | Optional | - |
| `StartTime` | `*int` | Optional | - |
| `Status` | [`*models.DeviceUpgradeStatusEnum`](../../doc/models/device-upgrade-status-enum.md) | Optional | status upgrade is in. enum: `cancelled`, `completed`, `created`, `downloaded`, `downloading`, `failed`, `upgrading` |
| `Targets` | [`*models.UpgradeOrgDeviceTargets`](../../doc/models/upgrade-org-device-targets.md) | Optional | - |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |
Expand All @@ -22,7 +22,7 @@
```json
{
"id": "53f10664-3ce8-4c27-b382-0ef66432349f",
"start_time": 1717658765.0,
"start_time": 1717658765,
"status": "created",
"targets": {
"download_requested": [
Expand Down
10 changes: 5 additions & 5 deletions doc/models/upgrade-org-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
| `CanaryPhases` | `[]int` | Optional | For APs only and if `strategy`==`canary`. Phases for canary deployment. Each phase represents percentage of devices that need to be upgraded in that phase. |
| `EnableP2p` | `*bool` | Optional | for APs only. whether to allow local AP-to-AP FW upgrade |
| `Force` | `*bool` | Optional | true will force upgrade when requested version is same as running version<br>**Default**: `false` |
| `MaxFailurePercentage` | `*float64` | Optional | for APs only and if `strategy`!=`big_bang`. percentage of failures allowed across the entire upgrade<br>**Default**: `5`<br>**Constraints**: `>= 0`, `<= 100` |
| `MaxFailurePercentage` | `*int` | Optional | for APs only and if `strategy`!=`big_bang`. percentage of failures allowed across the entire upgrade<br>**Default**: `5`<br>**Constraints**: `>= 0`, `<= 100` |
| `MaxFailures` | `[]int` | Optional | For APs only and if `strategy`==`canary`. Number of failures allowed within each phase. Only applicable for `canary`. Array length should be same as `canary_phases`. Will be used if provided, else `max_failure_percentage` will be used |
| `Models` | `[]string` | Optional | models which will be selected for upgrade |
| `P2pClusterSize` | `*int` | Optional | For APs only and if `enable_p2p`==`true`.<br>**Default**: `10`<br>**Constraints**: `>= 0` |
| `P2pParallelism` | `*int` | Optional | For APs only and if `enable_p2p`==`true`. Number of parallel p2p download batches to create |
| `Reboot` | `*bool` | Optional | For Junos devices only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*float64` | Optional | For Junos devices only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `Reboot` | `*bool` | Optional | For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*int` | Optional | For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `RrmFirstBatchPercentage` | `*int` | Optional | For APs only and if `strategy`==`rrm`. Percentage of APs that need to be present in the first RRM batch |
| `RrmMaxBatchPercentage` | `*int` | Optional | For APs only and if `strategy`==`rrm`. Max percentage of APs that need to be present in each RRM batch |
| `RrmMeshUpgrade` | [`*models.DeviceUpgradeRrmMeshUpgradeEnum`](../../doc/models/device-upgrade-rrm-mesh-upgrade-enum.md) | Optional | For APs only and if `strategy`==`rrm`. Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade. enum: `parallel`, `sequential`<br>**Default**: `"sequential"` |
Expand All @@ -29,7 +29,7 @@
| `Rules` | `[]map[string]string` | Optional | Rules used to identify devices which will be selected for upgrade. Device will be selected as long as it satisfies any one rule <br>Property key defines the type of matching, value is the string to match. e.g:<br><br>* `match_name`: Device name must match the property value<br>* `match_name[0:3]`: Device name must match the first 3 letters of the property value<br>* `match_name[2:6]`: Device name must match the property value from the 2nd to the 6th letter<br>* `match_model`: Device model must match the property value<br>* `match_model[1:3]`: Device model must match the property value from the 1nd to the 3rd letter |
| `SiteIds` | `[]uuid.UUID` | Optional | - |
| `Snapshot` | `*bool` | Optional | For Junos devices only. Perform recovery snapshot after device is rebooted<br>**Default**: `false` |
| `StartTime` | `*float64` | Optional | upgrade start time in epoch seconds, default is now |
| `StartTime` | `*int` | Optional | upgrade start time in epoch seconds, default is now |
| `Strategy` | [`*models.DeviceUpgradeStrategyEnum`](../../doc/models/device-upgrade-strategy-enum.md) | Optional | For APs only. enum: `big_bang` (upgrade all at once), `canary`, `rrm`, `serial` (one at a time)<br>**Default**: `"big_bang"` |
| `Version` | `*string` | Optional | specific version / stable, default is to use the lastest available version |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |
Expand All @@ -43,7 +43,7 @@
138
],
"force": false,
"max_failure_percentage": 5.0,
"max_failure_percentage": 5,
"p2p_cluster_size": 0,
"reboot": false,
"reboot_at": 1624399840,
Expand Down
10 changes: 5 additions & 5 deletions doc/models/upgrade-site-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@
| `DeviceIds` | `[]uuid.UUID` | Optional | id’s of devices which will be selected for upgrade |
| `EnableP2p` | `*bool` | Optional | for APs only. whether to allow local AP-to-AP FW upgrade |
| `Force` | `*bool` | Optional | true will force upgrade when requested version is same as running version<br>**Default**: `false` |
| `MaxFailurePercentage` | `*float64` | Optional | for APs only and if `strategy`!=`big_bang`. percentage of failures allowed across the entire upgrade<br>**Default**: `5`<br>**Constraints**: `>= 0`, `<= 100` |
| `MaxFailurePercentage` | `*int` | Optional | for APs only and if `strategy`!=`big_bang`. percentage of failures allowed across the entire upgrade<br>**Default**: `5`<br>**Constraints**: `>= 0`, `<= 100` |
| `MaxFailures` | `[]int` | Optional | For APs only and if `strategy`==`canary`. Number of failures allowed within each phase. Only applicable for `canary`. Array length should be same as `canary_phases`. Will be used if provided, else `max_failure_percentage` will be used |
| `Models` | `[]string` | Optional | models which will be selected for upgrade |
| `P2pClusterSize` | `*int` | Optional | For APs only and if `enable_p2p`==`true`.<br>**Default**: `10`<br>**Constraints**: `>= 0` |
| `P2pParallelism` | `*int` | Optional | For APs only and if `enable_p2p`==`true`. Number of parallel p2p download batches to create |
| `Reboot` | `*bool` | Optional | For Junos devices only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*float64` | Optional | For Junos devices only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `Reboot` | `*bool` | Optional | For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed<br>**Default**: `false` |
| `RebootAt` | `*int` | Optional | For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time` |
| `RrmFirstBatchPercentage` | `*int` | Optional | For APs only and if `strategy`==`rrm`. Percentage of APs that need to be present in the first RRM batch |
| `RrmMaxBatchPercentage` | `*int` | Optional | For APs only and if `strategy`==`rrm`. Max percentage of APs that need to be present in each RRM batch |
| `RrmMeshUpgrade` | [`*models.DeviceUpgradeRrmMeshUpgradeEnum`](../../doc/models/device-upgrade-rrm-mesh-upgrade-enum.md) | Optional | For APs only and if `strategy`==`rrm`. Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade. enum: `parallel`, `sequential`<br>**Default**: `"sequential"` |
| `RrmNodeOrder` | [`*models.DeviceUpgradeRrmNodeOrderEnum`](../../doc/models/device-upgrade-rrm-node-order-enum.md) | Optional | For APs only and if `strategy`==`rrm`. Used in rrm to determine whether to start upgrade from fringe or center AP’s. enum: `center_to_fringe`, `fringe_to_center`<br>**Default**: `"fringe_to_center"` |
| `RrmSlowRamp` | `*bool` | Optional | For APs only and if `strategy`==`rrm`. True will make rrm batch sizes slowly ramp up |
| `Rules` | `[]map[string]string` | Optional | Rules used to identify devices which will be selected for upgrade. Device will be selected as long as it satisfies any one rule <br>Property key defines the type of matching, value is the string to match. e.g:<br><br>* `match_name`: Device name must match the property value<br>* `match_name[0:3]`: Device name must match the first 3 letters of the property value<br>* `match_name[2:6]`: Device name must match the property value from the 2nd to the 6th letter<br>* `match_model`: Device model must match the property value<br>* `match_model[1:3]`: Device model must match the property value from the 1nd to the 3rd letter |
| `Snapshot` | `*bool` | Optional | For Junos devices only. Perform recovery snapshot after device is rebooted<br>**Default**: `false` |
| `StartTime` | `*float64` | Optional | upgrade start time in epoch seconds, default is now |
| `StartTime` | `*int` | Optional | upgrade start time in epoch seconds, default is now |
| `Strategy` | [`*models.DeviceUpgradeStrategyEnum`](../../doc/models/device-upgrade-strategy-enum.md) | Optional | For APs only. enum: `big_bang` (upgrade all at once), `canary`, `rrm`, `serial` (one at a time)<br>**Default**: `"big_bang"` |
| `Version` | `*string` | Optional | specific version / stable, default is to use the lastest available version |
| `AdditionalProperties` | `map[string]interface{}` | Optional | - |
Expand All @@ -43,7 +43,7 @@
136
],
"force": false,
"max_failure_percentage": 5.0,
"max_failure_percentage": 5,
"p2p_cluster_size": 0,
"reboot": false,
"reboot_at": 1624399840,
Expand Down
2 changes: 1 addition & 1 deletion mistapi/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ func NewClient(configuration Configuration) ClientInterface {
configuration: configuration,
}

client.userAgent = utilities.UpdateUserAgent("SDK 2412.1.25")
client.userAgent = utilities.UpdateUserAgent("SDK 2412.1.26")
client.callBuilderFactory = callBuilderHandler(
func(server string) string {
if server == "" {
Expand Down
4 changes: 2 additions & 2 deletions mistapi/models/device_upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import (

// DeviceUpgrade represents a DeviceUpgrade struct.
type DeviceUpgrade struct {
// For Junos devices only (APs are automatically rebooted). Reboot device immediately after upgrade is completed
// For Switches and Gateways only (APs are automatically rebooted). Reboot device immediately after upgrade is completed
Reboot *bool `json:"reboot,omitempty"`
// For Junos devices only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time`
// For Switches and Gateways only and if `reboot`==`true`. Reboot start time in epoch seconds, default is `start_time`
RebootAt *int `json:"reboot_at,omitempty"`
// For Junos devices only. Perform recovery snapshot after device is rebooted
Snapshot *bool `json:"snapshot,omitempty"`
Expand Down
Loading

0 comments on commit 6b3aa00

Please sign in to comment.