v0.4.31

tmunzer · Jan 9, 2025 · de2e477 · de2e477
1 parent e5ab436
commit de2e477
Show file tree

Hide file tree

Showing 65 changed files with 692 additions and 440 deletions.
diff --git a/README.md b/README.md
@@ -3,9 +3,9 @@
 
 ## Introduction
 
-> Version: **2412.1.16**
+> Version: **2412.1.19**
 > 
-> Date: **January 6, 2024**
+> Date: **January 9, 2024**
 
 ---
 

diff --git a/doc/controllers/orgs-evpn-topologies.md b/doc/controllers/orgs-evpn-topologies.md
@@ -300,7 +300,7 @@ ListOrgEvpnTopologies(
     orgId uuid.UUID,
     limit *int,
     page *int) (
-    models.ApiResponse[[]models.EvpnTopology],
+    models.ApiResponse[[]models.EvpnTopologyResponse],
     error)
 ```
 
@@ -314,7 +314,7 @@ ListOrgEvpnTopologies(
 
 ## Response Type
 
-[`[]models.EvpnTopology`](../../doc/models/evpn-topology.md)
+[`[]models.EvpnTopologyResponse`](../../doc/models/evpn-topology-response.md)
 
 ## Example Usage
 
@@ -342,38 +342,33 @@ if err != nil {
 ```json
 [
   {
-    "id": "9197ec96-4c8d-529f-c595-035895e688b2",
-    "name": "CC",
-    "overwrite": true,
+    "created_time": 1736421230,
+    "evpn_options": {
+      "auto_loopback_subnet": "172.16.192.0/24",
+      "auto_loopback_subnet6": "fd33:ab00:2::/64",
+      "auto_router_id_subnet": "172.16.254.0/23",
+      "core_as_border": true,
+      "overlay": {
+        "as": 65000
+      },
+      "per_vlan_vga_v4_mac": false,
+      "routed_at": "core",
+      "underlay": {
+        "as_base": 65001,
+        "subnet": "10.255.240.0/20",
+        "use_ipv6": false
+      }
+    },
+    "for_site": false,
+    "id": "764fb173-94f9-447c-8454-def62e5a999f",
+    "modified_time": 1736421230,
+    "name": "tert",
+    "org_id": "3a2627d7-bfbc-45af-b85d-8841581c6d63",
     "pod_names": {
-      "1": "default",
-      "2": "default"
+      "1": "Pod 1"
     },
-    "switches": [
-      {
-        "deviceprofile_id": "6a1deab1-96df-4fa2-8455-d5253f943d06",
-        "downlink_ips": [
-          "10.255.240.6",
-          "10.255.240.8"
-        ],
-        "downlinks": [
-          "5c5b35000007",
-          "5c5b35000008"
-        ],
-        "esilaglinks": [
-          "5c5b3500000f"
-        ],
-        "evpn_id": 1,
-        "mac": "5c5b35000003",
-        "model": "QFX10002-36Q",
-        "role": "collapsed-core",
-        "site_id": "1916d52a-4a90-11e5-8b45-1258369c38a9",
-        "uplinks": [
-          "5c5b35000005",
-          "5c5b35000006"
-        ]
-      }
-    ]
+    "site_id": "00000000-0000-0000-0000-000000000000",
+    "version": 6
   }
 ]
 ```

diff --git a/doc/controllers/sites-devices.md b/doc/controllers/sites-devices.md
@@ -20,7 +20,6 @@ sitesDevices := client.SitesDevices()
 * [Get Site Device](../../doc/controllers/sites-devices.md#get-site-device)
 * [Import Site Devices](../../doc/controllers/sites-devices.md#import-site-devices)
 * [List Site Devices](../../doc/controllers/sites-devices.md#list-site-devices)
-* [Restart Site Multiple Devices](../../doc/controllers/sites-devices.md#restart-site-multiple-devices)
 * [Search Site Device Config History](../../doc/controllers/sites-devices.md#search-site-device-config-history)
 * [Search Site Device Events](../../doc/controllers/sites-devices.md#search-site-device-events)
 * [Search Site Device Last Configs](../../doc/controllers/sites-devices.md#search-site-device-last-configs)
@@ -1022,63 +1021,6 @@ if err != nil {
 | 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
 
 
-# Restart Site Multiple Devices
-
-Note that only the devices that are connected will be restarted.
-
-```go
-RestartSiteMultipleDevices(
-    ctx context.Context,
-    siteId uuid.UUID,
-    body *models.UtilsDevicesRestartMulti) (
-    http.Response,
-    error)
-```
-
-## Parameters
-
-| Parameter | Type | Tags | Description |
-|  --- | --- | --- | --- |
-| `siteId` | `uuid.UUID` | Template, Required | - |
-| `body` | [`*models.UtilsDevicesRestartMulti`](../../doc/models/utils-devices-restart-multi.md) | Body, Optional | Request Body |
-
-## Response Type
-
-``
-
-## Example Usage
-
-```go
-ctx := context.Background()
-
-siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")
-
-body := models.UtilsDevicesRestartMulti{
-    DeviceIds:            []uuid.UUID{
-        uuid.MustParse("00000000-0000-0000-1000-5c5b35584a6f"),
-        uuid.MustParse("00000000-0000-0000-1000-5c5b350ea3b3"),
-    },
-}
-
-resp, err := sitesDevices.RestartSiteMultipleDevices(ctx, siteId, &body)
-if err != nil {
-    log.Fatalln(err)
-} else {
-    fmt.Println(resp.StatusCode)
-}
-```
-
-## Errors
-
-| HTTP Status Code | Error Description | Exception Class |
-|  --- | --- | --- |
-| 400 | Bad Syntax | [`ResponseHttp400Exception`](../../doc/models/response-http-400-exception.md) |
-| 401 | Unauthorized | [`ResponseHttp401ErrorException`](../../doc/models/response-http-401-error-exception.md) |
-| 403 | Permission Denied | [`ResponseHttp403ErrorException`](../../doc/models/response-http-403-error-exception.md) |
-| 404 | Not found. The API endpoint doesn’t exist or resource doesn’ t exist | [`ResponseHttp404Exception`](../../doc/models/response-http-404-exception.md) |
-| 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
-
-
 # Search Site Device Config History
 
 Search for entries in device config history

diff --git a/doc/controllers/utilities-common.md b/doc/controllers/utilities-common.md
@@ -23,6 +23,7 @@ utilitiesCommon := client.UtilitiesCommon()
 * [Release Site Device Dhcp Lease](../../doc/controllers/utilities-common.md#release-site-device-dhcp-lease)
 * [Reprovision Site Octerm Device](../../doc/controllers/utilities-common.md#reprovision-site-octerm-device)
 * [Restart Site Device](../../doc/controllers/utilities-common.md#restart-site-device)
+* [Restart Site Multiple Devices](../../doc/controllers/utilities-common.md#restart-site-multiple-devices)
 * [Show Site Device Arp Table](../../doc/controllers/utilities-common.md#show-site-device-arp-table)
 * [Show Site Device Bgp Summary](../../doc/controllers/utilities-common.md#show-site-device-bgp-summary)
 * [Show Site Device Dhcp Leases](../../doc/controllers/utilities-common.md#show-site-device-dhcp-leases)
@@ -889,6 +890,63 @@ if err != nil {
 | 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
 
 
+# Restart Site Multiple Devices
+
+Note that only the devices that are connected will be restarted.
+
+```go
+RestartSiteMultipleDevices(
+    ctx context.Context,
+    siteId uuid.UUID,
+    body *models.UtilsDevicesRestartMulti) (
+    http.Response,
+    error)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `siteId` | `uuid.UUID` | Template, Required | - |
+| `body` | [`*models.UtilsDevicesRestartMulti`](../../doc/models/utils-devices-restart-multi.md) | Body, Optional | Request Body |
+
+## Response Type
+
+``
+
+## Example Usage
+
+```go
+ctx := context.Background()
+
+siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")
+
+body := models.UtilsDevicesRestartMulti{
+    DeviceIds:            []uuid.UUID{
+        uuid.MustParse("00000000-0000-0000-1000-5c5b35584a6f"),
+        uuid.MustParse("00000000-0000-0000-1000-5c5b350ea3b3"),
+    },
+}
+
+resp, err := utilitiesCommon.RestartSiteMultipleDevices(ctx, siteId, &body)
+if err != nil {
+    log.Fatalln(err)
+} else {
+    fmt.Println(resp.StatusCode)
+}
+```
+
+## Errors
+
+| HTTP Status Code | Error Description | Exception Class |
+|  --- | --- | --- |
+| 400 | Bad Syntax | [`ResponseHttp400Exception`](../../doc/models/response-http-400-exception.md) |
+| 401 | Unauthorized | [`ResponseHttp401ErrorException`](../../doc/models/response-http-401-error-exception.md) |
+| 403 | Permission Denied | [`ResponseHttp403ErrorException`](../../doc/models/response-http-403-error-exception.md) |
+| 404 | Not found. The API endpoint doesn’t exist or resource doesn’ t exist | [`ResponseHttp404Exception`](../../doc/models/response-http-404-exception.md) |
+| 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
+
+
 # Show Site Device Arp Table
 
 Get ARP Table from the Device.

diff --git a/doc/controllers/utilities-upgrade.md b/doc/controllers/utilities-upgrade.md
@@ -10,6 +10,7 @@ utilitiesUpgrade := client.UtilitiesUpgrade()
 
 ## Methods
 
+* [Cancel Org Device Upgrade](../../doc/controllers/utilities-upgrade.md#cancel-org-device-upgrade)
 * [Cancel Org Ssr Upgrade](../../doc/controllers/utilities-upgrade.md#cancel-org-ssr-upgrade)
 * [Cancel Site Device Upgrade](../../doc/controllers/utilities-upgrade.md#cancel-site-device-upgrade)
 * [Get Org Device Upgrade](../../doc/controllers/utilities-upgrade.md#get-org-device-upgrade)
@@ -32,6 +33,58 @@ utilitiesUpgrade := client.UtilitiesUpgrade()
 * [Upgrade Ssr](../../doc/controllers/utilities-upgrade.md#upgrade-ssr)
 
 
+# Cancel Org Device Upgrade
+
+Best effort to cancel an upgrade. Devices which are already upgraded wont be touched
+
+```go
+CancelOrgDeviceUpgrade(
+    ctx context.Context,
+    orgId uuid.UUID,
+    upgradeId uuid.UUID) (
+    http.Response,
+    error)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `orgId` | `uuid.UUID` | Template, Required | - |
+| `upgradeId` | `uuid.UUID` | Template, Required | - |
+
+## Response Type
+
+``
+
+## Example Usage
+
+```go
+ctx := context.Background()
+
+orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")
+
+upgradeId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")
+
+resp, err := utilitiesUpgrade.CancelOrgDeviceUpgrade(ctx, orgId, upgradeId)
+if err != nil {
+    log.Fatalln(err)
+} else {
+    fmt.Println(resp.StatusCode)
+}
+```
+
+## Errors
+
+| HTTP Status Code | Error Description | Exception Class |
+|  --- | --- | --- |
+| 400 | Bad Syntax | [`ResponseHttp400Exception`](../../doc/models/response-http-400-exception.md) |
+| 401 | Unauthorized | [`ResponseHttp401ErrorException`](../../doc/models/response-http-401-error-exception.md) |
+| 403 | Permission Denied | [`ResponseHttp403ErrorException`](../../doc/models/response-http-403-error-exception.md) |
+| 404 | Not found. The API endpoint doesn’t exist or resource doesn’ t exist | [`ResponseHttp404Exception`](../../doc/models/response-http-404-exception.md) |
+| 429 | Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold | [`ResponseHttp429ErrorException`](../../doc/models/response-http-429-error-exception.md) |
+
+
 # Cancel Org Ssr Upgrade
 
 Best effort to cancel an upgrade. Devices which are already upgraded wont be touched↵
@@ -1333,18 +1386,13 @@ siteId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")
 body := models.UpgradeSiteDevices{
     Force:                   models.ToPointer(false),
     MaxFailurePercentage:    models.ToPointer(float64(5)),
-    MaxFailures:             []int{
-        1,
-        1,
-        5,
-        5,
-    },
     P2pClusterSize:          models.ToPointer(0),
     Reboot:                  models.ToPointer(false),
     RebootAt:                models.ToPointer(float64(1624399840)),
     RrmFirstBatchPercentage: models.ToPointer(2),
     RrmMaxBatchPercentage:   models.ToPointer(10),
-    RrmNodeOrder:            models.ToPointer(models.UpgradeSiteDevicesRrmNodeOrderEnum("fringe_to_center")),
+    RrmMeshUpgrade:          models.ToPointer(models.DeviceUpgradeRrmMeshUpgradeEnum("sequential")),
+    RrmNodeOrder:            models.ToPointer(models.DeviceUpgradeRrmNodeOrderEnum("fringe_to_center")),
     Snapshot:                models.ToPointer(false),
     StartTime:               models.ToPointer(float64(1624399840)),
     Strategy:                models.ToPointer(models.DeviceUpgradeStrategyEnum("big_bang")),

diff --git a/doc/models/admin-privilege-view-enum.md b/doc/models/admin-privilege-view-enum.md
@@ -1,16 +1,9 @@
 
 # Admin Privilege View Enum
 
-Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.
-
-You can invite a new user or update existing users in your Org to this custom role. For this, specify view along with role when assigning privileges.
-
-Below are the list of supported UI views. Note that this is UI only feature
-Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.
-
-You can invite a new user or update existing users in your Org to this custom role. For this, specify `view` along with `role` when assigning privileges.
-
-Below are the list of supported UI views. Note that this is UI only feature
+Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users. Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.  
+You can define custom roles by adding the `views` attribute along with `role` when assigning privileges.  
+Below are the list of supported UI views. Note that this is UI only feature.
 
 | UI View | Required Role | Description |
 | --- | --- | --- |

diff --git a/doc/models/admin-privilege.md b/doc/models/admin-privilege.md
@@ -25,7 +25,7 @@ Privilieges settings
 | `Scope` | [`models.AdminPrivilegeScopeEnum`](../../doc/models/admin-privilege-scope-enum.md) | Required | enum: `msp`, `org`, `orggroup`, `site`, `sitegroup` |
 | `SiteId` | `*uuid.UUID` | Optional | required if `scope`==`site` |
 | `SitegroupIds` | `[]uuid.UUID` | Optional | - |
-| `Views` | [`*models.AdminPrivilegeViewEnum`](../../doc/models/admin-privilege-view-enum.md) | Optional | Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.<br><br>You can invite a new user or update existing users in your Org to this custom role. For this, specify view along with role when assigning privileges.<br><br>Below are the list of supported UI views. Note that this is UI only feature<br>Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.<br><br>You can invite a new user or update existing users in your Org to this custom role. For this, specify `view` along with `role` when assigning privileges.<br><br>Below are the list of supported UI views. Note that this is UI only feature<br><br>\| UI View \| Required Role \| Description \|<br>\| --- \| --- \| --- \|<br>\| `reporting` \| `read` \| full access to all analytics tools \|<br>\| `marketing` \| `read` \| can view analytics and location maps \|<br>\| `super_observer` \| `read` \| can view all the organization except the subscription page \|<br>\| `location` \| `write` \| can view and manage location maps, can view analytics \|<br>\| `security` \| `write` \| can view and manage site labels, policies and security \|<br>\| `switch_admin` \| `helpdesk` \| can view and manage Switch ports, can view wired clients \|<br>\| `mxedge_admin` \| `admin` \| can view and manage Mist edges and Mist tunnels \|<br>\| `lobby_admin` \| `admin` \| full access to Org and Site Pre-shared keys \| |
+| `Views` | [`*models.AdminPrivilegeViewEnum`](../../doc/models/admin-privilege-view-enum.md) | Optional | Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users. Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users.  <br>You can define custom roles by adding the `views` attribute along with `role` when assigning privileges.  <br>Below are the list of supported UI views. Note that this is UI only feature.<br><br>\| UI View \| Required Role \| Description \|<br>\| --- \| --- \| --- \|<br>\| `reporting` \| `read` \| full access to all analytics tools \|<br>\| `marketing` \| `read` \| can view analytics and location maps \|<br>\| `super_observer` \| `read` \| can view all the organization except the subscription page \|<br>\| `location` \| `write` \| can view and manage location maps, can view analytics \|<br>\| `security` \| `write` \| can view and manage site labels, policies and security \|<br>\| `switch_admin` \| `helpdesk` \| can view and manage Switch ports, can view wired clients \|<br>\| `mxedge_admin` \| `admin` \| can view and manage Mist edges and Mist tunnels \|<br>\| `lobby_admin` \| `admin` \| full access to Org and Site Pre-shared keys \| |
 | `AdditionalProperties` | `map[string]interface{}` | Optional | - |
 
 ## Example (as JSON)

diff --git a/doc/models/ap-uplink-port-config.md b/doc/models/ap-uplink-port-config.md
@@ -1,6 +1,8 @@
 
 # Ap Uplink Port Config
 
+AP Uplink port configuration
+
 *This model accepts additional fields of type interface{}.*
 
 ## Structure

diff --git a/doc/models/device-ap.md b/doc/models/device-ap.md
@@ -52,7 +52,7 @@ AP
 | `Serial` | `*string` | Optional | device Serial |
 | `SiteId` | `*uuid.UUID` | Optional | - |
 | `Type` | `string` | Required, Constant | Device Type. enum: `ap`<br>**Default**: `"ap"` |
-| `UplinkPortConfig` | [`*models.ApUplinkPortConfig`](../../doc/models/ap-uplink-port-config.md) | Optional | - |
+| `UplinkPortConfig` | [`*models.ApUplinkPortConfig`](../../doc/models/ap-uplink-port-config.md) | Optional | AP Uplink port configuration |
 | `UsbConfig` | [`*models.ApUsb`](../../doc/models/ap-usb.md) | Optional | USB AP settings<br><br>- Note: if native imagotag is enabled, BLE will be disabled automatically<br>- Note: legacy, new config moved to ESL Config. |
 | `Vars` | `map[string]string` | Optional | a dictionary of name->value, the vars can then be used in Wlans. This can overwrite those from Site Vars |
 | `X` | `*float64` | Optional | x in pixel |

diff --git a/doc/models/device-upgrade-rrm-mesh-upgrade-enum.md b/doc/models/device-upgrade-rrm-mesh-upgrade-enum.md
@@ -1,7 +1,7 @@
 
 # Device Upgrade Rrm Mesh Upgrade Enum
 
-Whether to upgrade mesh AP’s parallelly or sequentially at the end of the upgrade. enum: `parallel`, `sequential`
+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`
 
 ## Enumeration
 

diff --git a/doc/models/device-upgrade-rrm-node-order-enum.md b/doc/models/device-upgrade-rrm-node-order-enum.md
@@ -1,7 +1,7 @@
 
 # Device Upgrade Rrm Node Order Enum
 
-Used in rrm to determine whether to start upgrade from fringe or center AP’s. enum: `center_to_fringe`, `fringe_to_center`
+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`
 
 ## Enumeration
 

diff --git a/doc/models/device-upgrade-strategy-enum.md b/doc/models/device-upgrade-strategy-enum.md
@@ -1,7 +1,7 @@
 
 # Device Upgrade Strategy Enum
 
-enum: `big_bang` (upgrade all at once), `canary`, `rrm`, `serial` (one at a time)
+For APs only. enum: `big_bang` (upgrade all at once), `canary`, `rrm`, `serial` (one at a time)
 
 ## Enumeration