Skip to content

Commit

Permalink
v0.4.17
Browse files Browse the repository at this point in the history
  • Loading branch information
tmunzer committed Dec 6, 2024
1 parent bb86894 commit 53c8ba2
Show file tree
Hide file tree
Showing 135 changed files with 2,714 additions and 3,027 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: **2410.1.19**
> Version: **2412.1.1**
>
> Date: **December 3, 2024**
> Date: **December 6, 2024**
---

Expand Down
16 changes: 9 additions & 7 deletions doc/controllers/ms-ps-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,15 @@ if err != nil {
"limit": 100,
"results": [
{
"admin_id": "72bfa2bd-e58a-4670-9d20-a1468f7a6f58",
"admin_name": "test@mistsys.com",
"id": "c6f9347b-b0a4-4a23-b927-fa9249f2ffb2",
"message": "TEST AUDIT",
"org_id": "469f6eca-6276-4993-bfeb-53cbbbba6f58",
"site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",
"timestamp": 1431382121
"admin_id": "48f4d7aa-97a0-43e1-81f7-74dbda4a9dae",
"admin_name": "Chia-Wei Tang tangc@juniper.net",
"id": "ac4415e5-7aef-4c79-9d17-7a7edd268e16",
"message": "Accessed Org \"DELETE_ME\"",
"org_id": "b0d0c697-c4c8-459a-bf61-bfe820aead98",
"site_id": null,
"src_ip": "165.225.242.194",
"timestamp": 1729278563,
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:130.0) Gecko/20100101 Firefox/130.0"
}
],
"start": 1428939600,
Expand Down
32 changes: 28 additions & 4 deletions doc/controllers/orgs-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ SearchOrgDeviceEvents(
orgId uuid.UUID,
mac *string,
model *string,
deviceType *models.DeviceTypeEnum,
deviceType *models.DeviceTypeWithAllEnum,
text *string,
timestamp *string,
mType *string,
Expand All @@ -610,7 +610,7 @@ SearchOrgDeviceEvents(
| `orgId` | `uuid.UUID` | Template, Required | - |
| `mac` | `*string` | Query, Optional | device mac |
| `model` | `*string` | Query, Optional | device model |
| `deviceType` | [`*models.DeviceTypeEnum`](../../doc/models/device-type-enum.md) | Query, Optional | **Default**: `"ap"` |
| `deviceType` | [`*models.DeviceTypeWithAllEnum`](../../doc/models/device-type-with-all-enum.md) | Query, Optional | **Default**: `"ap"` |
| `text` | `*string` | Query, Optional | event message |
| `timestamp` | `*string` | Query, Optional | event time |
| `mType` | `*string` | Query, Optional | see [listDeviceEventsDefinitions]($e/Constants%20Events/listDeviceEventsDefinitions) |
Expand All @@ -635,7 +635,7 @@ orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")



deviceType := models.DeviceTypeEnum("ap")
deviceType := models.DeviceTypeWithAllEnum("ap")



Expand Down Expand Up @@ -862,6 +862,7 @@ SearchOrgDevices(
model *string,
mac *string,
version *string,
extIp *string,
powerConstrained *bool,
ipAddress *string,
mxtunnelStatus *models.SearchOrgDevicesMxtunnelStatusEnum,
Expand All @@ -871,12 +872,17 @@ SearchOrgDevices(
lldpSystemDesc *string,
lldpPortId *string,
lldpMgmtAddr *string,
lldpPowerAllocated *int,
lldpPowerDraw *int,
band24Bandwidth *int,
band5Bandwidth *int,
band6Bandwidth *int,
band24Channel *int,
band5Channel *int,
band6Channel *int,
band24Power *int,
band5Power *int,
band6Power *int,
eth0PortSpeed *int,
limit *int,
start *int,
Expand All @@ -896,6 +902,7 @@ SearchOrgDevices(
| `model` | `*string` | Query, Optional | device model |
| `mac` | `*string` | Query, Optional | AP mac |
| `version` | `*string` | Query, Optional | version |
| `extIp` | `*string` | Query, Optional | External IP Address |
| `powerConstrained` | `*bool` | Query, Optional | power_constrained |
| `ipAddress` | `*string` | Query, Optional | - |
| `mxtunnelStatus` | [`*models.SearchOrgDevicesMxtunnelStatusEnum`](../../doc/models/search-org-devices-mxtunnel-status-enum.md) | Query, Optional | MxTunnel status, up / down |
Expand All @@ -905,12 +912,17 @@ SearchOrgDevices(
| `lldpSystemDesc` | `*string` | Query, Optional | LLDP system description |
| `lldpPortId` | `*string` | Query, Optional | LLDP port id |
| `lldpMgmtAddr` | `*string` | Query, Optional | LLDP management ip address |
| `lldpPowerAllocated` | `*int` | Query, Optional | LLDP Allocated Powe |
| `lldpPowerDraw` | `*int` | Query, Optional | LLDP Negotiated Power |
| `band24Bandwidth` | `*int` | Query, Optional | bandwidth of band_24 |
| `band5Bandwidth` | `*int` | Query, Optional | bandwidth of band_5 |
| `band6Bandwidth` | `*int` | Query, Optional | bandwidth of band_6 |
| `band24Channel` | `*int` | Query, Optional | Channel of band_24 |
| `band5Channel` | `*int` | Query, Optional | Channel of band_5 |
| `band6Channel` | `*int` | Query, Optional | Channel of band_6 |
| `band24Power` | `*int` | Query, Optional | Power of band_24 |
| `band5Power` | `*int` | Query, Optional | Power of band_5 |
| `band6Power` | `*int` | Query, Optional | Power of band_6 |
| `eth0PortSpeed` | `*int` | Query, Optional | Port speed of eth0 |
| `limit` | `*int` | Query, Optional | **Default**: `100`<br>**Constraints**: `>= 0` |
| `start` | `*int` | Query, Optional | start datetime, can be epoch or relative time like -1d, -1w; -1d if not specified |
Expand Down Expand Up @@ -940,6 +952,8 @@ orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")





ipAddress := "192.168.1.1"


Expand All @@ -959,6 +973,16 @@ ipAddress := "192.168.1.1"
















Expand All @@ -978,7 +1002,7 @@ limit := 100

duration := "10m"

apiResponse, err := orgsDevices.SearchOrgDevices(ctx, orgId, nil, nil, nil, nil, nil, nil, &ipAddress, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, &limit, nil, nil, &duration)
apiResponse, err := orgsDevices.SearchOrgDevices(ctx, orgId, nil, nil, nil, nil, nil, nil, nil, &ipAddress, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, &limit, nil, nil, &duration)
if err != nil {
log.Fatalln(err)
} else {
Expand Down
81 changes: 81 additions & 0 deletions doc/controllers/orgs-licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ orgsLicenses := client.OrgsLicenses()
* [Claim Org License](../../doc/controllers/orgs-licenses.md#claim-org-license)
* [Get Org Licences by Site](../../doc/controllers/orgs-licenses.md#get-org-licences-by-site)
* [Get Org Licences Summary](../../doc/controllers/orgs-licenses.md#get-org-licences-summary)
* [Get Org License Async Claim Status](../../doc/controllers/orgs-licenses.md#get-org-license-async-claim-status)
* [Move or Delete Org License to Another Org](../../doc/controllers/orgs-licenses.md#move-or-delete-org-license-to-another-org)


Expand Down Expand Up @@ -442,6 +443,86 @@ 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) |


# Get Org License Async Claim Status

Get Processing Status for Async Claim

```go
GetOrgLicenseAsyncClaimStatus(
ctx context.Context,
orgId uuid.UUID,
detail *bool) (
models.ApiResponse[models.ResponseAsyncLicense],
error)
```

## Parameters

| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `orgId` | `uuid.UUID` | Template, Required | - |
| `detail` | `*bool` | Query, Optional | request license details |

## Response Type

[`models.ResponseAsyncLicense`](../../doc/models/response-async-license.md)

## Example Usage

```go
ctx := context.Background()

orgId := uuid.MustParse("000000ab-00ab-00ab-00ab-0000000000ab")



apiResponse, err := orgsLicenses.GetOrgLicenseAsyncClaimStatus(ctx, orgId, nil)
if err != nil {
log.Fatalln(err)
} else {
// Printing the result and response
fmt.Println(apiResponse.Data)
fmt.Println(apiResponse.Response.StatusCode)
}
```

## Example Response *(as JSON)*

```json
{
"completed": [
"000000000022",
"000000000011"
],
"details": [
{
"mac": "000000000022",
"status": "added",
"timestamp": 1709598053
}
],
"failed": 0,
"incompleted": [],
"processed": 2,
"scheduled_at": 1709598052,
"status": "done",
"succeed": 2,
"timestamp": 1709598053,
"total": 2
}
```

## 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) |


# Move or Delete Org License to Another Org

Move, Undo Move or Delete Org License to Another Org
Expand Down
Loading

0 comments on commit 53c8ba2

Please sign in to comment.