mirror of
https://github.com/Telecominfraproject/wlan-docs.git
synced 2025-11-24 05:34:54 +00:00
GitBook: [#4] No subject
This commit is contained in:
Jaspreet Sachdev
committed by
gitbook-bot
gitbook-bot
parent
f0f49e6e78
commit
08a4761829
BIN
.gitbook/assets/image (22) (1) (1).png
Normal file
BIN
.gitbook/assets/image (22) (1) (1).png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 125 KiB |
1409
.gitbook/assets/owanalytics.yaml
Normal file
1409
.gitbook/assets/owanalytics.yaml
Normal file
File diff suppressed because it is too large
Load Diff
3081
.gitbook/assets/owprov (1).yaml
Normal file
3081
.gitbook/assets/owprov (1).yaml
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -8,8 +8,8 @@
|
||||
* [About the OpenWiFi SDK](about-openwifi/about-the-sdk.md)
|
||||
* [OpenWiFi Firmware](about-openwifi/firmware.md)
|
||||
* [About Device Provisioning](about-openwifi/device-provisioning.md)
|
||||
+ [Supported Hardware](about-openwifi/supported-hardware.md)
|
||||
+ [Integrations](about-openwifi/openwifi-stack.md)
|
||||
* [Supported Hardware](about-openwifi/supported-hardware.md)
|
||||
* [Integrations](about-openwifi/openwifi-stack.md)
|
||||
* [Ordering OpenWiFi APs](ordering-open-wi-fi-aps.md)
|
||||
* [Device Partner Information](device-partner-information.md)
|
||||
* [Cloud Partner Information](cloud-partner-information.md)
|
||||
@@ -35,6 +35,7 @@
|
||||
* [Gateway Service](api/gateway-service.md)
|
||||
* [Firmware Management Service](api/firmware-management-service.md)
|
||||
* [Provisioning Service](api/provisioning-service.md)
|
||||
* [Analytics Service](api/analytics-service.md)
|
||||
* [Monitoring](monitoring/README.md)
|
||||
* [ELK Integration](monitoring/elk-integration.md)
|
||||
|
||||
|
||||
5
api/analytics-service.md
Normal file
5
api/analytics-service.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Analytics Service
|
||||
|
||||
{% swagger src="../.gitbook/assets/owanalytics.yaml" path="undefined" method="undefined" %}
|
||||
[owanalytics.yaml](../.gitbook/assets/owanalytics.yaml)
|
||||
{% endswagger %}
|
||||
@@ -1,213 +1,209 @@
|
||||
# Provisioning Service
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="undefined" method="undefined" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/entity/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/entity/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/entity/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/entity/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/entity/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/entity/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/entity/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/contact" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/contact" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/contact/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/contact/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/contact/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/contact/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/contact/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/contact/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/contact/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/contact/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/location" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/location" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/location/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/location/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/location/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/location/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/location/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/location/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/location/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/location/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/inventory" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/inventory" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/inventory/{serialNumber}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/inventory/{serialNumber}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/inventory/{serialNumber}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/inventory/{serialNumber}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/inventory/{serialNumber}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/inventory/{serialNumber}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/inventory/{serialNumber}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/inventory/{serialNumber}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/venue" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/venue" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/venue/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/venue/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/venue/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/venue/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/venue/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/venue/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/venue/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/venue/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/map" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/map" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/map/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/map/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/map/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/map/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/map/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/map/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/map/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/map/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementPolicy" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementPolicy" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementPolicy/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementPolicy/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementPolicy/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementPolicy/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementPolicy/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementPolicy/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementPolicy/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementPolicy/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementRole" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementRole" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementRole/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementRole/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementRole/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementRole/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/managementRole/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/managementRole/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/configurations" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/configurations" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/configurations/{uuid}" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/configurations/{uuid}" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/configurations/{uuid}" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/configurations/{uuid}" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/configurations/{uuid}" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/configurations/{uuid}" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/configurations/{uuid}" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/configurations/{uuid}" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/iptocountry" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/iptocountry" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/signup" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/signup" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/signup" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/signup" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/signup" method="put" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/signup" method="put" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/signup" method="delete" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/signup" method="delete" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/variables" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/variables" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/dashboard" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/dashboard" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/system" method="get" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/system" method="get" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
{% swagger src="../.gitbook/assets/owprov.yaml" path="/system" method="post" %}
|
||||
[owprov.yaml](../.gitbook/assets/owprov.yaml)
|
||||
{% swagger src="../.gitbook/assets/owprov (1).yaml" path="/system" method="post" %}
|
||||
[owprov (1).yaml](<../.gitbook/assets/owprov (1).yaml>)
|
||||
{% endswagger %}
|
||||
|
||||
@@ -10,7 +10,7 @@ Express Wi-Fi partners with service providers to deliver great wi-fi to people w
|
||||
|
||||
For information about becoming an expressWIFI partner please visit their [site.](https://expresswifi.fb.com)
|
||||
|
||||
.png>)
|
||||
.png>)
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ Given many cloud and ODM partners wish to consume the 2.0 reference stack early,
|
||||
|
||||
## Device Interactions with SDK
|
||||
|
||||
 (2).png>)
|
||||
 (1).png>)
|
||||
|
||||
OpenWiFi 2.0 follows the uCentral system. Complete data model is available [here](http://ucentral.io/docs/ucentral-schema.html). Upon discovery of the cloud, a device default or specific configuration is transferred.
|
||||
|
||||
|
||||
@@ -15,43 +15,43 @@ Association with and logging in to the device will permit initial WAN connectivi
|
||||
|
||||
## Using Maverick
|
||||
|
||||
|
||||
|
||||
|
||||
After association to the Maverick SSID, open a web browser to `http://192.168.1.1`\
|
||||
Log into the OpenWiFi device with username: **`root`** and password: **`openwifi`**
|
||||
|
||||
|
||||
|
||||
|
||||
When the page above is displayed, begin to configure Uplink based on the WAN requirements of the deployment.
|
||||
|
||||
|
||||
|
||||
|
||||
If connection uses Point to Point over Ethernet (PPPoE) username and password credentials, enter those values and save.
|
||||
|
||||
|
||||
|
||||
|
||||
If the OpenWiFi device has a Cellular connection which is possible on device models with 4G and 5G radios, the network Access Point Name (APN) and PIN will be required. These values are supplied by your mobile network provider.
|
||||
|
||||
|
||||
|
||||
|
||||
When dynamic address allocation is not available, static IP address assignment may be required. IPv4 and IPv6 are supported, enter these values with DNS address and save.
|
||||
|
||||
|
||||
|
||||
|
||||
Otherwise leave the Uplink configuration to DHCP or cloud defaults.
|
||||
|
||||
|
||||
|
||||
|
||||
## Manual Redirector and Certificate Upload
|
||||
|
||||
If under rare circumstances it is not possible to discover the OpenWiFi cloud associated with the device or there is a need to replace device certificates, this may be configured in Settings.
|
||||
|
||||
|
||||
|
||||
|
||||
## System
|
||||
|
||||
It is possible to reset the device to defaults, or locally update firmware using the commands available from System.
|
||||
|
||||
|
||||
|
||||
|
||||
\*\*\*\*
|
||||
|
||||
@@ -6,7 +6,7 @@ description: Kafka integration with ELK
|
||||
|
||||
The following pipeline is used to leverage Kafka messages being emitted from OpenWiFi 2.0 for ELK (Elastic Logstash Kibana) stack integration :
|
||||
|
||||
|
||||
|
||||
|
||||
TIP OpenWiFi project has deployed an ELK stack for community members to access [here](https://kibana.lab.wlan.tip.build).
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ Upon successful connection the device exchanges its capabilities with the OpenWi
|
||||
Within OpenWiFi devices, the uCentral agent has a reader and renderer process providing serialization and validation of data sent from cloud.\
|
||||
If any data presented can not be processed by the local agent, this is returned within an ERROR message using the same websocket connection.
|
||||
|
||||
 (1).png>)
|
||||
 (1) (1).png>)
|
||||
|
||||
If the device agrees with provisioning information presented, the render process builds calls into the operating system configuration sub-system known as UCI. The Unified Configuration Interface ensures OpenWrt compliant syntax is persisted within the device.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ The complete data model may be found here : [https://ucentral.io/docs/ucentral-s
|
||||
|
||||
Each device has a Universally Unique Identifier (UUID). For each device, the configuration presented either manually, via the future Provisioning service from OpenWifi or via a commercial controller generation of provisioning data, the high level relationships of the schema may be understood as follows.
|
||||
|
||||
.png>)
|
||||
.png>)
|
||||
|
||||
The unique device record has a set of top level configurations. A device is referred to as a 'unit' that may have a Description, Location, TimeZone as example. Each unit may have globals for IPv4 and IPv6 networks that are derived to lower lever interfaces in later generation.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Release 2.0 uses a Single-Page Application (SPA) as an example user interface bu
|
||||
|
||||
## Login to OpenWiFi SDK
|
||||
|
||||
|
||||
|
||||
|
||||
Default username is: **`tip@ucentral.com`** and password is: **`openwifi`**
|
||||
|
||||
@@ -16,19 +16,19 @@ Default username is: **`tip@ucentral.com`** and password is: **`openwifi`**
|
||||
|
||||
A left side navigation menu provides direction to major feature or service settings.
|
||||
|
||||
|
||||
|
||||
|
||||
## Internationalization
|
||||
|
||||
OpenWiFi 2.0 SDK supports multiple languages. Simply select the desired language from the right drop down for pages to re-populate accordingly.
|
||||
|
||||
|
||||
|
||||
|
||||
## Devices
|
||||
|
||||
Upon login the first page presented is a Devices table. This table reflects all discovered and managed devices known by the OpenWiFi SDK.
|
||||
|
||||
|
||||
|
||||
|
||||
Devices table indicates device Connected or Disconnected state in the first column with green and red respectively.
|
||||
|
||||
@@ -44,13 +44,13 @@ Three final columns provide Details (also obtained by selecting the serial numbe
|
||||
|
||||
From the Devices table, second from right column icon the WiFi Analysis may be accessed. This may also be accessed within the Device View page of a single record along the top right of Statistics section.
|
||||
|
||||
|
||||
|
||||
|
||||
Within the WiFi Analysis page, all active associations are displayed with the ability to view approximately the last 30 minutes of data reported from the Access Point.
|
||||
|
||||
For each association the device MAC address, mode of connection and SSID are displayed. This will include end devices as well as Wi-Fi infrastructure such as WDS and Mesh associations.
|
||||
|
||||
|
||||
|
||||
|
||||
Associations have RSSI, Rx Rate & Bytes, Tx Rate & Bytes, MCS negotiated, Number Spatial Streams and IP Address information.
|
||||
|
||||
@@ -58,8 +58,8 @@ Associations have RSSI, Rx Rate & Bytes, Tx Rate & Bytes, MCS negotiated, Number
|
||||
|
||||
OpenWiFi SDK provides visual indications on the overall health of the deployed Wi-Fi network. this includes Device Status for connected and non-connected devices. Device health indicating percentage of devices failing a health check. Distribution of devices by vendor in the network and by model.
|
||||
|
||||
|
||||
|
||||
|
||||
Additionally, verified certificates or serial mismatch certificates, number of Command actions from all Gateways to devices and devices with greater than 75% memory utilization, greater than 50% less than 75% memory and less than 50% utilization are displayed.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ description: OpenWiFi 2.0 SDK
|
||||
|
||||
Each device presents Metrics and Health check data to the Gateway. Devices view displays this information in the following organization:
|
||||
|
||||
* Status 
|
||||
* Status
|
||||
* Configuration
|
||||
* Logs
|
||||
* Health
|
||||
@@ -14,7 +14,7 @@ Each device presents Metrics and Health check data to the Gateway. Devices view
|
||||
* Statistics
|
||||
* Command History
|
||||
|
||||
|
||||
|
||||
|
||||
## Status
|
||||
|
||||
@@ -23,7 +23,7 @@ Uptime and Last Contact reflect communication state.\
|
||||
Load indicates processing load on the device.\
|
||||
Memory Used indicates free memory on the device.
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -31,19 +31,19 @@ Device UUID, Serial Number, MAC Address and Device Type are displayed.\
|
||||
Last configuration update date and timestamp reflects the last time a "configure" action completed on the device.\
|
||||
Password may be set and device notes may be added.
|
||||
|
||||
|
||||
|
||||
|
||||
## Logs
|
||||
|
||||
Log history of the device is presented within Logs. Expand the tile selecting the down arrow.
|
||||
|
||||
|
||||
|
||||
|
||||
## Health
|
||||
|
||||
Health score is an active tile reflecting the device health out of a score reported by the device to Gateway. Health metrics are configured on the device based on chosen data model options. When the device falls out of 100%, this tile changes to red. Expanding the tile will present all health reports. Those with less than 100% score will contain reasons for the result from this interface.
|
||||
|
||||
|
||||
|
||||
|
||||
## Commands
|
||||
|
||||
@@ -60,4 +60,4 @@ Commands tile provides a number of administrative actions for the user:
|
||||
| Factory Reset | Hard Reset remote device - destroys device local config |
|
||||
| Configure | Upload Device Configuration |
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,20 +6,20 @@ description: OpenWiFi SDK 2.0
|
||||
|
||||
Multiple events are recorded in the Command History tile. Each line item will have a Result, Details, and Delete action.
|
||||
|
||||
|
||||
|
||||
|
||||
When an rTTY session is executed, this is a displayed command history. Selecting the Result icons will display the Success or Fail of the command.
|
||||
|
||||
|
||||
|
||||
|
||||
Each provisioning event is reflected as a configure command history. To see the entire JSON payload and the result, including success or error with message, simply select Details to expand the dialog below with this data. A date and time in the third column indicates when the configure command was executed successfully.
|
||||
|
||||
|
||||
|
||||
|
||||
If a provisioning event has failed to complete, its command history for configure will show as pending.
|
||||
|
||||
|
||||
|
||||
|
||||
Remote packet capture is shown as the trace command history. When packet captures are persisted in the OpenWiFi SDK, they may be downloaded again through the cloud download icon.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -11,53 +11,53 @@ Each of these represent API calls exposed on the OpenAPI northbound interface fr
|
||||
|
||||
Selecting the Reboot action will prompt the below dialog. Options presented permit an immediate reboot or a scheduled reboot based on date and time.
|
||||
|
||||
|
||||
|
||||
|
||||
## Firmware Upgrade
|
||||
|
||||
Multiple methods exist to execute a remote Firmware Upgrade of a device. When selecting Firmware Upgrade via the Commands tile, a simple dialog to upgrade immediately or at a scheduled time is presented. Alternatively using the Firmware Management Service provides a complete solution including managed access to all TIP firmware images.
|
||||
|
||||
|
||||
|
||||
|
||||
## Wi-Fi Scan
|
||||
|
||||
OpenWiFi devices may perform channel scanning and return this neighbor and RF data to the SDK in an on demand or ongoing manner.
|
||||
|
||||
|
||||
|
||||
|
||||
### Wi-Fi Scan Results
|
||||
|
||||
Scan operations function over all channels. If 5GHz channels do not display in the returned results ( either via the UI or over API ) this indicates the device is configured in a DFS channel for which it may not return survey scans at this time.
|
||||
|
||||
|
||||
|
||||
|
||||
## Connect
|
||||
|
||||
OpenWiFi enables remote connection to any managed device using rTTY encrypted shell session. Selecting Connect will cause a browser tab to open with the login session to current device.
|
||||
|
||||
|
||||
|
||||
|
||||
## Blink
|
||||
|
||||
To assist with remote identification of devices in the network, it is possible to turn the LED lights On, Off, of continuous blinking. This may be run on-demand or scheduled.
|
||||
|
||||
|
||||
|
||||
|
||||
## Trace
|
||||
|
||||
Trace feature enables a remote packet capture to occur on the managed device, over a specified period of time or amount of traffic, returning the "pcap" packet capture file locally to the OpenWiFi admin user.
|
||||
|
||||
|
||||
|
||||
|
||||
Once complete the user is asked to open or save the packet capture file locally.
|
||||
|
||||
.png>)
|
||||
.png>)
|
||||
|
||||
## Factory Reset
|
||||
|
||||
It is possible to revert a device to initial out of box state from the OpenWiFi SDK. Sending a Factory Reset will remove all configuration on the device and optionally reset the discovered cloud stored as the 'Redirector' in the device configuration.
|
||||
|
||||
|
||||
|
||||
|
||||
{% hint style="info" %}
|
||||
Note: When Redirector is not kept, devices will re-contact the Certificate Authority to re-discover their OpenWiFi cloud address
|
||||
@@ -67,4 +67,4 @@ Note: When Redirector is not kept, devices will re-contact the Certificate Autho
|
||||
|
||||
Prior to the introduction of OpenWiFi 2.0 Provisioning Service, device configuration is done through creation of the JSON provisioning file and either loading that file or applying its contents using the dialog presented via Configure. The same options exist when using the API directly.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,15 +6,15 @@ description: OpenWiFi 2.0 SDK
|
||||
|
||||
Each device page presents statistics in traffic terms per interface as a line graph of bandwidth over time.
|
||||
|
||||
|
||||
|
||||
|
||||
The generated image may be downloaded for offline use.
|
||||
|
||||
|
||||
|
||||
|
||||
Accessing Wi-Fi Analysis and Last Statistics may be found at the top right of Statistics tile.
|
||||
|
||||
|
||||
|
||||
|
||||
## Wi-Fi Analysis
|
||||
|
||||
@@ -24,7 +24,7 @@ Viewing associations, from the Associations table, and their use is important in
|
||||
|
||||
Each association is known by their MAC address or BSSID value. The mode of connection will indicate if an end user client device entering the "ap" or if a client is associated as "wds" or "mesh.
|
||||
|
||||
|
||||
|
||||
|
||||
The access point view of RSSI, Rx and Tx Rate, Modulation Coding Scheme and Number of Spatial Streams are exposed for each association.
|
||||
|
||||
@@ -34,4 +34,4 @@ Using the slider along the top, the last 15 to 30 minutes of performances data m
|
||||
|
||||
The option to view Latest Statistics is at time of the MVP release, intended to help the Community see on a per device basis how much, or how little depending on device configuration, is being sent to the OpenWiFi Gateway in terms of telemetry.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,13 +10,13 @@ Firmware management service integrates across all OpenWiFi Gateways deployed in
|
||||
|
||||
Firmware dashboard provides a single view for overall health of deployed device firmware. Latest firmware charts, device firmware version distribution, distribution of device by type and current connected devices.
|
||||
|
||||
|
||||
|
||||
|
||||
## Device Table
|
||||
|
||||
From the Devices table, any device with a newer firmware published by TIP OpenWiFi is indicated with a yellow icon. Selecting this icon presents the option to upgrade to latest or specify which firmware to use.
|
||||
|
||||
|
||||
|
||||
|
||||
When the upgrade has been sent successfully, a green Success dialog will display in the upper right on the screen. Devices with latest firmware version will show a green firmware icon in the Devices row.
|
||||
|
||||
@@ -26,10 +26,10 @@ Viewing the contents of Firmware Management Service is available from the left n
|
||||
|
||||
Once in Firmware, it is possible to search by device model for all known firmware revisions.
|
||||
|
||||
|
||||
|
||||
|
||||
If in the Device Table reference above, instead of selecting Upgrade to Latest, the specific URI location of any available firmware is found using the Firmware table.
|
||||
|
||||
Selecting Details will present information for any firmware row, including the URI which may be copied into the Choose Custom Firmware dialog prompt accordingly.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user