scottk/wlan-testing
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-testing.git synced 2025-11-02 03:48:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

some library updates with swagger api

Browse Source 
Signed-off-by: shivam <shivam.thakur@candelatech.com>
This commit is contained in:
shivam
2021-03-01 18:26:14 +05:30
parent c3ac261e72
commit a086e5c290
1239 changed files with 136953 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
libs/cloudapi/cloud_utility/cloud_connectivity.py Normal file
View File

@@ -0,0 +1,72 @@
"""
cloud_connectivity.py :
ConnectCloud : <class> has methods to invoke the connections to the cloud constructor
default constructor of ConnectCloud class (args: testbed-name)
get_bearer() : It is called by default from the constructor itself. bearer gets expired in 3000 seconds
refresh_bearer() : It is used to refresh the Connectivity. It can be used for Long test runs
"""
import sys
if "cloudsdk" not in sys.path:
sys.path.append("../cloudsdk")
from swagger_client.api.login_api import LoginApi
from swagger_client.api.equipment_api import EquipmentApi
from swagger_client.api_client import ApiClient
# Testbed name and its respective urls, Modify and add accordingly
cloud_sdk_base_urls = {
"nola-01": "https://wlan-portal-svc-nola-01.cicd.lab.wlan.tip.build",
"nola-02": "https://wlan-portal-svc-nola-02.cicd.lab.wlan.tip.build",
"nola-03": "https://wlan-portal-svc-nola-03.cicd.lab.wlan.tip.build",
"nola-04": "https://wlan-portal-svc-nola-04.cicd.lab.wlan.tip.build",
"nola-05": "https://wlan-portal-svc-nola-05.cicd.lab.wlan.tip.build",
"nola-06": "https://wlan-portal-svc-nola-06.cicd.lab.wlan.tip.build",
"nola-07": "https://wlan-portal-svc-nola-07.cicd.lab.wlan.tip.build",
"nola-08": "https://wlan-portal-svc-nola-08.cicd.lab.wlan.tip.build",
"nola-09": "https://wlan-portal-svc-nola-09.cicd.lab.wlan.tip.build",
"nola-10": "https://wlan-portal-svc-nola-10.cicd.lab.wlan.tip.build",
"nola-11": "https://wlan-portal-svc-nola-11.cicd.lab.wlan.tip.build"
}
login_credentials = {
"userId": "support@example.com",
"password": "support"
}
class cloudsdk:
def __init__(self, testbed="nola-01"):
self.testbed = testbed
self.sdk_base_url = cloud_sdk_base_urls[self.testbed]
self.login_credentials = login_credentials
self.api_client = ApiClient(sdk_base_url=self.sdk_base_url)
self.login_api = LoginApi(api_client=self.api_client)
self.equipment_api = EquipmentApi(api_client=self.api_client)
self.get_or_refresh_bearer()
def get_or_refresh_bearer(self):
bearer = self.login_api.get_access_token(self.login_credentials)
# print(bearer)
return bearer
def get_equipment_by_id(self, customer_id=None):
pagination_context = {
"model_type": "PaginationContext",
"maxItemsPerPage": 10
}
return self.equipment_api.get_equipment_by_customer_id(customer_id=customer_id, pagination_context=pagination_context)
def main():
cloudsdk()
if __name__ == "__main__":
main()

84
libs/cloudapi/cloud_utility/cloudapi.py Normal file
View File

@@ -0,0 +1,84 @@
#!/usr/bin/python3
import requests
class CloudAPI:
def __init__(self,
cloud_credentials,
testbed_urls,
target_testbed,
equipment_ids=None,
target_model="ecw5410"):
self.user = cloud_credentials["user"]
self.password = cloud_credentials["password"]
self.cloudSDK_url = testbed_urls[target_testbed]["url"]
self.cloud_type = "v1"
self.bearer = self.get_bearer_token(cloud_type=self.cloud_type)
pass
def get_bearer_token(self, cloud_type="v1"):
cloud_login_url = self.cloudSDK_url + "/management/" + cloud_type + "/oauth2/token"
payload = '''
{
"userId": "''' + self.user + '''",
"password": "''' + self.password + '''"
}
'''
headers = {
'Content-Type': 'application/json'
}
try:
token_response = requests.request("POST", cloud_login_url, headers=headers, data=payload)
self.check_response("POST", token_response, headers, payload, cloud_login_url)
except requests.exceptions.RequestException as e:
raise SystemExit("Exiting Script! Cloud not get bearer token for reason:", e)
token_data = token_response.json()
bearer_token = token_data['access_token']
return bearer_token
def refresh_bearer_token(self):
self.bearer = self.get_bearer_token(cloud_type=self.cloud_type)
def check_response(self, cmd, response, headers, data_str, url):
if response.status_code >= 500:
if response.status_code >= 500:
print("check-response: ERROR, url: ", url)
else:
print("check-response: url: ", url)
print("Command: ", cmd)
print("response-status: ", response.status_code)
print("response-headers: ", response.headers)
print("response-content: ", response.content)
print("headers: ", headers)
print("data-str: ", data_str)
if response.status_code >= 500:
if self.assert_bad_response:
raise NameError("Invalid response code.")
return False
return True
def get_equipment(self, equipment_id):
request_data = {
"equipmentType": "AP",
"customerId": 2,
"profileId": 1,
"locationId": 2,
"inventoryId": "example_ap",
"serial": "example_serial",
"name": "example AP"
}
equipment_data = {
"equipmentType": "AP",
"customerId": 2,
"profileId": 1,
"locationId": 2,
"inventoryId": "example_ap",
"serial": "example_serial",
"name": "example AP"
}
url = self.cloudSDK_url + "/portal/equipment/forCustomer" + "?customerId=" + customer_id
return self.get_paged_url(self.bearer, url)
pass

22
libs/cloudapi/cloud_utility/equipment_utility.py Normal file
View File

@@ -0,0 +1,22 @@
"""
cloud_connectivity.py :
ConnectCloud : <class> has methods to invoke the connections to the cloud constructor
default constructor of ConnectCloud class (args: testbed-name)
get_bearer() : It is called by default from the constructor itself. bearer gets expired in 3000 seconds
refresh_bearer() : It is used to refresh the Connectivity. It can be used for Long test runs
"""
import sys
if "cloudsdk" not in sys.path:
sys.path.append("../cloudsdk")
from swagger_client.api.login_api import LoginApi
class EquipmentUtility:
def __init__(self, sdk_base_url=None, bearer=None):
self.sdk_base_url = sdk_base_url
self.bearer = bearer

64
libs/cloudapi/cloudsdk/.gitignore vendored Normal file
View File

@@ -0,0 +1,64 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
venv/
.python-version
# Translations
*.mo
*.pot
# Django stuff:
*.log
# Sphinx documentation
docs/_build/
# PyBuilder
target/
#Ipython Notebook
.ipynb_checkpoints

8
libs/cloudapi/cloudsdk/.idea/ cloudsdk.iml generated Normal file
View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$" />
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

12
libs/cloudapi/cloudsdk/.idea/inspectionProfiles/Project_Default.xml generated Normal file
View File

@@ -0,0 +1,12 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="PyPep8Inspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
<option name="ignoredErrors">
<list>
<option value="E201" />
</list>
</option>
</inspection_tool>
</profile>
</component>

6
libs/cloudapi/cloudsdk/.idea/inspectionProfiles/profiles_settings.xml generated Normal file
View File

@@ -0,0 +1,6 @@
<component name="InspectionProjectProfileManager">
<settings>
<option name="USE_PROJECT_PROFILE" value="false" />
<version value="1.0" />
</settings>
</component>

8
libs/cloudapi/cloudsdk/.idea/modules.xml generated Normal file
View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/ cloudsdk.iml" filepath="$PROJECT_DIR$/.idea/ cloudsdk.iml" />
</modules>
</component>
</project>

28
libs/cloudapi/cloudsdk/.idea/workspace.xml generated Normal file
View File

@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ChangeListManager">
<list default="true" id="3481de78-cc74-4f8a-a52b-7354fe799ef4" name="Default Changelist" comment="" />
<option name="SHOW_DIALOG" value="false" />
<option name="HIGHLIGHT_CONFLICTS" value="true" />
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
<option name="LAST_RESOLUTION" value="IGNORE" />
</component>
<component name="ProjectId" id="1p97Ky8bfqt51AQSsVLLb6I8BpM" />
<component name="ProjectViewState">
<option name="hideEmptyMiddlePackages" value="true" />
<option name="showLibraryContents" value="true" />
</component>
<component name="PropertiesComponent">
<property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
</component>
<component name="TaskManager">
<task active="true" id="Default" summary="Default task">
<changelist id="3481de78-cc74-4f8a-a52b-7354fe799ef4" name="Default Changelist" comment="" />
<created>1614583394565</created>
<option name="number" value="Default" />
<option name="presentableId" value="Default" />
<updated>1614583394565</updated>
</task>
<servers />
</component>
</project>

23
libs/cloudapi/cloudsdk/.swagger-codegen-ignore Normal file
View File

@@ -0,0 +1,23 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

1
libs/cloudapi/cloudsdk/.swagger-codegen/VERSION Normal file
View File

@@ -0,0 +1 @@
3.0.24

13
libs/cloudapi/cloudsdk/.travis.yml Normal file
View File

@@ -0,0 +1,13 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.2"
- "3.3"
- "3.4"
- "3.5"
#- "3.5-dev" # 3.5 development branch
#- "nightly" # points to the latest development branch e.g. 3.6-dev
# command to install dependencies
install: "pip install -r requirements.txt"
# command to run tests
script: nosetests

647
libs/cloudapi/cloudsdk/README.md Normal file
View File

@@ -0,0 +1,647 @@
# swagger-client
APIs that provide services for provisioning, monitoring, and history retrieval of various data elements of CloudSDK.
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import swagger_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import swagger_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int |
equipment_id = 789 # int |
alarm_code = swagger_client.AlarmCode() # AlarmCode |
created_timestamp = 789 # int |
try:
# Delete Alarm
api_response = api_instance.delete_alarm(customer_id, equipment_id, alarm_code, created_timestamp)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->delete_alarm: %s\n" % e)
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
equipment_ids = [56] # list[int] | Set of equipment ids. Empty or null means retrieve for all equipment for the customer. (optional)
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
try:
# Get counts of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
api_response = api_instance.get_alarm_counts(customer_id, equipment_ids=equipment_ids, alarm_codes=alarm_codes)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarm_counts: %s\n" % e)
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
pagination_context = swagger_client.PaginationContextAlarm() # PaginationContextAlarm | pagination context
equipment_ids = [56] # list[int] | Set of equipment ids. Empty or null means retrieve all equipment for the customer. (optional)
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
created_after_timestamp = -1 # int | retrieve alarms created after the specified time (optional) (default to -1)
sort_by = [swagger_client.SortColumnsAlarm()] # list[SortColumnsAlarm] | sort options (optional)
try:
# Get list of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
api_response = api_instance.get_alarmsfor_customer(customer_id, pagination_context, equipment_ids=equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp, sort_by=sort_by)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarmsfor_customer: %s\n" % e)
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
equipment_ids = [56] # list[int] | Set of equipment ids. Must not be empty.
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
created_after_timestamp = -1 # int | retrieve alarms created after the specified time (optional) (default to -1)
try:
# Get list of Alarms for customerId, set of equipment ids, and set of alarm codes.
api_response = api_instance.get_alarmsfor_equipment(customer_id, equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarmsfor_equipment: %s\n" % e)
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
try:
# Reset accumulated counts of Alarms.
api_response = api_instance.reset_alarm_counts()
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->reset_alarm_counts: %s\n" % e)
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
body = swagger_client.Alarm() # Alarm | Alarm info
try:
# Update Alarm
api_response = api_instance.update_alarm(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->update_alarm: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://localhost:9091*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlarmsApi* | [**delete_alarm**](docs/AlarmsApi.md#delete_alarm) | **DELETE** /portal/alarm | Delete Alarm
*AlarmsApi* | [**get_alarm_counts**](docs/AlarmsApi.md#get_alarm_counts) | **GET** /portal/alarm/counts | Get counts of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
*AlarmsApi* | [**get_alarmsfor_customer**](docs/AlarmsApi.md#get_alarmsfor_customer) | **GET** /portal/alarm/forCustomer | Get list of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
*AlarmsApi* | [**get_alarmsfor_equipment**](docs/AlarmsApi.md#get_alarmsfor_equipment) | **GET** /portal/alarm/forEquipment | Get list of Alarms for customerId, set of equipment ids, and set of alarm codes.
*AlarmsApi* | [**reset_alarm_counts**](docs/AlarmsApi.md#reset_alarm_counts) | **POST** /portal/alarm/resetCounts | Reset accumulated counts of Alarms.
*AlarmsApi* | [**update_alarm**](docs/AlarmsApi.md#update_alarm) | **PUT** /portal/alarm | Update Alarm
*ClientsApi* | [**get_all_client_sessions_in_set**](docs/ClientsApi.md#get_all_client_sessions_in_set) | **GET** /portal/client/session/inSet | Get list of Client sessions for customerId and a set of client MAC addresses.
*ClientsApi* | [**get_all_clients_in_set**](docs/ClientsApi.md#get_all_clients_in_set) | **GET** /portal/client/inSet | Get list of Clients for customerId and a set of client MAC addresses.
*ClientsApi* | [**get_blocked_clients**](docs/ClientsApi.md#get_blocked_clients) | **GET** /portal/client/blocked | Retrieves a list of Clients for the customer that are marked as blocked. This per-customer list of blocked clients is pushed to every AP, so it has to be limited in size.
*ClientsApi* | [**get_client_session_by_customer_with_filter**](docs/ClientsApi.md#get_client_session_by_customer_with_filter) | **GET** /portal/client/session/forCustomer | Get list of Client sessions for customerId and a set of equipment/location ids. Equipment and locations filters are joined using logical AND operation.
*ClientsApi* | [**get_for_customer**](docs/ClientsApi.md#get_for_customer) | **GET** /portal/client/forCustomer | Get list of clients for a given customer by equipment ids
*ClientsApi* | [**search_by_mac_address**](docs/ClientsApi.md#search_by_mac_address) | **GET** /portal/client/searchByMac | Get list of Clients for customerId and searching by macSubstring.
*ClientsApi* | [**update_client**](docs/ClientsApi.md#update_client) | **PUT** /portal/client | Update Client
*CustomerApi* | [**get_customer_by_id**](docs/CustomerApi.md#get_customer_by_id) | **GET** /portal/customer | Get Customer By Id
*CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /portal/customer | Update Customer
*EquipmentApi* | [**create_equipment**](docs/EquipmentApi.md#create_equipment) | **POST** /portal/equipment | Create new Equipment
*EquipmentApi* | [**delete_equipment**](docs/EquipmentApi.md#delete_equipment) | **DELETE** /portal/equipment | Delete Equipment
*EquipmentApi* | [**get_default_equipment_details**](docs/EquipmentApi.md#get_default_equipment_details) | **GET** /portal/equipment/defaultDetails | Get default values for Equipment details for a specific equipment type
*EquipmentApi* | [**get_equipment_by_customer_id**](docs/EquipmentApi.md#get_equipment_by_customer_id) | **GET** /portal/equipment/forCustomer | Get Equipment By customerId
*EquipmentApi* | [**get_equipment_by_customer_with_filter**](docs/EquipmentApi.md#get_equipment_by_customer_with_filter) | **GET** /portal/equipment/forCustomerWithFilter | Get Equipment for customerId, equipment type, and location id
*EquipmentApi* | [**get_equipment_by_id**](docs/EquipmentApi.md#get_equipment_by_id) | **GET** /portal/equipment | Get Equipment By Id
*EquipmentApi* | [**get_equipment_by_set_of_ids**](docs/EquipmentApi.md#get_equipment_by_set_of_ids) | **GET** /portal/equipment/inSet | Get Equipment By a set of ids
*EquipmentApi* | [**update_equipment**](docs/EquipmentApi.md#update_equipment) | **PUT** /portal/equipment | Update Equipment
*EquipmentApi* | [**update_equipment_rrm_bulk**](docs/EquipmentApi.md#update_equipment_rrm_bulk) | **PUT** /portal/equipment/rrmBulk | Update RRM related properties of Equipment in bulk
*EquipmentGatewayApi* | [**request_ap_factory_reset**](docs/EquipmentGatewayApi.md#request_ap_factory_reset) | **POST** /portal/equipmentGateway/requestApFactoryReset | Request factory reset for a particular equipment.
*EquipmentGatewayApi* | [**request_ap_reboot**](docs/EquipmentGatewayApi.md#request_ap_reboot) | **POST** /portal/equipmentGateway/requestApReboot | Request reboot for a particular equipment.
*EquipmentGatewayApi* | [**request_ap_switch_software_bank**](docs/EquipmentGatewayApi.md#request_ap_switch_software_bank) | **POST** /portal/equipmentGateway/requestApSwitchSoftwareBank | Request switch of active/inactive sw bank for a particular equipment.
*EquipmentGatewayApi* | [**request_channel_change**](docs/EquipmentGatewayApi.md#request_channel_change) | **POST** /portal/equipmentGateway/requestChannelChange | Request change of primary and/or backup channels for given frequency bands.
*EquipmentGatewayApi* | [**request_firmware_update**](docs/EquipmentGatewayApi.md#request_firmware_update) | **POST** /portal/equipmentGateway/requestFirmwareUpdate | Request firmware update for a particular equipment.
*FileServicesApi* | [**download_binary_file**](docs/FileServicesApi.md#download_binary_file) | **GET** /filestore/{fileName} | Download binary file.
*FileServicesApi* | [**upload_binary_file**](docs/FileServicesApi.md#upload_binary_file) | **POST** /filestore/{fileName} | Upload binary file.
*FirmwareManagementApi* | [**create_customer_firmware_track_record**](docs/FirmwareManagementApi.md#create_customer_firmware_track_record) | **POST** /portal/firmware/customerTrack | Create new CustomerFirmwareTrackRecord
*FirmwareManagementApi* | [**create_firmware_track_record**](docs/FirmwareManagementApi.md#create_firmware_track_record) | **POST** /portal/firmware/track | Create new FirmwareTrackRecord
*FirmwareManagementApi* | [**create_firmware_version**](docs/FirmwareManagementApi.md#create_firmware_version) | **POST** /portal/firmware/version | Create new FirmwareVersion
*FirmwareManagementApi* | [**delete_customer_firmware_track_record**](docs/FirmwareManagementApi.md#delete_customer_firmware_track_record) | **DELETE** /portal/firmware/customerTrack | Delete CustomerFirmwareTrackRecord
*FirmwareManagementApi* | [**delete_firmware_track_assignment**](docs/FirmwareManagementApi.md#delete_firmware_track_assignment) | **DELETE** /portal/firmware/trackAssignment | Delete FirmwareTrackAssignment
*FirmwareManagementApi* | [**delete_firmware_track_record**](docs/FirmwareManagementApi.md#delete_firmware_track_record) | **DELETE** /portal/firmware/track | Delete FirmwareTrackRecord
*FirmwareManagementApi* | [**delete_firmware_version**](docs/FirmwareManagementApi.md#delete_firmware_version) | **DELETE** /portal/firmware/version | Delete FirmwareVersion
*FirmwareManagementApi* | [**get_customer_firmware_track_record**](docs/FirmwareManagementApi.md#get_customer_firmware_track_record) | **GET** /portal/firmware/customerTrack | Get CustomerFirmwareTrackRecord By customerId
*FirmwareManagementApi* | [**get_default_customer_track_setting**](docs/FirmwareManagementApi.md#get_default_customer_track_setting) | **GET** /portal/firmware/customerTrack/default | Get default settings for handling automatic firmware upgrades
*FirmwareManagementApi* | [**get_firmware_model_ids_by_equipment_type**](docs/FirmwareManagementApi.md#get_firmware_model_ids_by_equipment_type) | **GET** /portal/firmware/model/byEquipmentType | Get equipment models from all known firmware versions filtered by equipmentType
*FirmwareManagementApi* | [**get_firmware_track_assignment_details**](docs/FirmwareManagementApi.md#get_firmware_track_assignment_details) | **GET** /portal/firmware/trackAssignment | Get FirmwareTrackAssignmentDetails for a given firmware track name
*FirmwareManagementApi* | [**get_firmware_track_record**](docs/FirmwareManagementApi.md#get_firmware_track_record) | **GET** /portal/firmware/track | Get FirmwareTrackRecord By Id
*FirmwareManagementApi* | [**get_firmware_track_record_by_name**](docs/FirmwareManagementApi.md#get_firmware_track_record_by_name) | **GET** /portal/firmware/track/byName | Get FirmwareTrackRecord By name
*FirmwareManagementApi* | [**get_firmware_version**](docs/FirmwareManagementApi.md#get_firmware_version) | **GET** /portal/firmware/version | Get FirmwareVersion By Id
*FirmwareManagementApi* | [**get_firmware_version_by_equipment_type**](docs/FirmwareManagementApi.md#get_firmware_version_by_equipment_type) | **GET** /portal/firmware/version/byEquipmentType | Get FirmwareVersions filtered by equipmentType and optional equipment model
*FirmwareManagementApi* | [**get_firmware_version_by_name**](docs/FirmwareManagementApi.md#get_firmware_version_by_name) | **GET** /portal/firmware/version/byName | Get FirmwareVersion By name
*FirmwareManagementApi* | [**update_customer_firmware_track_record**](docs/FirmwareManagementApi.md#update_customer_firmware_track_record) | **PUT** /portal/firmware/customerTrack | Update CustomerFirmwareTrackRecord
*FirmwareManagementApi* | [**update_firmware_track_assignment_details**](docs/FirmwareManagementApi.md#update_firmware_track_assignment_details) | **PUT** /portal/firmware/trackAssignment | Update FirmwareTrackAssignmentDetails
*FirmwareManagementApi* | [**update_firmware_track_record**](docs/FirmwareManagementApi.md#update_firmware_track_record) | **PUT** /portal/firmware/track | Update FirmwareTrackRecord
*FirmwareManagementApi* | [**update_firmware_version**](docs/FirmwareManagementApi.md#update_firmware_version) | **PUT** /portal/firmware/version | Update FirmwareVersion
*LocationApi* | [**create_location**](docs/LocationApi.md#create_location) | **POST** /portal/location | Create new Location
*LocationApi* | [**delete_location**](docs/LocationApi.md#delete_location) | **DELETE** /portal/location | Delete Location
*LocationApi* | [**get_location_by_id**](docs/LocationApi.md#get_location_by_id) | **GET** /portal/location | Get Location By Id
*LocationApi* | [**get_location_by_set_of_ids**](docs/LocationApi.md#get_location_by_set_of_ids) | **GET** /portal/location/inSet | Get Locations By a set of ids
*LocationApi* | [**get_locations_by_customer_id**](docs/LocationApi.md#get_locations_by_customer_id) | **GET** /portal/location/forCustomer | Get Locations By customerId
*LocationApi* | [**update_location**](docs/LocationApi.md#update_location) | **PUT** /portal/location | Update Location
*LoginApi* | [**get_access_token**](docs/LoginApi.md#get_access_token) | **POST** /management/v1/oauth2/token | Get access token - to be used as Bearer token header for all other API requests.
*LoginApi* | [**portal_ping**](docs/LoginApi.md#portal_ping) | **GET** /ping | Portal proces version info.
*ManufacturerOUIApi* | [**create_manufacturer_details_record**](docs/ManufacturerOUIApi.md#create_manufacturer_details_record) | **POST** /portal/manufacturer | Create new ManufacturerDetailsRecord
*ManufacturerOUIApi* | [**create_manufacturer_oui_details**](docs/ManufacturerOUIApi.md#create_manufacturer_oui_details) | **POST** /portal/manufacturer/oui | Create new ManufacturerOuiDetails
*ManufacturerOUIApi* | [**delete_manufacturer_details_record**](docs/ManufacturerOUIApi.md#delete_manufacturer_details_record) | **DELETE** /portal/manufacturer | Delete ManufacturerDetailsRecord
*ManufacturerOUIApi* | [**delete_manufacturer_oui_details**](docs/ManufacturerOUIApi.md#delete_manufacturer_oui_details) | **DELETE** /portal/manufacturer/oui | Delete ManufacturerOuiDetails
*ManufacturerOUIApi* | [**get_alias_values_that_begin_with**](docs/ManufacturerOUIApi.md#get_alias_values_that_begin_with) | **GET** /portal/manufacturer/oui/alias | Get manufacturer aliases that begin with the given prefix
*ManufacturerOUIApi* | [**get_all_manufacturer_oui_details**](docs/ManufacturerOUIApi.md#get_all_manufacturer_oui_details) | **GET** /portal/manufacturer/oui/all | Get all ManufacturerOuiDetails
*ManufacturerOUIApi* | [**get_manufacturer_details_for_oui_list**](docs/ManufacturerOUIApi.md#get_manufacturer_details_for_oui_list) | **GET** /portal/manufacturer/oui/list | Get ManufacturerOuiDetails for the list of OUIs
*ManufacturerOUIApi* | [**get_manufacturer_details_record**](docs/ManufacturerOUIApi.md#get_manufacturer_details_record) | **GET** /portal/manufacturer | Get ManufacturerDetailsRecord By id
*ManufacturerOUIApi* | [**get_manufacturer_oui_details_by_oui**](docs/ManufacturerOUIApi.md#get_manufacturer_oui_details_by_oui) | **GET** /portal/manufacturer/oui | Get ManufacturerOuiDetails By oui
*ManufacturerOUIApi* | [**get_oui_list_for_manufacturer**](docs/ManufacturerOUIApi.md#get_oui_list_for_manufacturer) | **GET** /portal/manufacturer/oui/forManufacturer | Get Oui List for manufacturer
*ManufacturerOUIApi* | [**update_manufacturer_details_record**](docs/ManufacturerOUIApi.md#update_manufacturer_details_record) | **PUT** /portal/manufacturer | Update ManufacturerDetailsRecord
*ManufacturerOUIApi* | [**update_oui_alias**](docs/ManufacturerOUIApi.md#update_oui_alias) | **PUT** /portal/manufacturer/oui/alias | Update alias for ManufacturerOuiDetails
*ManufacturerOUIApi* | [**upload_oui_data_file**](docs/ManufacturerOUIApi.md#upload_oui_data_file) | **POST** /portal/manufacturer/oui/upload | Upload the gziped OUI DataFile, in the format that is published by IEEE. Latest sanitized IEEE OUI data file (oui.txt.gz) can be obtained from https://linuxnet.ca/ieee/oui/
*ManufacturerOUIApi* | [**upload_oui_data_file_base64**](docs/ManufacturerOUIApi.md#upload_oui_data_file_base64) | **POST** /portal/manufacturer/oui/upload/base64 | Upload the gziped OUI DataFile using base64 encoding, in the format that is published by IEEE. Latest sanitized IEEE OUI data file (oui.txt.gz) can be obtained from https://linuxnet.ca/ieee/oui/
*PortalUsersApi* | [**create_portal_user**](docs/PortalUsersApi.md#create_portal_user) | **POST** /portal/portalUser | Create new Portal User
*PortalUsersApi* | [**delete_portal_user**](docs/PortalUsersApi.md#delete_portal_user) | **DELETE** /portal/portalUser | Delete PortalUser
*PortalUsersApi* | [**get_portal_user_by_id**](docs/PortalUsersApi.md#get_portal_user_by_id) | **GET** /portal/portalUser | Get portal user By Id
*PortalUsersApi* | [**get_portal_user_by_username**](docs/PortalUsersApi.md#get_portal_user_by_username) | **GET** /portal/portalUser/byUsernameOrNull | Get portal user by user name
*PortalUsersApi* | [**get_portal_users_by_customer_id**](docs/PortalUsersApi.md#get_portal_users_by_customer_id) | **GET** /portal/portalUser/forCustomer | Get PortalUsers By customerId
*PortalUsersApi* | [**get_portal_users_by_set_of_ids**](docs/PortalUsersApi.md#get_portal_users_by_set_of_ids) | **GET** /portal/portalUser/inSet | Get PortalUsers By a set of ids
*PortalUsersApi* | [**get_users_for_username**](docs/PortalUsersApi.md#get_users_for_username) | **GET** /portal/portalUser/usersForUsername | Get Portal Users for username
*PortalUsersApi* | [**update_portal_user**](docs/PortalUsersApi.md#update_portal_user) | **PUT** /portal/portalUser | Update PortalUser
*ProfileApi* | [**create_profile**](docs/ProfileApi.md#create_profile) | **POST** /portal/profile | Create new Profile
*ProfileApi* | [**delete_profile**](docs/ProfileApi.md#delete_profile) | **DELETE** /portal/profile | Delete Profile
*ProfileApi* | [**get_counts_of_equipment_that_use_profiles**](docs/ProfileApi.md#get_counts_of_equipment_that_use_profiles) | **GET** /portal/profile/equipmentCounts | Get counts of equipment that use specified profiles
*ProfileApi* | [**get_profile_by_id**](docs/ProfileApi.md#get_profile_by_id) | **GET** /portal/profile | Get Profile By Id
*ProfileApi* | [**get_profile_with_children**](docs/ProfileApi.md#get_profile_with_children) | **GET** /portal/profile/withChildren | Get Profile and all its associated children
*ProfileApi* | [**get_profiles_by_customer_id**](docs/ProfileApi.md#get_profiles_by_customer_id) | **GET** /portal/profile/forCustomer | Get Profiles By customerId
*ProfileApi* | [**get_profiles_by_set_of_ids**](docs/ProfileApi.md#get_profiles_by_set_of_ids) | **GET** /portal/profile/inSet | Get Profiles By a set of ids
*ProfileApi* | [**update_profile**](docs/ProfileApi.md#update_profile) | **PUT** /portal/profile | Update Profile
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_all_per_day**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_all_per_day) | **GET** /portal/adoptionMetrics/allPerDay | Get daily service adoption metrics for a given year
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_all_per_month**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_all_per_month) | **GET** /portal/adoptionMetrics/allPerMonth | Get monthly service adoption metrics for a given year
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_all_per_week**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_all_per_week) | **GET** /portal/adoptionMetrics/allPerWeek | Get weekly service adoption metrics for a given year
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_per_customer_per_day**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_per_customer_per_day) | **GET** /portal/adoptionMetrics/perCustomerPerDay | Get daily service adoption metrics for a given year aggregated by customer and filtered by specified customer ids
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_per_equipment_per_day**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_per_equipment_per_day) | **GET** /portal/adoptionMetrics/perEquipmentPerDay | Get daily service adoption metrics for a given year filtered by specified equipment ids
*ServiceAdoptionMetricsApi* | [**get_adoption_metrics_per_location_per_day**](docs/ServiceAdoptionMetricsApi.md#get_adoption_metrics_per_location_per_day) | **GET** /portal/adoptionMetrics/perLocationPerDay | Get daily service adoption metrics for a given year aggregated by location and filtered by specified location ids
*StatusApi* | [**get_status_by_customer_equipment**](docs/StatusApi.md#get_status_by_customer_equipment) | **GET** /portal/status/forEquipment | Get all Status objects for a given customer equipment.
*StatusApi* | [**get_status_by_customer_equipment_with_filter**](docs/StatusApi.md#get_status_by_customer_equipment_with_filter) | **GET** /portal/status/forEquipmentWithFilter | Get Status objects for a given customer equipment ids and status data types.
*StatusApi* | [**get_status_by_customer_id**](docs/StatusApi.md#get_status_by_customer_id) | **GET** /portal/status/forCustomer | Get all Status objects By customerId
*StatusApi* | [**get_status_by_customer_with_filter**](docs/StatusApi.md#get_status_by_customer_with_filter) | **GET** /portal/status/forCustomerWithFilter | Get list of Statuses for customerId, set of equipment ids, and set of status data types.
*SystemEventsApi* | [**get_system_eventsfor_customer**](docs/SystemEventsApi.md#get_system_eventsfor_customer) | **GET** /portal/systemEvent/forCustomer | Get list of System Events for customerId, optional set of equipment ids, and optional set of data types. Only events that are created between specified fromTime and toTime are retrieved.
*WLANServiceMetricsApi* | [**get_service_metricsfor_customer**](docs/WLANServiceMetricsApi.md#get_service_metricsfor_customer) | **GET** /portal/serviceMetric/forCustomer | Get list of WLAN Service Metrics for customerId, optional set of location ids, optional set of equipment ids, optional set of client MAC addresses, optional set of metric data types. Only metrics that are created between specified fromTime and toTime are retrieved.
## Documentation For Models
- [AclTemplate](docs/AclTemplate.md)
- [ActiveBSSID](docs/ActiveBSSID.md)
- [ActiveBSSIDs](docs/ActiveBSSIDs.md)
- [ActiveScanSettings](docs/ActiveScanSettings.md)
- [AdvancedRadioMap](docs/AdvancedRadioMap.md)
- [Alarm](docs/Alarm.md)
- [AlarmAddedEvent](docs/AlarmAddedEvent.md)
- [AlarmChangedEvent](docs/AlarmChangedEvent.md)
- [AlarmCode](docs/AlarmCode.md)
- [AlarmCounts](docs/AlarmCounts.md)
- [AlarmDetails](docs/AlarmDetails.md)
- [AlarmDetailsAttributesMap](docs/AlarmDetailsAttributesMap.md)
- [AlarmRemovedEvent](docs/AlarmRemovedEvent.md)
- [AlarmScopeType](docs/AlarmScopeType.md)
- [AntennaType](docs/AntennaType.md)
- [ApElementConfiguration](docs/ApElementConfiguration.md)
- [ApMeshMode](docs/ApMeshMode.md)
- [ApNetworkConfiguration](docs/ApNetworkConfiguration.md)
- [ApNetworkConfigurationNtpServer](docs/ApNetworkConfigurationNtpServer.md)
- [ApNodeMetrics](docs/ApNodeMetrics.md)
- [ApPerformance](docs/ApPerformance.md)
- [ApSsidMetrics](docs/ApSsidMetrics.md)
- [AutoOrManualString](docs/AutoOrManualString.md)
- [AutoOrManualValue](docs/AutoOrManualValue.md)
- [BackgroundPosition](docs/BackgroundPosition.md)
- [BackgroundRepeat](docs/BackgroundRepeat.md)
- [BannedChannel](docs/BannedChannel.md)
- [BaseDhcpEvent](docs/BaseDhcpEvent.md)
- [BestAPSteerType](docs/BestAPSteerType.md)
- [BlocklistDetails](docs/BlocklistDetails.md)
- [BonjourGatewayProfile](docs/BonjourGatewayProfile.md)
- [BonjourServiceSet](docs/BonjourServiceSet.md)
- [CapacityDetails](docs/CapacityDetails.md)
- [CapacityPerRadioDetails](docs/CapacityPerRadioDetails.md)
- [CapacityPerRadioDetailsMap](docs/CapacityPerRadioDetailsMap.md)
- [CaptivePortalAuthenticationType](docs/CaptivePortalAuthenticationType.md)
- [CaptivePortalConfiguration](docs/CaptivePortalConfiguration.md)
- [ChannelBandwidth](docs/ChannelBandwidth.md)
- [ChannelHopReason](docs/ChannelHopReason.md)
- [ChannelHopSettings](docs/ChannelHopSettings.md)
- [ChannelInfo](docs/ChannelInfo.md)
- [ChannelInfoReports](docs/ChannelInfoReports.md)
- [ChannelPowerLevel](docs/ChannelPowerLevel.md)
- [ChannelUtilizationDetails](docs/ChannelUtilizationDetails.md)
- [ChannelUtilizationPerRadioDetails](docs/ChannelUtilizationPerRadioDetails.md)
- [ChannelUtilizationPerRadioDetailsMap](docs/ChannelUtilizationPerRadioDetailsMap.md)
- [ChannelUtilizationSurveyType](docs/ChannelUtilizationSurveyType.md)
- [Client](docs/Client.md)
- [ClientActivityAggregatedStats](docs/ClientActivityAggregatedStats.md)
- [ClientActivityAggregatedStatsPerRadioTypeMap](docs/ClientActivityAggregatedStatsPerRadioTypeMap.md)
- [ClientAddedEvent](docs/ClientAddedEvent.md)
- [ClientAssocEvent](docs/ClientAssocEvent.md)
- [ClientAuthEvent](docs/ClientAuthEvent.md)
- [ClientChangedEvent](docs/ClientChangedEvent.md)
- [ClientConnectSuccessEvent](docs/ClientConnectSuccessEvent.md)
- [ClientConnectionDetails](docs/ClientConnectionDetails.md)
- [ClientDhcpDetails](docs/ClientDhcpDetails.md)
- [ClientDisconnectEvent](docs/ClientDisconnectEvent.md)
- [ClientEapDetails](docs/ClientEapDetails.md)
- [ClientFailureDetails](docs/ClientFailureDetails.md)
- [ClientFailureEvent](docs/ClientFailureEvent.md)
- [ClientFirstDataEvent](docs/ClientFirstDataEvent.md)
- [ClientIdEvent](docs/ClientIdEvent.md)
- [ClientInfoDetails](docs/ClientInfoDetails.md)
- [ClientIpAddressEvent](docs/ClientIpAddressEvent.md)
- [ClientMetrics](docs/ClientMetrics.md)
- [ClientRemovedEvent](docs/ClientRemovedEvent.md)
- [ClientSession](docs/ClientSession.md)
- [ClientSessionChangedEvent](docs/ClientSessionChangedEvent.md)
- [ClientSessionDetails](docs/ClientSessionDetails.md)
- [ClientSessionMetricDetails](docs/ClientSessionMetricDetails.md)
- [ClientSessionRemovedEvent](docs/ClientSessionRemovedEvent.md)
- [ClientTimeoutEvent](docs/ClientTimeoutEvent.md)
- [ClientTimeoutReason](docs/ClientTimeoutReason.md)
- [CommonProbeDetails](docs/CommonProbeDetails.md)
- [CountryCode](docs/CountryCode.md)
- [CountsPerAlarmCodeMap](docs/CountsPerAlarmCodeMap.md)
- [CountsPerEquipmentIdPerAlarmCodeMap](docs/CountsPerEquipmentIdPerAlarmCodeMap.md)
- [Customer](docs/Customer.md)
- [CustomerAddedEvent](docs/CustomerAddedEvent.md)
- [CustomerChangedEvent](docs/CustomerChangedEvent.md)
- [CustomerDetails](docs/CustomerDetails.md)
- [CustomerFirmwareTrackRecord](docs/CustomerFirmwareTrackRecord.md)
- [CustomerFirmwareTrackSettings](docs/CustomerFirmwareTrackSettings.md)
- [CustomerPortalDashboardStatus](docs/CustomerPortalDashboardStatus.md)
- [CustomerRemovedEvent](docs/CustomerRemovedEvent.md)
- [DailyTimeRangeSchedule](docs/DailyTimeRangeSchedule.md)
- [DayOfWeek](docs/DayOfWeek.md)
- [DaysOfWeekTimeRangeSchedule](docs/DaysOfWeekTimeRangeSchedule.md)
- [DeploymentType](docs/DeploymentType.md)
- [DetectedAuthMode](docs/DetectedAuthMode.md)
- [DeviceMode](docs/DeviceMode.md)
- [DhcpAckEvent](docs/DhcpAckEvent.md)
- [DhcpDeclineEvent](docs/DhcpDeclineEvent.md)
- [DhcpDiscoverEvent](docs/DhcpDiscoverEvent.md)
- [DhcpInformEvent](docs/DhcpInformEvent.md)
- [DhcpNakEvent](docs/DhcpNakEvent.md)
- [DhcpOfferEvent](docs/DhcpOfferEvent.md)
- [DhcpRequestEvent](docs/DhcpRequestEvent.md)
- [DisconnectFrameType](docs/DisconnectFrameType.md)
- [DisconnectInitiator](docs/DisconnectInitiator.md)
- [DnsProbeMetric](docs/DnsProbeMetric.md)
- [DynamicVlanMode](docs/DynamicVlanMode.md)
- [ElementRadioConfiguration](docs/ElementRadioConfiguration.md)
- [ElementRadioConfigurationEirpTxPower](docs/ElementRadioConfigurationEirpTxPower.md)
- [EmptySchedule](docs/EmptySchedule.md)
- [Equipment](docs/Equipment.md)
- [EquipmentAddedEvent](docs/EquipmentAddedEvent.md)
- [EquipmentAdminStatusData](docs/EquipmentAdminStatusData.md)
- [EquipmentAutoProvisioningSettings](docs/EquipmentAutoProvisioningSettings.md)
- [EquipmentCapacityDetails](docs/EquipmentCapacityDetails.md)
- [EquipmentCapacityDetailsMap](docs/EquipmentCapacityDetailsMap.md)
- [EquipmentChangedEvent](docs/EquipmentChangedEvent.md)
- [EquipmentDetails](docs/EquipmentDetails.md)
- [EquipmentGatewayRecord](docs/EquipmentGatewayRecord.md)
- [EquipmentLANStatusData](docs/EquipmentLANStatusData.md)
- [EquipmentNeighbouringStatusData](docs/EquipmentNeighbouringStatusData.md)
- [EquipmentPeerStatusData](docs/EquipmentPeerStatusData.md)
- [EquipmentPerRadioUtilizationDetails](docs/EquipmentPerRadioUtilizationDetails.md)
- [EquipmentPerRadioUtilizationDetailsMap](docs/EquipmentPerRadioUtilizationDetailsMap.md)
- [EquipmentPerformanceDetails](docs/EquipmentPerformanceDetails.md)
- [EquipmentProtocolState](docs/EquipmentProtocolState.md)
- [EquipmentProtocolStatusData](docs/EquipmentProtocolStatusData.md)
- [EquipmentRemovedEvent](docs/EquipmentRemovedEvent.md)
- [EquipmentRoutingRecord](docs/EquipmentRoutingRecord.md)
- [EquipmentRrmBulkUpdateItem](docs/EquipmentRrmBulkUpdateItem.md)
- [EquipmentRrmBulkUpdateItemPerRadioMap](docs/EquipmentRrmBulkUpdateItemPerRadioMap.md)
- [EquipmentRrmBulkUpdateRequest](docs/EquipmentRrmBulkUpdateRequest.md)
- [EquipmentScanDetails](docs/EquipmentScanDetails.md)
- [EquipmentType](docs/EquipmentType.md)
- [EquipmentUpgradeFailureReason](docs/EquipmentUpgradeFailureReason.md)
- [EquipmentUpgradeState](docs/EquipmentUpgradeState.md)
- [EquipmentUpgradeStatusData](docs/EquipmentUpgradeStatusData.md)
- [EthernetLinkState](docs/EthernetLinkState.md)
- [FileCategory](docs/FileCategory.md)
- [FileType](docs/FileType.md)
- [FirmwareScheduleSetting](docs/FirmwareScheduleSetting.md)
- [FirmwareTrackAssignmentDetails](docs/FirmwareTrackAssignmentDetails.md)
- [FirmwareTrackAssignmentRecord](docs/FirmwareTrackAssignmentRecord.md)
- [FirmwareTrackRecord](docs/FirmwareTrackRecord.md)
- [FirmwareValidationMethod](docs/FirmwareValidationMethod.md)
- [FirmwareVersion](docs/FirmwareVersion.md)
- [GatewayAddedEvent](docs/GatewayAddedEvent.md)
- [GatewayChangedEvent](docs/GatewayChangedEvent.md)
- [GatewayRemovedEvent](docs/GatewayRemovedEvent.md)
- [GatewayType](docs/GatewayType.md)
- [GenericResponse](docs/GenericResponse.md)
- [GreTunnelConfiguration](docs/GreTunnelConfiguration.md)
- [GuardInterval](docs/GuardInterval.md)
- [IntegerPerRadioTypeMap](docs/IntegerPerRadioTypeMap.md)
- [IntegerPerStatusCodeMap](docs/IntegerPerStatusCodeMap.md)
- [IntegerStatusCodeMap](docs/IntegerStatusCodeMap.md)
- [IntegerValueMap](docs/IntegerValueMap.md)
- [JsonSerializedException](docs/JsonSerializedException.md)
- [LinkQualityAggregatedStats](docs/LinkQualityAggregatedStats.md)
- [LinkQualityAggregatedStatsPerRadioTypeMap](docs/LinkQualityAggregatedStatsPerRadioTypeMap.md)
- [ListOfChannelInfoReportsPerRadioMap](docs/ListOfChannelInfoReportsPerRadioMap.md)
- [ListOfMacsPerRadioMap](docs/ListOfMacsPerRadioMap.md)
- [ListOfMcsStatsPerRadioMap](docs/ListOfMcsStatsPerRadioMap.md)
- [ListOfRadioUtilizationPerRadioMap](docs/ListOfRadioUtilizationPerRadioMap.md)
- [ListOfSsidStatisticsPerRadioMap](docs/ListOfSsidStatisticsPerRadioMap.md)
- [LocalTimeValue](docs/LocalTimeValue.md)
- [Location](docs/Location.md)
- [LocationActivityDetails](docs/LocationActivityDetails.md)
- [LocationActivityDetailsMap](docs/LocationActivityDetailsMap.md)
- [LocationAddedEvent](docs/LocationAddedEvent.md)
- [LocationChangedEvent](docs/LocationChangedEvent.md)
- [LocationDetails](docs/LocationDetails.md)
- [LocationRemovedEvent](docs/LocationRemovedEvent.md)
- [LongPerRadioTypeMap](docs/LongPerRadioTypeMap.md)
- [LongValueMap](docs/LongValueMap.md)
- [MacAddress](docs/MacAddress.md)
- [MacAllowlistRecord](docs/MacAllowlistRecord.md)
- [ManagedFileInfo](docs/ManagedFileInfo.md)
- [ManagementRate](docs/ManagementRate.md)
- [ManufacturerDetailsRecord](docs/ManufacturerDetailsRecord.md)
- [ManufacturerOuiDetails](docs/ManufacturerOuiDetails.md)
- [ManufacturerOuiDetailsPerOuiMap](docs/ManufacturerOuiDetailsPerOuiMap.md)
- [MapOfWmmQueueStatsPerRadioMap](docs/MapOfWmmQueueStatsPerRadioMap.md)
- [McsStats](docs/McsStats.md)
- [McsType](docs/McsType.md)
- [MeshGroup](docs/MeshGroup.md)
- [MeshGroupMember](docs/MeshGroupMember.md)
- [MeshGroupProperty](docs/MeshGroupProperty.md)
- [MetricConfigParameterMap](docs/MetricConfigParameterMap.md)
- [MimoMode](docs/MimoMode.md)
- [MinMaxAvgValueInt](docs/MinMaxAvgValueInt.md)
- [MinMaxAvgValueIntPerRadioMap](docs/MinMaxAvgValueIntPerRadioMap.md)
- [MulticastRate](docs/MulticastRate.md)
- [NeighborScanPacketType](docs/NeighborScanPacketType.md)
- [NeighbourReport](docs/NeighbourReport.md)
- [NeighbourScanReports](docs/NeighbourScanReports.md)
- [NeighbouringAPListConfiguration](docs/NeighbouringAPListConfiguration.md)
- [NetworkAdminStatusData](docs/NetworkAdminStatusData.md)
- [NetworkAggregateStatusData](docs/NetworkAggregateStatusData.md)
- [NetworkForwardMode](docs/NetworkForwardMode.md)
- [NetworkProbeMetrics](docs/NetworkProbeMetrics.md)
- [NetworkType](docs/NetworkType.md)
- [NoiseFloorDetails](docs/NoiseFloorDetails.md)
- [NoiseFloorPerRadioDetails](docs/NoiseFloorPerRadioDetails.md)
- [NoiseFloorPerRadioDetailsMap](docs/NoiseFloorPerRadioDetailsMap.md)
- [ObssHopMode](docs/ObssHopMode.md)
- [OneOfEquipmentDetails](docs/OneOfEquipmentDetails.md)
- [OneOfFirmwareScheduleSetting](docs/OneOfFirmwareScheduleSetting.md)
- [OneOfProfileDetailsChildren](docs/OneOfProfileDetailsChildren.md)
- [OneOfScheduleSetting](docs/OneOfScheduleSetting.md)
- [OneOfServiceMetricDetails](docs/OneOfServiceMetricDetails.md)
- [OneOfStatusDetails](docs/OneOfStatusDetails.md)
- [OneOfSystemEvent](docs/OneOfSystemEvent.md)
- [OperatingSystemPerformance](docs/OperatingSystemPerformance.md)
- [OriginatorType](docs/OriginatorType.md)
- [PaginationContextAlarm](docs/PaginationContextAlarm.md)
- [PaginationContextClient](docs/PaginationContextClient.md)
- [PaginationContextClientSession](docs/PaginationContextClientSession.md)
- [PaginationContextEquipment](docs/PaginationContextEquipment.md)
- [PaginationContextLocation](docs/PaginationContextLocation.md)
- [PaginationContextPortalUser](docs/PaginationContextPortalUser.md)
- [PaginationContextProfile](docs/PaginationContextProfile.md)
- [PaginationContextServiceMetric](docs/PaginationContextServiceMetric.md)
- [PaginationContextStatus](docs/PaginationContextStatus.md)
- [PaginationContextSystemEvent](docs/PaginationContextSystemEvent.md)
- [PaginationResponseAlarm](docs/PaginationResponseAlarm.md)
- [PaginationResponseClient](docs/PaginationResponseClient.md)
- [PaginationResponseClientSession](docs/PaginationResponseClientSession.md)
- [PaginationResponseEquipment](docs/PaginationResponseEquipment.md)
- [PaginationResponseLocation](docs/PaginationResponseLocation.md)
- [PaginationResponsePortalUser](docs/PaginationResponsePortalUser.md)
- [PaginationResponseProfile](docs/PaginationResponseProfile.md)
- [PaginationResponseServiceMetric](docs/PaginationResponseServiceMetric.md)
- [PaginationResponseStatus](docs/PaginationResponseStatus.md)
- [PaginationResponseSystemEvent](docs/PaginationResponseSystemEvent.md)
- [PairLongLong](docs/PairLongLong.md)
- [PasspointAccessNetworkType](docs/PasspointAccessNetworkType.md)
- [PasspointConnectionCapabilitiesIpProtocol](docs/PasspointConnectionCapabilitiesIpProtocol.md)
- [PasspointConnectionCapabilitiesStatus](docs/PasspointConnectionCapabilitiesStatus.md)
- [PasspointConnectionCapability](docs/PasspointConnectionCapability.md)
- [PasspointDuple](docs/PasspointDuple.md)
- [PasspointEapMethods](docs/PasspointEapMethods.md)
- [PasspointGasAddress3Behaviour](docs/PasspointGasAddress3Behaviour.md)
- [PasspointIPv4AddressType](docs/PasspointIPv4AddressType.md)
- [PasspointIPv6AddressType](docs/PasspointIPv6AddressType.md)
- [PasspointMccMnc](docs/PasspointMccMnc.md)
- [PasspointNaiRealmEapAuthInnerNonEap](docs/PasspointNaiRealmEapAuthInnerNonEap.md)
- [PasspointNaiRealmEapAuthParam](docs/PasspointNaiRealmEapAuthParam.md)
- [PasspointNaiRealmEapCredType](docs/PasspointNaiRealmEapCredType.md)
- [PasspointNaiRealmEncoding](docs/PasspointNaiRealmEncoding.md)
- [PasspointNaiRealmInformation](docs/PasspointNaiRealmInformation.md)
- [PasspointNetworkAuthenticationType](docs/PasspointNetworkAuthenticationType.md)
- [PasspointOperatorProfile](docs/PasspointOperatorProfile.md)
- [PasspointOsuIcon](docs/PasspointOsuIcon.md)
- [PasspointOsuProviderProfile](docs/PasspointOsuProviderProfile.md)
- [PasspointProfile](docs/PasspointProfile.md)
- [PasspointVenueName](docs/PasspointVenueName.md)
- [PasspointVenueProfile](docs/PasspointVenueProfile.md)
- [PasspointVenueTypeAssignment](docs/PasspointVenueTypeAssignment.md)
- [PeerInfo](docs/PeerInfo.md)
- [PerProcessUtilization](docs/PerProcessUtilization.md)
- [PingResponse](docs/PingResponse.md)
- [PortalUser](docs/PortalUser.md)
- [PortalUserAddedEvent](docs/PortalUserAddedEvent.md)
- [PortalUserChangedEvent](docs/PortalUserChangedEvent.md)
- [PortalUserRemovedEvent](docs/PortalUserRemovedEvent.md)
- [PortalUserRole](docs/PortalUserRole.md)
- [Profile](docs/Profile.md)
- [ProfileAddedEvent](docs/ProfileAddedEvent.md)
- [ProfileChangedEvent](docs/ProfileChangedEvent.md)
- [ProfileDetails](docs/ProfileDetails.md)
- [ProfileDetailsChildren](docs/ProfileDetailsChildren.md)
- [ProfileRemovedEvent](docs/ProfileRemovedEvent.md)
- [ProfileType](docs/ProfileType.md)
- [RadioBasedSsidConfiguration](docs/RadioBasedSsidConfiguration.md)
- [RadioBasedSsidConfigurationMap](docs/RadioBasedSsidConfigurationMap.md)
- [RadioBestApSettings](docs/RadioBestApSettings.md)
- [RadioChannelChangeSettings](docs/RadioChannelChangeSettings.md)
- [RadioConfiguration](docs/RadioConfiguration.md)
- [RadioMap](docs/RadioMap.md)
- [RadioMode](docs/RadioMode.md)
- [RadioProfileConfiguration](docs/RadioProfileConfiguration.md)
- [RadioProfileConfigurationMap](docs/RadioProfileConfigurationMap.md)
- [RadioStatistics](docs/RadioStatistics.md)
- [RadioStatisticsPerRadioMap](docs/RadioStatisticsPerRadioMap.md)
- [RadioType](docs/RadioType.md)
- [RadioUtilization](docs/RadioUtilization.md)
- [RadioUtilizationDetails](docs/RadioUtilizationDetails.md)
- [RadioUtilizationPerRadioDetails](docs/RadioUtilizationPerRadioDetails.md)
- [RadioUtilizationPerRadioDetailsMap](docs/RadioUtilizationPerRadioDetailsMap.md)
- [RadioUtilizationReport](docs/RadioUtilizationReport.md)
- [RadiusAuthenticationMethod](docs/RadiusAuthenticationMethod.md)
- [RadiusDetails](docs/RadiusDetails.md)
- [RadiusMetrics](docs/RadiusMetrics.md)
- [RadiusNasConfiguration](docs/RadiusNasConfiguration.md)
- [RadiusProfile](docs/RadiusProfile.md)
- [RadiusServer](docs/RadiusServer.md)
- [RadiusServerDetails](docs/RadiusServerDetails.md)
- [RealTimeEvent](docs/RealTimeEvent.md)
- [RealTimeSipCallEventWithStats](docs/RealTimeSipCallEventWithStats.md)
- [RealTimeSipCallReportEvent](docs/RealTimeSipCallReportEvent.md)
- [RealTimeSipCallStartEvent](docs/RealTimeSipCallStartEvent.md)
- [RealTimeSipCallStopEvent](docs/RealTimeSipCallStopEvent.md)
- [RealTimeStreamingStartEvent](docs/RealTimeStreamingStartEvent.md)
- [RealTimeStreamingStartSessionEvent](docs/RealTimeStreamingStartSessionEvent.md)
- [RealTimeStreamingStopEvent](docs/RealTimeStreamingStopEvent.md)
- [RealtimeChannelHopEvent](docs/RealtimeChannelHopEvent.md)
- [RfConfigMap](docs/RfConfigMap.md)
- [RfConfiguration](docs/RfConfiguration.md)
- [RfElementConfiguration](docs/RfElementConfiguration.md)
- [RoutingAddedEvent](docs/RoutingAddedEvent.md)
- [RoutingChangedEvent](docs/RoutingChangedEvent.md)
- [RoutingRemovedEvent](docs/RoutingRemovedEvent.md)
- [RrmBulkUpdateApDetails](docs/RrmBulkUpdateApDetails.md)
- [RtlsSettings](docs/RtlsSettings.md)
- [RtpFlowDirection](docs/RtpFlowDirection.md)
- [RtpFlowStats](docs/RtpFlowStats.md)
- [RtpFlowType](docs/RtpFlowType.md)
- [SIPCallReportReason](docs/SIPCallReportReason.md)
- [ScheduleSetting](docs/ScheduleSetting.md)
- [SecurityType](docs/SecurityType.md)
- [ServiceAdoptionMetrics](docs/ServiceAdoptionMetrics.md)
- [ServiceMetric](docs/ServiceMetric.md)
- [ServiceMetricConfigParameters](docs/ServiceMetricConfigParameters.md)
- [ServiceMetricDataType](docs/ServiceMetricDataType.md)
- [ServiceMetricDetails](docs/ServiceMetricDetails.md)
- [ServiceMetricRadioConfigParameters](docs/ServiceMetricRadioConfigParameters.md)
- [ServiceMetricSurveyConfigParameters](docs/ServiceMetricSurveyConfigParameters.md)
- [ServiceMetricsCollectionConfigProfile](docs/ServiceMetricsCollectionConfigProfile.md)
- [SessionExpiryType](docs/SessionExpiryType.md)
- [SipCallStopReason](docs/SipCallStopReason.md)
- [SortColumnsAlarm](docs/SortColumnsAlarm.md)
- [SortColumnsClient](docs/SortColumnsClient.md)
- [SortColumnsClientSession](docs/SortColumnsClientSession.md)
- [SortColumnsEquipment](docs/SortColumnsEquipment.md)
- [SortColumnsLocation](docs/SortColumnsLocation.md)
- [SortColumnsPortalUser](docs/SortColumnsPortalUser.md)
- [SortColumnsProfile](docs/SortColumnsProfile.md)
- [SortColumnsServiceMetric](docs/SortColumnsServiceMetric.md)
- [SortColumnsStatus](docs/SortColumnsStatus.md)
- [SortColumnsSystemEvent](docs/SortColumnsSystemEvent.md)
- [SortOrder](docs/SortOrder.md)
- [SourceSelectionManagement](docs/SourceSelectionManagement.md)
- [SourceSelectionMulticast](docs/SourceSelectionMulticast.md)
- [SourceSelectionSteering](docs/SourceSelectionSteering.md)
- [SourceSelectionValue](docs/SourceSelectionValue.md)
- [SourceType](docs/SourceType.md)
- [SsidConfiguration](docs/SsidConfiguration.md)
- [SsidSecureMode](docs/SsidSecureMode.md)
- [SsidStatistics](docs/SsidStatistics.md)
- [StateSetting](docs/StateSetting.md)
- [StateUpDownError](docs/StateUpDownError.md)
- [StatsReportFormat](docs/StatsReportFormat.md)
- [Status](docs/Status.md)
- [StatusChangedEvent](docs/StatusChangedEvent.md)
- [StatusCode](docs/StatusCode.md)
- [StatusDataType](docs/StatusDataType.md)
- [StatusDetails](docs/StatusDetails.md)
- [StatusRemovedEvent](docs/StatusRemovedEvent.md)
- [SteerType](docs/SteerType.md)
- [StreamingVideoServerRecord](docs/StreamingVideoServerRecord.md)
- [StreamingVideoType](docs/StreamingVideoType.md)
- [SyslogRelay](docs/SyslogRelay.md)
- [SyslogSeverityType](docs/SyslogSeverityType.md)
- [SystemEvent](docs/SystemEvent.md)
- [SystemEventDataType](docs/SystemEventDataType.md)
- [SystemEventRecord](docs/SystemEventRecord.md)
- [TimedAccessUserDetails](docs/TimedAccessUserDetails.md)
- [TimedAccessUserRecord](docs/TimedAccessUserRecord.md)
- [TrackFlag](docs/TrackFlag.md)
- [TrafficDetails](docs/TrafficDetails.md)
- [TrafficPerRadioDetails](docs/TrafficPerRadioDetails.md)
- [TrafficPerRadioDetailsPerRadioTypeMap](docs/TrafficPerRadioDetailsPerRadioTypeMap.md)
- [TunnelIndicator](docs/TunnelIndicator.md)
- [TunnelMetricData](docs/TunnelMetricData.md)
- [UnserializableSystemEvent](docs/UnserializableSystemEvent.md)
- [UserDetails](docs/UserDetails.md)
- [VLANStatusData](docs/VLANStatusData.md)
- [VLANStatusDataMap](docs/VLANStatusDataMap.md)
- [VlanSubnet](docs/VlanSubnet.md)
- [WebTokenAclTemplate](docs/WebTokenAclTemplate.md)
- [WebTokenRequest](docs/WebTokenRequest.md)
- [WebTokenResult](docs/WebTokenResult.md)
- [WepAuthType](docs/WepAuthType.md)
- [WepConfiguration](docs/WepConfiguration.md)
- [WepKey](docs/WepKey.md)
- [WepType](docs/WepType.md)
- [WlanReasonCode](docs/WlanReasonCode.md)
- [WlanStatusCode](docs/WlanStatusCode.md)
- [WmmQueueStats](docs/WmmQueueStats.md)
- [WmmQueueStatsPerQueueTypeMap](docs/WmmQueueStatsPerQueueTypeMap.md)
- [WmmQueueType](docs/WmmQueueType.md)
## Documentation For Authorization
## tip_wlan_ts_auth
## Author

13
libs/cloudapi/cloudsdk/docs/AclTemplate.md Normal file
View File

@@ -0,0 +1,13 @@
# AclTemplate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**read** | **bool** | | [optional]
**read_write** | **bool** | | [optional]
**read_write_create** | **bool** | | [optional]
**delete** | **bool** | | [optional]
**portal_login** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ActiveBSSID.md Normal file
View File

@@ -0,0 +1,13 @@
# ActiveBSSID
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | | [optional]
**bssid** | **str** | | [optional]
**ssid** | **str** | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**num_devices_connected** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/ActiveBSSIDs.md Normal file
View File

@@ -0,0 +1,11 @@
# ActiveBSSIDs
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**status_data_type** | **str** | | [optional]
**active_bssi_ds** | [**list[ActiveBSSID]**](ActiveBSSID.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/ActiveScanSettings.md Normal file
View File

@@ -0,0 +1,11 @@
# ActiveScanSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | | [optional]
**scan_frequency_seconds** | **int** | | [optional]
**scan_duration_millis** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/AdvancedRadioMap.md Normal file
View File

@@ -0,0 +1,12 @@
# AdvancedRadioMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is5_g_hz** | [**RadioConfiguration**](RadioConfiguration.md) | | [optional]
**is5_g_hz_u** | [**RadioConfiguration**](RadioConfiguration.md) | | [optional]
**is5_g_hz_l** | [**RadioConfiguration**](RadioConfiguration.md) | | [optional]
**is2dot4_g_hz** | [**RadioConfiguration**](RadioConfiguration.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
libs/cloudapi/cloudsdk/docs/Alarm.md Normal file
View File

@@ -0,0 +1,19 @@
# Alarm
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**alarm_code** | [**AlarmCode**](AlarmCode.md) | | [optional]
**created_timestamp** | **int** | | [optional]
**originator_type** | [**OriginatorType**](OriginatorType.md) | | [optional]
**severity** | [**StatusCode**](StatusCode.md) | | [optional]
**scope_type** | [**AlarmScopeType**](AlarmScopeType.md) | | [optional]
**scope_id** | **str** | | [optional]
**details** | [**AlarmDetails**](AlarmDetails.md) | | [optional]
**acknowledged** | **bool** | | [optional]
**last_modified_timestamp** | **int** | must be provided for update operation, update will be rejected if provided value does not match the one currently stored in the database | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/AlarmAddedEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# AlarmAddedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**payload** | [**Alarm**](Alarm.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/AlarmChangedEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# AlarmChangedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**payload** | [**Alarm**](Alarm.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/AlarmCode.md Normal file
View File

@@ -0,0 +1,8 @@
# AlarmCode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/AlarmCounts.md Normal file
View File

@@ -0,0 +1,11 @@
# AlarmCounts
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**customer_id** | **int** | | [optional]
**counts_per_equipment_id_map** | [**CountsPerEquipmentIdPerAlarmCodeMap**](CountsPerEquipmentIdPerAlarmCodeMap.md) | | [optional]
**total_counts_per_alarm_code_map** | [**CountsPerAlarmCodeMap**](CountsPerAlarmCodeMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/AlarmDetails.md Normal file
View File

@@ -0,0 +1,12 @@
# AlarmDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | | [optional]
**affected_equipment_ids** | **list[int]** | | [optional]
**generated_by** | **str** | | [optional]
**context_attrs** | [**AlarmDetailsAttributesMap**](AlarmDetailsAttributesMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/AlarmDetailsAttributesMap.md Normal file
View File

@@ -0,0 +1,8 @@
# AlarmDetailsAttributesMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/AlarmRemovedEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# AlarmRemovedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**payload** | [**Alarm**](Alarm.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/AlarmScopeType.md Normal file
View File

@@ -0,0 +1,8 @@
# AlarmScopeType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

317
libs/cloudapi/cloudsdk/docs/AlarmsApi.md Normal file
View File

@@ -0,0 +1,317 @@
# swagger_client.AlarmsApi
All URIs are relative to *https://localhost:9091*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_alarm**](AlarmsApi.md#delete_alarm) | **DELETE** /portal/alarm | Delete Alarm
[**get_alarm_counts**](AlarmsApi.md#get_alarm_counts) | **GET** /portal/alarm/counts | Get counts of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
[**get_alarmsfor_customer**](AlarmsApi.md#get_alarmsfor_customer) | **GET** /portal/alarm/forCustomer | Get list of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
[**get_alarmsfor_equipment**](AlarmsApi.md#get_alarmsfor_equipment) | **GET** /portal/alarm/forEquipment | Get list of Alarms for customerId, set of equipment ids, and set of alarm codes.
[**reset_alarm_counts**](AlarmsApi.md#reset_alarm_counts) | **POST** /portal/alarm/resetCounts | Reset accumulated counts of Alarms.
[**update_alarm**](AlarmsApi.md#update_alarm) | **PUT** /portal/alarm | Update Alarm
# **delete_alarm**
> Alarm delete_alarm(customer_id, equipment_id, alarm_code, created_timestamp)
Delete Alarm
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int |
equipment_id = 789 # int |
alarm_code = swagger_client.AlarmCode() # AlarmCode |
created_timestamp = 789 # int |
try:
# Delete Alarm
api_response = api_instance.delete_alarm(customer_id, equipment_id, alarm_code, created_timestamp)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->delete_alarm: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| |
**equipment_id** | **int**| |
**alarm_code** | [**AlarmCode**](.md)| |
**created_timestamp** | **int**| |
### Return type
[**Alarm**](Alarm.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_alarm_counts**
> AlarmCounts get_alarm_counts(customer_id, equipment_ids=equipment_ids, alarm_codes=alarm_codes)
Get counts of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
equipment_ids = [56] # list[int] | Set of equipment ids. Empty or null means retrieve for all equipment for the customer. (optional)
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
try:
# Get counts of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
api_response = api_instance.get_alarm_counts(customer_id, equipment_ids=equipment_ids, alarm_codes=alarm_codes)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarm_counts: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**equipment_ids** | [**list[int]**](int.md)| Set of equipment ids. Empty or null means retrieve for all equipment for the customer. | [optional]
**alarm_codes** | [**list[AlarmCode]**](AlarmCode.md)| Set of alarm codes. Empty or null means retrieve all. | [optional]
### Return type
[**AlarmCounts**](AlarmCounts.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_alarmsfor_customer**
> PaginationResponseAlarm get_alarmsfor_customer(customer_id, pagination_context, equipment_ids=equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp, sort_by=sort_by)
Get list of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
pagination_context = swagger_client.PaginationContextAlarm() # PaginationContextAlarm | pagination context
equipment_ids = [56] # list[int] | Set of equipment ids. Empty or null means retrieve all equipment for the customer. (optional)
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
created_after_timestamp = -1 # int | retrieve alarms created after the specified time (optional) (default to -1)
sort_by = [swagger_client.SortColumnsAlarm()] # list[SortColumnsAlarm] | sort options (optional)
try:
# Get list of Alarms for customerId, optional set of equipment ids, optional set of alarm codes.
api_response = api_instance.get_alarmsfor_customer(customer_id, pagination_context, equipment_ids=equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp, sort_by=sort_by)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarmsfor_customer: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**pagination_context** | [**PaginationContextAlarm**](.md)| pagination context |
**equipment_ids** | [**list[int]**](int.md)| Set of equipment ids. Empty or null means retrieve all equipment for the customer. | [optional]
**alarm_codes** | [**list[AlarmCode]**](AlarmCode.md)| Set of alarm codes. Empty or null means retrieve all. | [optional]
**created_after_timestamp** | **int**| retrieve alarms created after the specified time | [optional] [default to -1]
**sort_by** | [**list[SortColumnsAlarm]**](SortColumnsAlarm.md)| sort options | [optional]
### Return type
[**PaginationResponseAlarm**](PaginationResponseAlarm.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_alarmsfor_equipment**
> list[Alarm] get_alarmsfor_equipment(customer_id, equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp)
Get list of Alarms for customerId, set of equipment ids, and set of alarm codes.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
equipment_ids = [56] # list[int] | Set of equipment ids. Must not be empty.
alarm_codes = [swagger_client.AlarmCode()] # list[AlarmCode] | Set of alarm codes. Empty or null means retrieve all. (optional)
created_after_timestamp = -1 # int | retrieve alarms created after the specified time (optional) (default to -1)
try:
# Get list of Alarms for customerId, set of equipment ids, and set of alarm codes.
api_response = api_instance.get_alarmsfor_equipment(customer_id, equipment_ids, alarm_codes=alarm_codes, created_after_timestamp=created_after_timestamp)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->get_alarmsfor_equipment: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**equipment_ids** | [**list[int]**](int.md)| Set of equipment ids. Must not be empty. |
**alarm_codes** | [**list[AlarmCode]**](AlarmCode.md)| Set of alarm codes. Empty or null means retrieve all. | [optional]
**created_after_timestamp** | **int**| retrieve alarms created after the specified time | [optional] [default to -1]
### Return type
[**list[Alarm]**](Alarm.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **reset_alarm_counts**
> GenericResponse reset_alarm_counts()
Reset accumulated counts of Alarms.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
try:
# Reset accumulated counts of Alarms.
api_response = api_instance.reset_alarm_counts()
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->reset_alarm_counts: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**GenericResponse**](GenericResponse.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_alarm**
> Alarm update_alarm(body)
Update Alarm
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.AlarmsApi(swagger_client.ApiClient(configuration))
body = swagger_client.Alarm() # Alarm | Alarm info
try:
# Update Alarm
api_response = api_instance.update_alarm(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling AlarmsApi->update_alarm: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Alarm**](Alarm.md)| Alarm info |
### Return type
[**Alarm**](Alarm.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/AntennaType.md Normal file
View File

@@ -0,0 +1,8 @@
# AntennaType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

32
libs/cloudapi/cloudsdk/docs/ApElementConfiguration.md Normal file
View File

@@ -0,0 +1,32 @@
# ApElementConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**element_config_version** | **str** | | [optional]
**equipment_type** | [**EquipmentType**](EquipmentType.md) | | [optional]
**device_mode** | [**DeviceMode**](DeviceMode.md) | | [optional]
**getting_ip** | **str** | | [optional]
**static_ip** | **str** | | [optional]
**static_ip_mask_cidr** | **int** | | [optional]
**static_ip_gw** | **str** | | [optional]
**getting_dns** | **str** | | [optional]
**static_dns_ip1** | **str** | | [optional]
**static_dns_ip2** | **str** | | [optional]
**peer_info_list** | [**list[PeerInfo]**](PeerInfo.md) | | [optional]
**device_name** | **str** | | [optional]
**location_data** | **str** | | [optional]
**locally_configured_mgmt_vlan** | **int** | | [optional]
**locally_configured** | **bool** | | [optional]
**deployment_type** | [**DeploymentType**](DeploymentType.md) | | [optional]
**synthetic_client_enabled** | **bool** | | [optional]
**frame_report_throttle_enabled** | **bool** | | [optional]
**antenna_type** | [**AntennaType**](AntennaType.md) | | [optional]
**cost_saving_events_enabled** | **bool** | | [optional]
**forward_mode** | [**NetworkForwardMode**](NetworkForwardMode.md) | | [optional]
**radio_map** | [**RadioMap**](RadioMap.md) | | [optional]
**advanced_radio_map** | [**AdvancedRadioMap**](AdvancedRadioMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/ApMeshMode.md Normal file
View File

@@ -0,0 +1,8 @@
# ApMeshMode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

21
libs/cloudapi/cloudsdk/docs/ApNetworkConfiguration.md Normal file
View File

@@ -0,0 +1,21 @@
# ApNetworkConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | | [optional]
**network_config_version** | **str** | | [optional]
**equipment_type** | **str** | | [optional]
**vlan_native** | **bool** | | [optional]
**vlan** | **int** | | [optional]
**ntp_server** | [**ApNetworkConfigurationNtpServer**](ApNetworkConfigurationNtpServer.md) | | [optional]
**syslog_relay** | [**SyslogRelay**](SyslogRelay.md) | | [optional]
**rtls_settings** | [**RtlsSettings**](RtlsSettings.md) | | [optional]
**synthetic_client_enabled** | **bool** | | [optional]
**led_control_enabled** | **bool** | | [optional]
**equipment_discovery** | **bool** | | [optional]
**gre_tunnel_configurations** | [**list[GreTunnelConfiguration]**](GreTunnelConfiguration.md) | | [optional]
**radio_map** | [**RadioProfileConfigurationMap**](RadioProfileConfigurationMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/ApNetworkConfigurationNtpServer.md Normal file
View File

@@ -0,0 +1,10 @@
# ApNetworkConfigurationNtpServer
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto** | **bool** | | [optional]
**value** | **str** | | [optional] [default to 'pool.ntp.org']
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26
libs/cloudapi/cloudsdk/docs/ApNodeMetrics.md Normal file
View File

@@ -0,0 +1,26 @@
# ApNodeMetrics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**period_length_sec** | **int** | How many seconds the AP measured for the metric | [optional]
**client_mac_addresses_per_radio** | [**ListOfMacsPerRadioMap**](ListOfMacsPerRadioMap.md) | | [optional]
**tx_bytes_per_radio** | [**LongPerRadioTypeMap**](LongPerRadioTypeMap.md) | | [optional]
**rx_bytes_per_radio** | [**LongPerRadioTypeMap**](LongPerRadioTypeMap.md) | | [optional]
**noise_floor_per_radio** | [**IntegerPerRadioTypeMap**](IntegerPerRadioTypeMap.md) | | [optional]
**tunnel_metrics** | [**list[TunnelMetricData]**](TunnelMetricData.md) | | [optional]
**network_probe_metrics** | [**list[NetworkProbeMetrics]**](NetworkProbeMetrics.md) | | [optional]
**radius_metrics** | [**list[RadiusMetrics]**](RadiusMetrics.md) | | [optional]
**cloud_link_availability** | **int** | | [optional]
**cloud_link_latency_in_ms** | **int** | | [optional]
**channel_utilization_per_radio** | [**IntegerPerRadioTypeMap**](IntegerPerRadioTypeMap.md) | | [optional]
**ap_performance** | [**ApPerformance**](ApPerformance.md) | | [optional]
**vlan_subnet** | [**list[VlanSubnet]**](VlanSubnet.md) | | [optional]
**radio_utilization_per_radio** | [**ListOfRadioUtilizationPerRadioMap**](ListOfRadioUtilizationPerRadioMap.md) | | [optional]
**radio_stats_per_radio** | [**RadioStatisticsPerRadioMap**](RadioStatisticsPerRadioMap.md) | | [optional]
**mcs_stats_per_radio** | [**ListOfMcsStatsPerRadioMap**](ListOfMcsStatsPerRadioMap.md) | | [optional]
**wmm_queues_per_radio** | [**MapOfWmmQueueStatsPerRadioMap**](MapOfWmmQueueStatsPerRadioMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
libs/cloudapi/cloudsdk/docs/ApPerformance.md Normal file
View File

@@ -0,0 +1,19 @@
# ApPerformance
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**free_memory** | **int** | free memory in kilobytes | [optional]
**cpu_utilized** | **list[int]** | CPU utilization in percentage, one per core | [optional]
**up_time** | **int** | AP uptime in seconds | [optional]
**cami_crashed** | **int** | number of time cloud-to-ap-management process crashed | [optional]
**cpu_temperature** | **int** | cpu temperature in Celsius | [optional]
**low_memory_reboot** | **bool** | low memory reboot happened | [optional]
**eth_link_state** | [**EthernetLinkState**](EthernetLinkState.md) | | [optional]
**cloud_tx_bytes** | **int** | Data sent by AP to the cloud | [optional]
**cloud_rx_bytes** | **int** | Data received by AP from cloud | [optional]
**ps_cpu_util** | [**list[PerProcessUtilization]**](PerProcessUtilization.md) | | [optional]
**ps_mem_util** | [**list[PerProcessUtilization]**](PerProcessUtilization.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/ApSsidMetrics.md Normal file
View File

@@ -0,0 +1,10 @@
# ApSsidMetrics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**ssid_stats** | [**ListOfSsidStatisticsPerRadioMap**](ListOfSsidStatisticsPerRadioMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/AutoOrManualString.md Normal file
View File

@@ -0,0 +1,10 @@
# AutoOrManualString
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto** | **bool** | | [optional]
**value** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/AutoOrManualValue.md Normal file
View File

@@ -0,0 +1,10 @@
# AutoOrManualValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto** | **bool** | | [optional]
**value** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/BackgroundPosition.md Normal file
View File

@@ -0,0 +1,8 @@
# BackgroundPosition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/BackgroundRepeat.md Normal file
View File

@@ -0,0 +1,8 @@
# BackgroundRepeat
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/BannedChannel.md Normal file
View File

@@ -0,0 +1,10 @@
# BannedChannel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**channel_number** | **int** | | [optional]
**banned_on_epoc** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
libs/cloudapi/cloudsdk/docs/BaseDhcpEvent.md Normal file
View File

@@ -0,0 +1,19 @@
# BaseDhcpEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**SystemEvent**](SystemEvent.md) | | [optional]
**x_id** | **int** | | [optional]
**vlan_id** | **int** | | [optional]
**dhcp_server_ip** | **str** | string representing InetAddress | [optional]
**client_ip** | **str** | string representing InetAddress | [optional]
**relay_ip** | **str** | string representing InetAddress | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**session_id** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/BestAPSteerType.md Normal file
View File

@@ -0,0 +1,8 @@
# BestAPSteerType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/BlocklistDetails.md Normal file
View File

@@ -0,0 +1,11 @@
# BlocklistDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | When enabled, blocklisting applies to the client, subject to the optional start/end times. | [optional]
**start_time** | **int** | Optional startTime when blocklisting becomes enabled. | [optional]
**end_time** | **int** | Optional endTime when blocklisting ceases to be enabled | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/BonjourGatewayProfile.md Normal file
View File

@@ -0,0 +1,11 @@
# BonjourGatewayProfile
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | | [optional]
**profile_description** | **str** | | [optional]
**bonjour_services** | [**list[BonjourServiceSet]**](BonjourServiceSet.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/BonjourServiceSet.md Normal file
View File

@@ -0,0 +1,11 @@
# BonjourServiceSet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**vlan_id** | **int** | | [optional]
**support_all_services** | **bool** | | [optional]
**service_names** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
libs/cloudapi/cloudsdk/docs/CapacityDetails.md Normal file
View File

@@ -0,0 +1,9 @@
# CapacityDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**per_radio_details** | [**CapacityPerRadioDetailsMap**](CapacityPerRadioDetailsMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/CapacityPerRadioDetails.md Normal file
View File

@@ -0,0 +1,13 @@
# CapacityPerRadioDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**total_capacity** | **int** | | [optional]
**available_capacity** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**unavailable_capacity** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**used_capacity** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**unused_capacity** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/CapacityPerRadioDetailsMap.md Normal file
View File

@@ -0,0 +1,12 @@
# CapacityPerRadioDetailsMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is5_g_hz** | [**CapacityPerRadioDetails**](CapacityPerRadioDetails.md) | | [optional]
**is5_g_hz_u** | [**CapacityPerRadioDetails**](CapacityPerRadioDetails.md) | | [optional]
**is5_g_hz_l** | [**CapacityPerRadioDetails**](CapacityPerRadioDetails.md) | | [optional]
**is2dot4_g_hz** | [**CapacityPerRadioDetails**](CapacityPerRadioDetails.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/CaptivePortalAuthenticationType.md Normal file
View File

@@ -0,0 +1,8 @@
# CaptivePortalAuthenticationType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
libs/cloudapi/cloudsdk/docs/CaptivePortalConfiguration.md Normal file
View File

@@ -0,0 +1,30 @@
# CaptivePortalConfiguration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | | [optional]
**browser_title** | **str** | | [optional]
**header_content** | **str** | | [optional]
**user_acceptance_policy** | **str** | | [optional]
**success_page_markdown_text** | **str** | | [optional]
**redirect_url** | **str** | | [optional]
**external_captive_portal_url** | **str** | | [optional]
**session_timeout_in_minutes** | **int** | | [optional]
**logo_file** | [**ManagedFileInfo**](ManagedFileInfo.md) | | [optional]
**background_file** | [**ManagedFileInfo**](ManagedFileInfo.md) | | [optional]
**walled_garden_allowlist** | **list[str]** | | [optional]
**username_password_file** | [**ManagedFileInfo**](ManagedFileInfo.md) | | [optional]
**authentication_type** | [**CaptivePortalAuthenticationType**](CaptivePortalAuthenticationType.md) | | [optional]
**radius_auth_method** | [**RadiusAuthenticationMethod**](RadiusAuthenticationMethod.md) | | [optional]
**max_users_with_same_credentials** | **int** | | [optional]
**external_policy_file** | [**ManagedFileInfo**](ManagedFileInfo.md) | | [optional]
**background_position** | [**BackgroundPosition**](BackgroundPosition.md) | | [optional]
**background_repeat** | [**BackgroundRepeat**](BackgroundRepeat.md) | | [optional]
**radius_service_id** | **int** | | [optional]
**expiry_type** | [**SessionExpiryType**](SessionExpiryType.md) | | [optional]
**user_list** | [**list[TimedAccessUserRecord]**](TimedAccessUserRecord.md) | | [optional]
**mac_allow_list** | [**list[MacAllowlistRecord]**](MacAllowlistRecord.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/ChannelBandwidth.md Normal file
View File

@@ -0,0 +1,8 @@
# ChannelBandwidth
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/ChannelHopReason.md Normal file
View File

@@ -0,0 +1,8 @@
# ChannelHopReason
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ChannelHopSettings.md Normal file
View File

@@ -0,0 +1,13 @@
# ChannelHopSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**noise_floor_threshold_in_db** | **int** | | [optional] [default to -75]
**noise_floor_threshold_time_in_seconds** | **int** | | [optional] [default to 180]
**non_wifi_threshold_in_percentage** | **int** | | [optional] [default to 50]
**non_wifi_threshold_time_in_seconds** | **int** | | [optional] [default to 180]
**obss_hop_mode** | [**ObssHopMode**](ObssHopMode.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ChannelInfo.md Normal file
View File

@@ -0,0 +1,13 @@
# ChannelInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**chan_number** | **int** | | [optional]
**bandwidth** | [**ChannelBandwidth**](ChannelBandwidth.md) | | [optional]
**total_utilization** | **int** | | [optional]
**wifi_utilization** | **int** | | [optional]
**noise_floor** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/ChannelInfoReports.md Normal file
View File

@@ -0,0 +1,10 @@
# ChannelInfoReports
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**channel_information_reports_per_radio** | [**ListOfChannelInfoReportsPerRadioMap**](ListOfChannelInfoReportsPerRadioMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ChannelPowerLevel.md Normal file
View File

@@ -0,0 +1,12 @@
# ChannelPowerLevel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**channel_number** | **int** | | [optional]
**power_level** | **int** | | [optional]
**dfs** | **bool** | | [optional]
**channel_width** | **int** | Value is in MHz, -1 means AUTO | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
libs/cloudapi/cloudsdk/docs/ChannelUtilizationDetails.md Normal file
View File

@@ -0,0 +1,10 @@
# ChannelUtilizationDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**per_radio_details** | [**ChannelUtilizationPerRadioDetailsMap**](ChannelUtilizationPerRadioDetailsMap.md) | | [optional]
**indicator_value** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ChannelUtilizationPerRadioDetails.md Normal file
View File

@@ -0,0 +1,12 @@
# ChannelUtilizationPerRadioDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**channel_utilization** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**num_good_equipment** | **int** | | [optional]
**num_warn_equipment** | **int** | | [optional]
**num_bad_equipment** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ChannelUtilizationPerRadioDetailsMap.md Normal file
View File

@@ -0,0 +1,12 @@
# ChannelUtilizationPerRadioDetailsMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is5_g_hz** | [**ChannelUtilizationPerRadioDetails**](ChannelUtilizationPerRadioDetails.md) | | [optional]
**is5_g_hz_u** | [**ChannelUtilizationPerRadioDetails**](ChannelUtilizationPerRadioDetails.md) | | [optional]
**is5_g_hz_l** | [**ChannelUtilizationPerRadioDetails**](ChannelUtilizationPerRadioDetails.md) | | [optional]
**is2dot4_g_hz** | [**ChannelUtilizationPerRadioDetails**](ChannelUtilizationPerRadioDetails.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/ChannelUtilizationSurveyType.md Normal file
View File

@@ -0,0 +1,8 @@
# ChannelUtilizationSurveyType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/Client.md Normal file
View File

@@ -0,0 +1,13 @@
# Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**customer_id** | **int** | | [optional]
**details** | [**ClientInfoDetails**](ClientInfoDetails.md) | | [optional]
**created_timestamp** | **int** | | [optional]
**last_modified_timestamp** | **int** | This class does not perform checks against concurrrent updates. Here last update always wins. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ClientActivityAggregatedStats.md Normal file
View File

@@ -0,0 +1,12 @@
# ClientActivityAggregatedStats
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mbps** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**high_client_count** | **int** | | [optional]
**medium_client_count** | **int** | | [optional]
**low_client_count** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ClientActivityAggregatedStatsPerRadioTypeMap.md Normal file
View File

@@ -0,0 +1,12 @@
# ClientActivityAggregatedStatsPerRadioTypeMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**is5_g_hz** | [**ClientActivityAggregatedStats**](ClientActivityAggregatedStats.md) | | [optional]
**is5_g_hz_u** | [**ClientActivityAggregatedStats**](ClientActivityAggregatedStats.md) | | [optional]
**is5_g_hz_l** | [**ClientActivityAggregatedStats**](ClientActivityAggregatedStats.md) | | [optional]
**is2dot4_g_hz** | [**ClientActivityAggregatedStats**](ClientActivityAggregatedStats.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ClientAddedEvent.md Normal file
View File

@@ -0,0 +1,12 @@
# ClientAddedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**payload** | [**Client**](Client.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

21
libs/cloudapi/cloudsdk/docs/ClientAssocEvent.md Normal file
View File

@@ -0,0 +1,21 @@
# ClientAssocEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**ssid** | **str** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**is_reassociation** | **bool** | | [optional]
**status** | [**WlanStatusCode**](WlanStatusCode.md) | | [optional]
**rssi** | **int** | | [optional]
**internal_sc** | **int** | | [optional]
**using11k** | **bool** | | [optional]
**using11r** | **bool** | | [optional]
**using11v** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

16
libs/cloudapi/cloudsdk/docs/ClientAuthEvent.md Normal file
View File

@@ -0,0 +1,16 @@
# ClientAuthEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**ssid** | **str** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**is_reassociation** | **bool** | | [optional]
**auth_status** | [**WlanStatusCode**](WlanStatusCode.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ClientChangedEvent.md Normal file
View File

@@ -0,0 +1,12 @@
# ClientChangedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**payload** | [**Client**](Client.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
libs/cloudapi/cloudsdk/docs/ClientConnectSuccessEvent.md Normal file
View File

@@ -0,0 +1,30 @@
# ClientConnectSuccessEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**session_id** | **int** | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**is_reassociation** | **bool** | | [optional]
**ssid** | **str** | | [optional]
**security_type** | [**SecurityType**](SecurityType.md) | | [optional]
**fbt_used** | **bool** | | [optional]
**ip_addr** | **str** | string representing InetAddress | [optional]
**clt_id** | **str** | | [optional]
**auth_ts** | **int** | | [optional]
**assoc_ts** | **int** | | [optional]
**eapol_ts** | **int** | | [optional]
**port_enabled_ts** | **int** | | [optional]
**first_data_rx_ts** | **int** | | [optional]
**first_data_tx_ts** | **int** | | [optional]
**using11k** | **bool** | | [optional]
**using11r** | **bool** | | [optional]
**using11v** | **bool** | | [optional]
**ip_acquisition_ts** | **int** | | [optional]
**assoc_rssi** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/ClientConnectionDetails.md Normal file
View File

@@ -0,0 +1,11 @@
# ClientConnectionDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**status_data_type** | **str** | | [optional]
**num_clients_per_radio** | [**IntegerPerRadioTypeMap**](IntegerPerRadioTypeMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

20
libs/cloudapi/cloudsdk/docs/ClientDhcpDetails.md Normal file
View File

@@ -0,0 +1,20 @@
# ClientDhcpDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dhcp_server_ip** | **str** | | [optional]
**primary_dns** | **str** | | [optional]
**secondary_dns** | **str** | | [optional]
**subnet_mask** | **str** | | [optional]
**gateway_ip** | **str** | | [optional]
**lease_start_timestamp** | **int** | | [optional]
**lease_time_in_seconds** | **int** | | [optional]
**first_request_timestamp** | **int** | | [optional]
**first_offer_timestamp** | **int** | | [optional]
**first_discover_timestamp** | **int** | | [optional]
**nak_timestamp** | **int** | | [optional]
**from_internal** | **bool** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
libs/cloudapi/cloudsdk/docs/ClientDisconnectEvent.md Normal file
View File

@@ -0,0 +1,22 @@
# ClientDisconnectEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**ssid** | **str** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**mac_address_bytes** | **list[str]** | | [optional]
**reason_code** | [**WlanReasonCode**](WlanReasonCode.md) | | [optional]
**internal_reason_code** | **int** | | [optional]
**rssi** | **int** | | [optional]
**last_recv_time** | **int** | | [optional]
**last_sent_time** | **int** | | [optional]
**frame_type** | [**DisconnectFrameType**](DisconnectFrameType.md) | | [optional]
**initiator** | [**DisconnectInitiator**](DisconnectInitiator.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
libs/cloudapi/cloudsdk/docs/ClientEapDetails.md Normal file
View File

@@ -0,0 +1,15 @@
# ClientEapDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**eap_key1_timestamp** | **int** | | [optional]
**eap_key2_timestamp** | **int** | | [optional]
**eap_key3_timestamp** | **int** | | [optional]
**eap_key4_timestamp** | **int** | | [optional]
**request_identity_timestamp** | **int** | | [optional]
**eap_negotiation_start_timestamp** | **int** | | [optional]
**eap_success_timestamp** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
libs/cloudapi/cloudsdk/docs/ClientFailureDetails.md Normal file
View File

@@ -0,0 +1,11 @@
# ClientFailureDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**failure_timestamp** | **int** | | [optional]
**reason_code** | **int** | | [optional]
**reason** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
libs/cloudapi/cloudsdk/docs/ClientFailureEvent.md Normal file
View File

@@ -0,0 +1,15 @@
# ClientFailureEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**ssid** | **str** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**reason_code** | [**WlanReasonCode**](WlanReasonCode.md) | | [optional]
**reason_string** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
libs/cloudapi/cloudsdk/docs/ClientFirstDataEvent.md Normal file
View File

@@ -0,0 +1,14 @@
# ClientFirstDataEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**first_data_rcvd_ts** | **int** | | [optional]
**first_data_sent_ts** | **int** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
libs/cloudapi/cloudsdk/docs/ClientIdEvent.md Normal file
View File

@@ -0,0 +1,14 @@
# ClientIdEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**mac_address_bytes** | **list[str]** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**user_id** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

17
libs/cloudapi/cloudsdk/docs/ClientInfoDetails.md Normal file
View File

@@ -0,0 +1,17 @@
# ClientInfoDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alias** | **str** | | [optional]
**client_type** | **int** | | [optional]
**ap_fingerprint** | **str** | | [optional]
**user_name** | **str** | | [optional]
**host_name** | **str** | | [optional]
**last_used_cp_username** | **str** | | [optional]
**last_user_agent** | **str** | | [optional]
**do_not_steer** | **bool** | | [optional]
**blocklist_details** | [**BlocklistDetails**](BlocklistDetails.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ClientIpAddressEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# ClientIpAddressEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**ip_addr** | **list[str]** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

367
libs/cloudapi/cloudsdk/docs/ClientMetrics.md Normal file
View File

@@ -0,0 +1,367 @@
# ClientMetrics
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**seconds_since_last_recv** | **int** | | [optional]
**num_rx_packets** | **int** | | [optional]
**num_tx_packets** | **int** | | [optional]
**num_rx_bytes** | **int** | | [optional]
**num_tx_bytes** | **int** | | [optional]
**tx_retries** | **int** | | [optional]
**rx_duplicate_packets** | **int** | | [optional]
**rate_count** | **int** | | [optional]
**rates** | **list[int]** | | [optional]
**mcs** | **list[int]** | | [optional]
**vht_mcs** | **int** | | [optional]
**snr** | **int** | | [optional]
**rssi** | **int** | | [optional]
**session_id** | **int** | | [optional]
**classification_name** | **str** | | [optional]
**channel_band_width** | [**ChannelBandwidth**](ChannelBandwidth.md) | | [optional]
**guard_interval** | [**GuardInterval**](GuardInterval.md) | | [optional]
**cisco_last_rate** | **int** | | [optional]
**average_tx_rate** | **float** | | [optional]
**average_rx_rate** | **float** | | [optional]
**num_tx_data_frames_12_mbps** | **int** | | [optional]
**num_tx_data_frames_54_mbps** | **int** | | [optional]
**num_tx_data_frames_108_mbps** | **int** | | [optional]
**num_tx_data_frames_300_mbps** | **int** | | [optional]
**num_tx_data_frames_450_mbps** | **int** | | [optional]
**num_tx_data_frames_1300_mbps** | **int** | | [optional]
**num_tx_data_frames_1300_plus_mbps** | **int** | | [optional]
**num_rx_data_frames_12_mbps** | **int** | | [optional]
**num_rx_data_frames_54_mbps** | **int** | | [optional]
**num_rx_data_frames_108_mbps** | **int** | | [optional]
**num_rx_data_frames_300_mbps** | **int** | | [optional]
**num_rx_data_frames_450_mbps** | **int** | | [optional]
**num_rx_data_frames_1300_mbps** | **int** | | [optional]
**num_rx_data_frames_1300_plus_mbps** | **int** | | [optional]
**num_tx_time_frames_transmitted** | **int** | | [optional]
**num_rx_time_to_me** | **int** | | [optional]
**num_tx_time_data** | **int** | | [optional]
**num_rx_time_data** | **int** | | [optional]
**num_tx_frames_transmitted** | **int** | | [optional]
**num_tx_success_with_retry** | **int** | | [optional]
**num_tx_multiple_retries** | **int** | | [optional]
**num_tx_data_transmitted_retried** | **int** | | [optional]
**num_tx_data_transmitted** | **int** | | [optional]
**num_rx_frames_received** | **int** | | [optional]
**num_rx_data_frames_retried** | **int** | | [optional]
**num_rx_data_frames** | **int** | | [optional]
**num_tx_1_mbps** | **int** | | [optional]
**num_tx_6_mbps** | **int** | | [optional]
**num_tx_9_mbps** | **int** | | [optional]
**num_tx_12_mbps** | **int** | | [optional]
**num_tx_18_mbps** | **int** | | [optional]
**num_tx_24_mbps** | **int** | | [optional]
**num_tx_36_mbps** | **int** | | [optional]
**num_tx_48_mbps** | **int** | | [optional]
**num_tx_54_mbps** | **int** | | [optional]
**num_rx_1_mbps** | **int** | | [optional]
**num_rx_6_mbps** | **int** | | [optional]
**num_rx_9_mbps** | **int** | | [optional]
**num_rx_12_mbps** | **int** | | [optional]
**num_rx_18_mbps** | **int** | | [optional]
**num_rx_24_mbps** | **int** | | [optional]
**num_rx_36_mbps** | **int** | | [optional]
**num_rx_48_mbps** | **int** | | [optional]
**num_rx_54_mbps** | **int** | | [optional]
**num_tx_ht_6_5_mbps** | **int** | | [optional]
**num_tx_ht_7_1_mbps** | **int** | | [optional]
**num_tx_ht_13_mbps** | **int** | | [optional]
**num_tx_ht_13_5_mbps** | **int** | | [optional]
**num_tx_ht_14_3_mbps** | **int** | | [optional]
**num_tx_ht_15_mbps** | **int** | | [optional]
**num_tx_ht_19_5_mbps** | **int** | | [optional]
**num_tx_ht_21_7_mbps** | **int** | | [optional]
**num_tx_ht_26_mbps** | **int** | | [optional]
**num_tx_ht_27_mbps** | **int** | | [optional]
**num_tx_ht_28_7_mbps** | **int** | | [optional]
**num_tx_ht_28_8_mbps** | **int** | | [optional]
**num_tx_ht_29_2_mbps** | **int** | | [optional]
**num_tx_ht_30_mbps** | **int** | | [optional]
**num_tx_ht_32_5_mbps** | **int** | | [optional]
**num_tx_ht_39_mbps** | **int** | | [optional]
**num_tx_ht_40_5_mbps** | **int** | | [optional]
**num_tx_ht_43_2_mbps** | **int** | | [optional]
**num_tx_ht_45_mbps** | **int** | | [optional]
**num_tx_ht_52_mbps** | **int** | | [optional]
**num_tx_ht_54_mbps** | **int** | | [optional]
**num_tx_ht_57_5_mbps** | **int** | | [optional]
**num_tx_ht_57_7_mbps** | **int** | | [optional]
**num_tx_ht_58_5_mbps** | **int** | | [optional]
**num_tx_ht_60_mbps** | **int** | | [optional]
**num_tx_ht_65_mbps** | **int** | | [optional]
**num_tx_ht_72_1_mbps** | **int** | | [optional]
**num_tx_ht_78_mbps** | **int** | | [optional]
**num_tx_ht_81_mbps** | **int** | | [optional]
**num_tx_ht_86_6_mbps** | **int** | | [optional]
**num_tx_ht_86_8_mbps** | **int** | | [optional]
**num_tx_ht_87_8_mbps** | **int** | | [optional]
**num_tx_ht_90_mbps** | **int** | | [optional]
**num_tx_ht_97_5_mbps** | **int** | | [optional]
**num_tx_ht_104_mbps** | **int** | | [optional]
**num_tx_ht_108_mbps** | **int** | | [optional]
**num_tx_ht_115_5_mbps** | **int** | | [optional]
**num_tx_ht_117_mbps** | **int** | | [optional]
**num_tx_ht_117_1_mbps** | **int** | | [optional]
**num_tx_ht_120_mbps** | **int** | | [optional]
**num_tx_ht_121_5_mbps** | **int** | | [optional]
**num_tx_ht_130_mbps** | **int** | | [optional]
**num_tx_ht_130_3_mbps** | **int** | | [optional]
**num_tx_ht_135_mbps** | **int** | | [optional]
**num_tx_ht_144_3_mbps** | **int** | | [optional]
**num_tx_ht_150_mbps** | **int** | | [optional]
**num_tx_ht_156_mbps** | **int** | | [optional]
**num_tx_ht_162_mbps** | **int** | | [optional]
**num_tx_ht_173_1_mbps** | **int** | | [optional]
**num_tx_ht_173_3_mbps** | **int** | | [optional]
**num_tx_ht_175_5_mbps** | **int** | | [optional]
**num_tx_ht_180_mbps** | **int** | | [optional]
**num_tx_ht_195_mbps** | **int** | | [optional]
**num_tx_ht_200_mbps** | **int** | | [optional]
**num_tx_ht_208_mbps** | **int** | | [optional]
**num_tx_ht_216_mbps** | **int** | | [optional]
**num_tx_ht_216_6_mbps** | **int** | | [optional]
**num_tx_ht_231_1_mbps** | **int** | | [optional]
**num_tx_ht_234_mbps** | **int** | | [optional]
**num_tx_ht_240_mbps** | **int** | | [optional]
**num_tx_ht_243_mbps** | **int** | | [optional]
**num_tx_ht_260_mbps** | **int** | | [optional]
**num_tx_ht_263_2_mbps** | **int** | | [optional]
**num_tx_ht_270_mbps** | **int** | | [optional]
**num_tx_ht_288_7_mbps** | **int** | | [optional]
**num_tx_ht_288_8_mbps** | **int** | | [optional]
**num_tx_ht_292_5_mbps** | **int** | | [optional]
**num_tx_ht_300_mbps** | **int** | | [optional]
**num_tx_ht_312_mbps** | **int** | | [optional]
**num_tx_ht_324_mbps** | **int** | | [optional]
**num_tx_ht_325_mbps** | **int** | | [optional]
**num_tx_ht_346_7_mbps** | **int** | | [optional]
**num_tx_ht_351_mbps** | **int** | | [optional]
**num_tx_ht_351_2_mbps** | **int** | | [optional]
**num_tx_ht_360_mbps** | **int** | | [optional]
**num_rx_ht_6_5_mbps** | **int** | | [optional]
**num_rx_ht_7_1_mbps** | **int** | | [optional]
**num_rx_ht_13_mbps** | **int** | | [optional]
**num_rx_ht_13_5_mbps** | **int** | | [optional]
**num_rx_ht_14_3_mbps** | **int** | | [optional]
**num_rx_ht_15_mbps** | **int** | | [optional]
**num_rx_ht_19_5_mbps** | **int** | | [optional]
**num_rx_ht_21_7_mbps** | **int** | | [optional]
**num_rx_ht_26_mbps** | **int** | | [optional]
**num_rx_ht_27_mbps** | **int** | | [optional]
**num_rx_ht_28_7_mbps** | **int** | | [optional]
**num_rx_ht_28_8_mbps** | **int** | | [optional]
**num_rx_ht_29_2_mbps** | **int** | | [optional]
**num_rx_ht_30_mbps** | **int** | | [optional]
**num_rx_ht_32_5_mbps** | **int** | | [optional]
**num_rx_ht_39_mbps** | **int** | | [optional]
**num_rx_ht_40_5_mbps** | **int** | | [optional]
**num_rx_ht_43_2_mbps** | **int** | | [optional]
**num_rx_ht_45_mbps** | **int** | | [optional]
**num_rx_ht_52_mbps** | **int** | | [optional]
**num_rx_ht_54_mbps** | **int** | | [optional]
**num_rx_ht_57_5_mbps** | **int** | | [optional]
**num_rx_ht_57_7_mbps** | **int** | | [optional]
**num_rx_ht_58_5_mbps** | **int** | | [optional]
**num_rx_ht_60_mbps** | **int** | | [optional]
**num_rx_ht_65_mbps** | **int** | | [optional]
**num_rx_ht_72_1_mbps** | **int** | | [optional]
**num_rx_ht_78_mbps** | **int** | | [optional]
**num_rx_ht_81_mbps** | **int** | | [optional]
**num_rx_ht_86_6_mbps** | **int** | | [optional]
**num_rx_ht_86_8_mbps** | **int** | | [optional]
**num_rx_ht_87_8_mbps** | **int** | | [optional]
**num_rx_ht_90_mbps** | **int** | | [optional]
**num_rx_ht_97_5_mbps** | **int** | | [optional]
**num_rx_ht_104_mbps** | **int** | | [optional]
**num_rx_ht_108_mbps** | **int** | | [optional]
**num_rx_ht_115_5_mbps** | **int** | | [optional]
**num_rx_ht_117_mbps** | **int** | | [optional]
**num_rx_ht_117_1_mbps** | **int** | | [optional]
**num_rx_ht_120_mbps** | **int** | | [optional]
**num_rx_ht_121_5_mbps** | **int** | | [optional]
**num_rx_ht_130_mbps** | **int** | | [optional]
**num_rx_ht_130_3_mbps** | **int** | | [optional]
**num_rx_ht_135_mbps** | **int** | | [optional]
**num_rx_ht_144_3_mbps** | **int** | | [optional]
**num_rx_ht_150_mbps** | **int** | | [optional]
**num_rx_ht_156_mbps** | **int** | | [optional]
**num_rx_ht_162_mbps** | **int** | | [optional]
**num_rx_ht_173_1_mbps** | **int** | | [optional]
**num_rx_ht_173_3_mbps** | **int** | | [optional]
**num_rx_ht_175_5_mbps** | **int** | | [optional]
**num_rx_ht_180_mbps** | **int** | | [optional]
**num_rx_ht_195_mbps** | **int** | | [optional]
**num_rx_ht_200_mbps** | **int** | | [optional]
**num_rx_ht_208_mbps** | **int** | | [optional]
**num_rx_ht_216_mbps** | **int** | | [optional]
**num_rx_ht_216_6_mbps** | **int** | | [optional]
**num_rx_ht_231_1_mbps** | **int** | | [optional]
**num_rx_ht_234_mbps** | **int** | | [optional]
**num_rx_ht_240_mbps** | **int** | | [optional]
**num_rx_ht_243_mbps** | **int** | | [optional]
**num_rx_ht_260_mbps** | **int** | | [optional]
**num_rx_ht_263_2_mbps** | **int** | | [optional]
**num_rx_ht_270_mbps** | **int** | | [optional]
**num_rx_ht_288_7_mbps** | **int** | | [optional]
**num_rx_ht_288_8_mbps** | **int** | | [optional]
**num_rx_ht_292_5_mbps** | **int** | | [optional]
**num_rx_ht_300_mbps** | **int** | | [optional]
**num_rx_ht_312_mbps** | **int** | | [optional]
**num_rx_ht_324_mbps** | **int** | | [optional]
**num_rx_ht_325_mbps** | **int** | | [optional]
**num_rx_ht_346_7_mbps** | **int** | | [optional]
**num_rx_ht_351_mbps** | **int** | | [optional]
**num_rx_ht_351_2_mbps** | **int** | | [optional]
**num_rx_ht_360_mbps** | **int** | | [optional]
**num_tx_vht_292_5_mbps** | **int** | | [optional]
**num_tx_vht_325_mbps** | **int** | | [optional]
**num_tx_vht_364_5_mbps** | **int** | | [optional]
**num_tx_vht_390_mbps** | **int** | | [optional]
**num_tx_vht_400_mbps** | **int** | | [optional]
**num_tx_vht_403_mbps** | **int** | | [optional]
**num_tx_vht_405_mbps** | **int** | | [optional]
**num_tx_vht_432_mbps** | **int** | | [optional]
**num_tx_vht_433_2_mbps** | **int** | | [optional]
**num_tx_vht_450_mbps** | **int** | | [optional]
**num_tx_vht_468_mbps** | **int** | | [optional]
**num_tx_vht_480_mbps** | **int** | | [optional]
**num_tx_vht_486_mbps** | **int** | | [optional]
**num_tx_vht_520_mbps** | **int** | | [optional]
**num_tx_vht_526_5_mbps** | **int** | | [optional]
**num_tx_vht_540_mbps** | **int** | | [optional]
**num_tx_vht_585_mbps** | **int** | | [optional]
**num_tx_vht_600_mbps** | **int** | | [optional]
**num_tx_vht_648_mbps** | **int** | | [optional]
**num_tx_vht_650_mbps** | **int** | | [optional]
**num_tx_vht_702_mbps** | **int** | | [optional]
**num_tx_vht_720_mbps** | **int** | | [optional]
**num_tx_vht_780_mbps** | **int** | | [optional]
**num_tx_vht_800_mbps** | **int** | | [optional]
**num_tx_vht_866_7_mbps** | **int** | | [optional]
**num_tx_vht_877_5_mbps** | **int** | | [optional]
**num_tx_vht_936_mbps** | **int** | | [optional]
**num_tx_vht_975_mbps** | **int** | | [optional]
**num_tx_vht_1040_mbps** | **int** | | [optional]
**num_tx_vht_1053_mbps** | **int** | | [optional]
**num_tx_vht_1053_1_mbps** | **int** | | [optional]
**num_tx_vht_1170_mbps** | **int** | | [optional]
**num_tx_vht_1300_mbps** | **int** | | [optional]
**num_tx_vht_1404_mbps** | **int** | | [optional]
**num_tx_vht_1560_mbps** | **int** | | [optional]
**num_tx_vht_1579_5_mbps** | **int** | | [optional]
**num_tx_vht_1733_1_mbps** | **int** | | [optional]
**num_tx_vht_1733_4_mbps** | **int** | | [optional]
**num_tx_vht_1755_mbps** | **int** | | [optional]
**num_tx_vht_1872_mbps** | **int** | | [optional]
**num_tx_vht_1950_mbps** | **int** | | [optional]
**num_tx_vht_2080_mbps** | **int** | | [optional]
**num_tx_vht_2106_mbps** | **int** | | [optional]
**num_tx_vht_2340_mbps** | **int** | | [optional]
**num_tx_vht_2600_mbps** | **int** | | [optional]
**num_tx_vht_2808_mbps** | **int** | | [optional]
**num_tx_vht_3120_mbps** | **int** | | [optional]
**num_tx_vht_3466_8_mbps** | **int** | | [optional]
**num_rx_vht_292_5_mbps** | **int** | | [optional]
**num_rx_vht_325_mbps** | **int** | | [optional]
**num_rx_vht_364_5_mbps** | **int** | | [optional]
**num_rx_vht_390_mbps** | **int** | | [optional]
**num_rx_vht_400_mbps** | **int** | | [optional]
**num_rx_vht_403_mbps** | **int** | | [optional]
**num_rx_vht_405_mbps** | **int** | | [optional]
**num_rx_vht_432_mbps** | **int** | | [optional]
**num_rx_vht_433_2_mbps** | **int** | | [optional]
**num_rx_vht_450_mbps** | **int** | | [optional]
**num_rx_vht_468_mbps** | **int** | | [optional]
**num_rx_vht_480_mbps** | **int** | | [optional]
**num_rx_vht_486_mbps** | **int** | | [optional]
**num_rx_vht_520_mbps** | **int** | | [optional]
**num_rx_vht_526_5_mbps** | **int** | | [optional]
**num_rx_vht_540_mbps** | **int** | | [optional]
**num_rx_vht_585_mbps** | **int** | | [optional]
**num_rx_vht_600_mbps** | **int** | | [optional]
**num_rx_vht_648_mbps** | **int** | | [optional]
**num_rx_vht_650_mbps** | **int** | | [optional]
**num_rx_vht_702_mbps** | **int** | | [optional]
**num_rx_vht_720_mbps** | **int** | | [optional]
**num_rx_vht_780_mbps** | **int** | | [optional]
**num_rx_vht_800_mbps** | **int** | | [optional]
**num_rx_vht_866_7_mbps** | **int** | | [optional]
**num_rx_vht_877_5_mbps** | **int** | | [optional]
**num_rx_vht_936_mbps** | **int** | | [optional]
**num_rx_vht_975_mbps** | **int** | | [optional]
**num_rx_vht_1040_mbps** | **int** | | [optional]
**num_rx_vht_1053_mbps** | **int** | | [optional]
**num_rx_vht_1053_1_mbps** | **int** | | [optional]
**num_rx_vht_1170_mbps** | **int** | | [optional]
**num_rx_vht_1300_mbps** | **int** | | [optional]
**num_rx_vht_1404_mbps** | **int** | | [optional]
**num_rx_vht_1560_mbps** | **int** | | [optional]
**num_rx_vht_1579_5_mbps** | **int** | | [optional]
**num_rx_vht_1733_1_mbps** | **int** | | [optional]
**num_rx_vht_1733_4_mbps** | **int** | | [optional]
**num_rx_vht_1755_mbps** | **int** | | [optional]
**num_rx_vht_1872_mbps** | **int** | | [optional]
**num_rx_vht_1950_mbps** | **int** | | [optional]
**num_rx_vht_2080_mbps** | **int** | | [optional]
**num_rx_vht_2106_mbps** | **int** | | [optional]
**num_rx_vht_2340_mbps** | **int** | | [optional]
**num_rx_vht_2600_mbps** | **int** | | [optional]
**num_rx_vht_2808_mbps** | **int** | | [optional]
**num_rx_vht_3120_mbps** | **int** | | [optional]
**num_rx_vht_3466_8_mbps** | **int** | | [optional]
**rx_last_rssi** | **int** | The RSSI of last frame received. | [optional]
**num_rx_no_fcs_err** | **int** | The number of received frames without FCS errors. | [optional]
**num_rx_data** | **int** | The number of received data frames. | [optional]
**num_rx_management** | **int** | The number of received management frames. | [optional]
**num_rx_control** | **int** | The number of received control frames. | [optional]
**rx_bytes** | **int** | The number of received bytes. | [optional]
**rx_data_bytes** | **int** | The number of received data bytes. | [optional]
**num_rx_rts** | **int** | The number of received RTS frames. | [optional]
**num_rx_cts** | **int** | The number of received CTS frames. | [optional]
**num_rx_ack** | **int** | The number of all received ACK frames (Acks + BlockAcks). | [optional]
**num_rx_probe_req** | **int** | The number of received probe request frames. | [optional]
**num_rx_retry** | **int** | The number of received retry frames. | [optional]
**num_rx_dup** | **int** | The number of received duplicated frames. | [optional]
**num_rx_null_data** | **int** | The number of received null data frames. | [optional]
**num_rx_pspoll** | **int** | The number of received ps-poll frames. | [optional]
**num_rx_stbc** | **int** | The number of received STBC frames. | [optional]
**num_rx_ldpc** | **int** | The number of received LDPC frames. | [optional]
**last_recv_layer3_ts** | **int** | The timestamp of last received layer three user traffic (IP data) | [optional]
**num_rcv_frame_for_tx** | **int** | The number of received ethernet and local generated frames for transmit. | [optional]
**num_tx_queued** | **int** | The number of TX frames queued. | [optional]
**num_tx_dropped** | **int** | The number of every TX frame dropped. | [optional]
**num_tx_retry_dropped** | **int** | The number of TX frame dropped due to retries. | [optional]
**num_tx_succ** | **int** | The number of frames successfully transmitted. | [optional]
**num_tx_byte_succ** | **int** | The Number of Tx bytes successfully transmitted. | [optional]
**num_tx_succ_no_retry** | **int** | The number of successfully transmitted frames at first attempt. | [optional]
**num_tx_succ_retries** | **int** | The number of successfully transmitted frames with retries. | [optional]
**num_tx_multi_retries** | **int** | The number of Tx frames with retries. | [optional]
**num_tx_management** | **int** | The number of TX management frames. | [optional]
**num_tx_control** | **int** | The number of Tx control frames. | [optional]
**num_tx_action** | **int** | The number of Tx action frames. | [optional]
**num_tx_prop_resp** | **int** | The number of TX probe response. | [optional]
**num_tx_data** | **int** | The number of Tx data frames. | [optional]
**num_tx_data_retries** | **int** | The number of Tx data frames with retries,done. | [optional]
**num_tx_rts_succ** | **int** | The number of RTS frames sent successfully, done. | [optional]
**num_tx_rts_fail** | **int** | The number of RTS frames failed transmission. | [optional]
**num_tx_no_ack** | **int** | The number of TX frames failed because of not Acked. | [optional]
**num_tx_eapol** | **int** | The number of EAPOL frames sent. | [optional]
**num_tx_ldpc** | **int** | The number of total LDPC frames sent. | [optional]
**num_tx_stbc** | **int** | The number of total STBC frames sent. | [optional]
**num_tx_aggr_succ** | **int** | The number of aggregation frames sent successfully. | [optional]
**num_tx_aggr_one_mpdu** | **int** | The number of aggregation frames sent using single MPDU (where the A-MPDU contains only one MPDU ). | [optional]
**last_sent_layer3_ts** | **int** | The timestamp of last successfully sent layer three user traffic (IP data). | [optional]
**wmm_queue_stats** | [**WmmQueueStatsPerQueueTypeMap**](WmmQueueStatsPerQueueTypeMap.md) | | [optional]
**list_mcs_stats_mcs_stats** | [**list[McsStats]**](McsStats.md) | | [optional]
**last_rx_mcs_idx** | [**McsType**](McsType.md) | | [optional]
**last_tx_mcs_idx** | [**McsType**](McsType.md) | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**period_length_sec** | **int** | How many seconds the AP measured for the metric | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/ClientRemovedEvent.md Normal file
View File

@@ -0,0 +1,12 @@
# ClientRemovedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**payload** | [**Client**](Client.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ClientSession.md Normal file
View File

@@ -0,0 +1,13 @@
# ClientSession
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**details** | [**ClientSessionDetails**](ClientSessionDetails.md) | | [optional]
**last_modified_timestamp** | **int** | This class does not perform checks against concurrrent updates. Here last update always wins. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ClientSessionChangedEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# ClientSessionChangedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**payload** | [**ClientSession**](ClientSession.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

53
libs/cloudapi/cloudsdk/docs/ClientSessionDetails.md Normal file
View File

@@ -0,0 +1,53 @@
# ClientSessionDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**session_id** | **int** | | [optional]
**auth_timestamp** | **int** | | [optional]
**assoc_timestamp** | **int** | | [optional]
**assoc_internal_sc** | **int** | | [optional]
**ip_timestamp** | **int** | | [optional]
**disconnect_by_ap_timestamp** | **int** | | [optional]
**disconnect_by_client_timestamp** | **int** | | [optional]
**timeout_timestamp** | **int** | | [optional]
**first_data_sent_timestamp** | **int** | | [optional]
**first_data_rcvd_timestamp** | **int** | | [optional]
**ip_address** | **str** | | [optional]
**radius_username** | **str** | | [optional]
**ssid** | **str** | | [optional]
**radio_type** | [**RadioType**](RadioType.md) | | [optional]
**last_event_timestamp** | **int** | | [optional]
**hostname** | **str** | | [optional]
**ap_fingerprint** | **str** | | [optional]
**user_agent_str** | **str** | | [optional]
**last_rx_timestamp** | **int** | | [optional]
**last_tx_timestamp** | **int** | | [optional]
**cp_username** | **str** | | [optional]
**dhcp_details** | [**ClientDhcpDetails**](ClientDhcpDetails.md) | | [optional]
**eap_details** | [**ClientEapDetails**](ClientEapDetails.md) | | [optional]
**metric_details** | [**ClientSessionMetricDetails**](ClientSessionMetricDetails.md) | | [optional]
**is_reassociation** | **bool** | | [optional]
**disconnect_by_ap_reason_code** | **int** | | [optional]
**disconnect_by_client_reason_code** | **int** | | [optional]
**disconnect_by_ap_internal_reason_code** | **int** | | [optional]
**disconnect_by_client_internal_reason_code** | **int** | | [optional]
**port_enabled_timestamp** | **int** | | [optional]
**is11_r_used** | **bool** | | [optional]
**is11_k_used** | **bool** | | [optional]
**is11_v_used** | **bool** | | [optional]
**security_type** | [**SecurityType**](SecurityType.md) | | [optional]
**steer_type** | [**SteerType**](SteerType.md) | | [optional]
**previous_valid_session_id** | **int** | | [optional]
**last_failure_details** | [**ClientFailureDetails**](ClientFailureDetails.md) | | [optional]
**first_failure_details** | [**ClientFailureDetails**](ClientFailureDetails.md) | | [optional]
**association_status** | **int** | | [optional]
**dynamic_vlan** | **int** | | [optional]
**assoc_rssi** | **int** | | [optional]
**prior_session_id** | **int** | | [optional]
**prior_equipment_id** | **int** | | [optional]
**classification_name** | **str** | | [optional]
**association_state** | **str** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

25
libs/cloudapi/cloudsdk/docs/ClientSessionMetricDetails.md Normal file
View File

@@ -0,0 +1,25 @@
# ClientSessionMetricDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rx_bytes** | **int** | | [optional]
**tx_bytes** | **int** | | [optional]
**total_rx_packets** | **int** | | [optional]
**total_tx_packets** | **int** | | [optional]
**rx_mbps** | **float** | | [optional]
**tx_mbps** | **float** | | [optional]
**rssi** | **int** | | [optional]
**snr** | **int** | | [optional]
**rx_rate_kbps** | **int** | | [optional]
**tx_rate_kbps** | **int** | | [optional]
**last_metric_timestamp** | **int** | | [optional]
**last_rx_timestamp** | **int** | | [optional]
**last_tx_timestamp** | **int** | | [optional]
**classification** | **str** | | [optional]
**tx_data_frames** | **int** | The number of dataframes transmitted TO the client from the AP. | [optional]
**tx_data_frames_retried** | **int** | The number of data frames transmitted TO the client that were retried. Note this is not the same as the number of retries. | [optional]
**rx_data_frames** | **int** | The number of dataframes transmitted FROM the client TO the AP. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/ClientSessionRemovedEvent.md Normal file
View File

@@ -0,0 +1,13 @@
# ClientSessionRemovedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**equipment_id** | **int** | | [optional]
**payload** | [**ClientSession**](ClientSession.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
libs/cloudapi/cloudsdk/docs/ClientTimeoutEvent.md Normal file
View File

@@ -0,0 +1,15 @@
# ClientTimeoutEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**all_of** | [**RealTimeEvent**](RealTimeEvent.md) | | [optional]
**session_id** | **int** | | [optional]
**client_mac_address** | [**MacAddress**](MacAddress.md) | | [optional]
**last_recv_time** | **int** | | [optional]
**last_sent_time** | **int** | | [optional]
**timeout_reason** | [**ClientTimeoutReason**](ClientTimeoutReason.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/ClientTimeoutReason.md Normal file
View File

@@ -0,0 +1,8 @@
# ClientTimeoutReason
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

367
libs/cloudapi/cloudsdk/docs/ClientsApi.md Normal file
View File

@@ -0,0 +1,367 @@
# swagger_client.ClientsApi
All URIs are relative to *https://localhost:9091*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_all_client_sessions_in_set**](ClientsApi.md#get_all_client_sessions_in_set) | **GET** /portal/client/session/inSet | Get list of Client sessions for customerId and a set of client MAC addresses.
[**get_all_clients_in_set**](ClientsApi.md#get_all_clients_in_set) | **GET** /portal/client/inSet | Get list of Clients for customerId and a set of client MAC addresses.
[**get_blocked_clients**](ClientsApi.md#get_blocked_clients) | **GET** /portal/client/blocked | Retrieves a list of Clients for the customer that are marked as blocked. This per-customer list of blocked clients is pushed to every AP, so it has to be limited in size.
[**get_client_session_by_customer_with_filter**](ClientsApi.md#get_client_session_by_customer_with_filter) | **GET** /portal/client/session/forCustomer | Get list of Client sessions for customerId and a set of equipment/location ids. Equipment and locations filters are joined using logical AND operation.
[**get_for_customer**](ClientsApi.md#get_for_customer) | **GET** /portal/client/forCustomer | Get list of clients for a given customer by equipment ids
[**search_by_mac_address**](ClientsApi.md#search_by_mac_address) | **GET** /portal/client/searchByMac | Get list of Clients for customerId and searching by macSubstring.
[**update_client**](ClientsApi.md#update_client) | **PUT** /portal/client | Update Client
# **get_all_client_sessions_in_set**
> list[ClientSession] get_all_client_sessions_in_set(customer_id, client_macs)
Get list of Client sessions for customerId and a set of client MAC addresses.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
client_macs = ['client_macs_example'] # list[str] | Set of client MAC addresses.
try:
# Get list of Client sessions for customerId and a set of client MAC addresses.
api_response = api_instance.get_all_client_sessions_in_set(customer_id, client_macs)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->get_all_client_sessions_in_set: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**client_macs** | [**list[str]**](str.md)| Set of client MAC addresses. |
### Return type
[**list[ClientSession]**](ClientSession.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_all_clients_in_set**
> list[Client] get_all_clients_in_set(customer_id, client_macs)
Get list of Clients for customerId and a set of client MAC addresses.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
client_macs = ['client_macs_example'] # list[str] | Set of client MAC addresses.
try:
# Get list of Clients for customerId and a set of client MAC addresses.
api_response = api_instance.get_all_clients_in_set(customer_id, client_macs)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->get_all_clients_in_set: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**client_macs** | [**list[str]**](str.md)| Set of client MAC addresses. |
### Return type
[**list[Client]**](Client.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_blocked_clients**
> list[Client] get_blocked_clients(customer_id)
Retrieves a list of Clients for the customer that are marked as blocked. This per-customer list of blocked clients is pushed to every AP, so it has to be limited in size.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | Customer ID
try:
# Retrieves a list of Clients for the customer that are marked as blocked. This per-customer list of blocked clients is pushed to every AP, so it has to be limited in size.
api_response = api_instance.get_blocked_clients(customer_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->get_blocked_clients: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| Customer ID |
### Return type
[**list[Client]**](Client.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_client_session_by_customer_with_filter**
> PaginationResponseClientSession get_client_session_by_customer_with_filter(customer_id, pagination_context, equipment_ids=equipment_ids, location_ids=location_ids, sort_by=sort_by)
Get list of Client sessions for customerId and a set of equipment/location ids. Equipment and locations filters are joined using logical AND operation.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
pagination_context = swagger_client.PaginationContextClientSession() # PaginationContextClientSession | pagination context
equipment_ids = [56] # list[int] | set of equipment ids. Empty or null means retrieve all equipment for the customer. (optional)
location_ids = [56] # list[int] | set of location ids. Empty or null means retrieve for all locations for the customer. (optional)
sort_by = [swagger_client.SortColumnsClientSession()] # list[SortColumnsClientSession] | sort options (optional)
try:
# Get list of Client sessions for customerId and a set of equipment/location ids. Equipment and locations filters are joined using logical AND operation.
api_response = api_instance.get_client_session_by_customer_with_filter(customer_id, pagination_context, equipment_ids=equipment_ids, location_ids=location_ids, sort_by=sort_by)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->get_client_session_by_customer_with_filter: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**pagination_context** | [**PaginationContextClientSession**](.md)| pagination context |
**equipment_ids** | [**list[int]**](int.md)| set of equipment ids. Empty or null means retrieve all equipment for the customer. | [optional]
**location_ids** | [**list[int]**](int.md)| set of location ids. Empty or null means retrieve for all locations for the customer. | [optional]
**sort_by** | [**list[SortColumnsClientSession]**](SortColumnsClientSession.md)| sort options | [optional]
### Return type
[**PaginationResponseClientSession**](PaginationResponseClientSession.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **get_for_customer**
> PaginationResponseClient get_for_customer(customer_id, equipment_ids=equipment_ids, sort_by=sort_by, pagination_context=pagination_context)
Get list of clients for a given customer by equipment ids
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | Customer ID
equipment_ids = [56] # list[int] | Equipment ID (optional)
sort_by = [swagger_client.SortColumnsClient()] # list[SortColumnsClient] | sort options (optional)
pagination_context = swagger_client.PaginationContextClient() # PaginationContextClient | pagination context (optional)
try:
# Get list of clients for a given customer by equipment ids
api_response = api_instance.get_for_customer(customer_id, equipment_ids=equipment_ids, sort_by=sort_by, pagination_context=pagination_context)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->get_for_customer: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| Customer ID |
**equipment_ids** | [**list[int]**](int.md)| Equipment ID | [optional]
**sort_by** | [**list[SortColumnsClient]**](SortColumnsClient.md)| sort options | [optional]
**pagination_context** | [**PaginationContextClient**](.md)| pagination context | [optional]
### Return type
[**PaginationResponseClient**](PaginationResponseClient.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **search_by_mac_address**
> PaginationResponseClient search_by_mac_address(customer_id, mac_substring=mac_substring, sort_by=sort_by, pagination_context=pagination_context)
Get list of Clients for customerId and searching by macSubstring.
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
mac_substring = 'mac_substring_example' # str | MacAddress search criteria (optional)
sort_by = [swagger_client.SortColumnsClient()] # list[SortColumnsClient] | sort options (optional)
pagination_context = swagger_client.PaginationContextClient() # PaginationContextClient | pagination context (optional)
try:
# Get list of Clients for customerId and searching by macSubstring.
api_response = api_instance.search_by_mac_address(customer_id, mac_substring=mac_substring, sort_by=sort_by, pagination_context=pagination_context)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->search_by_mac_address: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
**mac_substring** | **str**| MacAddress search criteria | [optional]
**sort_by** | [**list[SortColumnsClient]**](SortColumnsClient.md)| sort options | [optional]
**pagination_context** | [**PaginationContextClient**](.md)| pagination context | [optional]
### Return type
[**PaginationResponseClient**](PaginationResponseClient.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_client**
> Client update_client(body)
Update Client
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.ClientsApi(swagger_client.ApiClient(configuration))
body = swagger_client.Client() # Client | Client info
try:
# Update Client
api_response = api_instance.update_client(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ClientsApi->update_client: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| Client info |
### Return type
[**Client**](Client.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/CommonProbeDetails.md Normal file
View File

@@ -0,0 +1,12 @@
# CommonProbeDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**latency_ms** | [**MinMaxAvgValueInt**](MinMaxAvgValueInt.md) | | [optional]
**num_success_probe_requests** | **int** | | [optional]
**num_failed_probe_requests** | **int** | | [optional]
**status** | [**StatusCode**](StatusCode.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/CountryCode.md Normal file
View File

@@ -0,0 +1,8 @@
# CountryCode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/CountsPerAlarmCodeMap.md Normal file
View File

@@ -0,0 +1,8 @@
# CountsPerAlarmCodeMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8
libs/cloudapi/cloudsdk/docs/CountsPerEquipmentIdPerAlarmCodeMap.md Normal file
View File

@@ -0,0 +1,8 @@
# CountsPerEquipmentIdPerAlarmCodeMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14
libs/cloudapi/cloudsdk/docs/Customer.md Normal file
View File

@@ -0,0 +1,14 @@
# Customer
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**email** | **str** | |
**name** | **str** | |
**details** | [**CustomerDetails**](CustomerDetails.md) | | [optional]
**created_timestamp** | **int** | | [optional]
**last_modified_timestamp** | **int** | must be provided for update operation, update will be rejected if provided value does not match the one currently stored in the database |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/CustomerAddedEvent.md Normal file
View File

@@ -0,0 +1,12 @@
# CustomerAddedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**payload** | [**Customer**](Customer.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

103
libs/cloudapi/cloudsdk/docs/CustomerApi.md Normal file
View File

@@ -0,0 +1,103 @@
# swagger_client.CustomerApi
All URIs are relative to *https://localhost:9091*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_customer_by_id**](CustomerApi.md#get_customer_by_id) | **GET** /portal/customer | Get Customer By Id
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /portal/customer | Update Customer
# **get_customer_by_id**
> Customer get_customer_by_id(customer_id)
Get Customer By Id
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.CustomerApi(swagger_client.ApiClient(configuration))
customer_id = 56 # int | customer id
try:
# Get Customer By Id
api_response = api_instance.get_customer_by_id(customer_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomerApi->get_customer_by_id: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**customer_id** | **int**| customer id |
### Return type
[**Customer**](Customer.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **update_customer**
> Customer update_customer(body)
Update Customer
### Example
```python
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.CustomerApi(swagger_client.ApiClient(configuration))
body = swagger_client.Customer() # Customer | customer info
try:
# Update Customer
api_response = api_instance.update_customer(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomerApi->update_customer: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Customer**](Customer.md)| customer info |
### Return type
[**Customer**](Customer.md)
### Authorization
[tip_wlan_ts_auth](../README.md#tip_wlan_ts_auth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/CustomerChangedEvent.md Normal file
View File

@@ -0,0 +1,12 @@
# CustomerChangedEvent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**model_type** | **str** | |
**event_timestamp** | **int** | | [optional]
**customer_id** | **int** | | [optional]
**payload** | [**Customer**](Customer.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
libs/cloudapi/cloudsdk/docs/CustomerDetails.md Normal file
View File

@@ -0,0 +1,9 @@
# CustomerDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto_provisioning** | [**EquipmentAutoProvisioningSettings**](EquipmentAutoProvisioningSettings.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
libs/cloudapi/cloudsdk/docs/CustomerFirmwareTrackRecord.md Normal file
View File

@@ -0,0 +1,13 @@
# CustomerFirmwareTrackRecord
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**customer_id** | **int** | | [optional]
**track_record_id** | **int** | | [optional]
**settings** | [**CustomerFirmwareTrackSettings**](CustomerFirmwareTrackSettings.md) | | [optional]
**created_timestamp** | **int** | | [optional]
**last_modified_timestamp** | **int** | must be provided for update operation, update will be rejected if provided value does not match the one currently stored in the database | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

12
libs/cloudapi/cloudsdk/docs/CustomerFirmwareTrackSettings.md Normal file
View File

@@ -0,0 +1,12 @@
# CustomerFirmwareTrackSettings
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auto_upgrade_deprecated_on_bind** | [**TrackFlag**](TrackFlag.md) | | [optional]
**auto_upgrade_unknown_on_bind** | [**TrackFlag**](TrackFlag.md) | | [optional]
**auto_upgrade_deprecated_during_maintenance** | [**TrackFlag**](TrackFlag.md) | | [optional]
**auto_upgrade_unknown_during_maintenance** | [**TrackFlag**](TrackFlag.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Some files were not shown because too many files have changed in this diff Show More