OpenSync 3.4 Northbound API

OpenSync 3.4 Northbound APIDate: January 10, 2022Document ID: EUB-020-033-101

Table of ContentsIntroduction 6

Alarms 7

AW_Bluetooth_Config 7

AWLAN_Node 8

Open_vSwitch 11

SSL 12

Manager 13

Connection_Manager_Uplink 14

Wifi_Radio_Config 15

Wifi_Radio_State 18

Wifi_Route_Config 20

Wifi_Route_State 20

Wifi_Speedtest_Config 21

Wifi_Speedtest_Status 22

Wifi_VIF_Config 23

Wifi_VIF_State 27

DPP_Config 29

DPP_Announcement 32

DPP_Oftag 32

Wifi_VIF_Neighbors 33

Wifi_Channels 33

Public_Wifi_Config 34

Lte_Config 34

Lte_State 35

Wifi_Associated_Clients 37

Wifi_Credential_Config 37

Wifi_Inet_Config 38

Wifi_Inet_State 44

2/102

Wifi_Master_State 46

IP_Port_Forward 47

OVS_MAC_Learning 48

DHCP_leased_IP 49

DHCP_reserved_IP 50

DHCP Server Configuration 51UPnP Configuration 51DHCP Sniffing 51

Wifi_Stats_Config 52

Band_Steering_Config 54

Band_Steering_Clients 56

AW_LM_Config 60

AW_LM_State 61

AW_Debug 61

Openflow_Config 62

Openflow_State 62

Openflow_Tag 62

Openflow_Local_Tag 63

Openflow_Tag_Group 63

Client_Nickname_Config (not used) 63

Client_Freeze_Config (not used) 64

Flow_Service_Manager_Config 65

FSM_Policy 66

FCM_Collector_Config 68

FCM_Filter 69

FCM_Report_Config 72

IP_Interface 73

IPv4_Address (not used) 74

IPv6_Address 75

IPv6_Prefix 76

3/102

DHCPv4_Client (not used) 78

DHCPv6_Client 79

DHCP_Option 80

Netfilter 81

Netfilter_Ipset 82

DHCPv4_Server (not used) 83

DHCPv4_Lease (not used) 84

DHCPv6_Server 85

DHCPv6_Lease 86

IPv6_RouteAdv 87

IPv6_Neighbors 89

IPv4_Neighbors 89

IGMP_Config 90

MLD_Config 92

Node_Services 94

OMS_Config 95

Object_Store_Config 95

Object_Store_State 96

Captive_Portal 96

Interface_QoS 97

Interface_Queue 97

Reboot_Status 98

Service_Announcement 99

WAN_Config 99other_config supported parameters 100

TELOG_Config 101

Passpoint_Config 101

4/102

References[1] http://docs.openvswitch.org/en/latest/ref/ovsdb.7/

[2] EUB-020-013-001_OpenSync_Overview

5/102

http://docs.openvswitch.org/en/latest/ref/ovsdb.7/

IntroductionOpenSyncTM is a cloud-agnostic open-source software for the delivery, curation, andmanagement of wireless services for the home. It follows the SDN concept where the OVSDBserves as interprocess communication between services in the cloud and OpenSync managerson the device, as illustrated in the image below.

Tables in the Cloud schema are roughly organized into two groups - “config” and “state” tables.Usually, the cloud writes instructions and configuration into the config tables and the devicemust report its status in the state tables.

6/102

AlarmsThe Alarms table is used for reporting custom-defined alarms to the Cloud.

Name Type Description

code string Alarm code

timestamp integer Timestamp of the alarm

source string Source of the alarm

add_info string Additional information

AW_Bluetooth_ConfigAW_Bluetooth_Config is a configuration table where we can set payload in the BLE broadcastframe. CM2 uses this table to broadcast the node serial number and connection status. Theframes are received by the mobile app, enabling users to claim the nodes, locate and renamethe claimed nodes, and diagnose networking issues of nodes which are unable to connect to thecloud.


mode enum(on, off)

Enable/disable sending of BLE broadcast frames

interval_millis integer Interval time in msec, how often BLE broadcast is sent0 - default value (250 or 500 ms, depends on platform)

connectable boolean Enables bidirectional communication for localconfiguration over BLE.

txpower integer Tx power0 - default value (0x005C)

command enum(on_boarding,diagnostic,locate)

Up until OpenSync 2.0 only on_boarding is used

payload string 6 bytes of broadcast frame payload in format“01:23:45:67:89:ab”. Only the first byte is used as Statusbyte, and only when command is set to on_boarding.Status bits have the following meaning:

● 0x01 (Bit 0): Ethernet physical link (1: UP, 0:Down)

● 0x02 (Bit 1): Wifi physical link (1: Associated, 0:Disconnected)

● 0x04 (Bit 2): Backhaul over Ethernet (1: Yes, 0:No)

7/102

● 0x08 (Bit 3): Backhaul over Wifi (1: Yes, 0: No)● 0x10 (Bit 4): Connected to Router (1: Yes, 0: No)● 0x20 (Bit 5): Connected to Internet (1: Yes, 0: No)● 0x40 (Bit 6): Connected to Cloud (1: Yes, 0: No)

Example (a node is connected via Ethernet to router, but router has no uplinkconnection):

# ovsh s AW_Bluetooth_Config

-------------------------------------

_uuid | 0c63~06b2 |

_version | d2a9~62c7 |

command | on_boarding |

connectable | false |

interval_millis | 0 |

mode | on |

payload | 15:00:00:00:00:00 |

txpower | 0 |

------------------------------------

AWLAN_NodeAWLAN_Node is a configurational and informational table that stores all device_entityinformation. The table also stores information about the Cloud connection specifics. Once theredirector_address is specified, the Cloud configures connection information throughmanager_address (See Connection Manager - CM [2] for details), and specifies the MQTTconfiguration (See Queue Manager - QM [2] for details).


boot_time integer Number of seconds since the time the node booted up. Tocalculate the live uptime for a node, the Cloud subtractscurrent_time() - AWLAN_Node.boot_time.

id string Device identification number - serial_number used by theCloud to differentiate device management (could also beMAC address)

device_mode enum(cloud,monitor,battery,custom)

Different devices operate in different modes. This requiresspecial handling in the Cloud:

● cloud - full control including reading statistics,configuring channels, and managing backhaulPOD topology changes - Adaptive Wifi

● monitor - (or read-only mode) is a mode whereonly certain statistics are collected and/or channelsare managed - depends on customer requirements

8/102

● battery - devices running on battery need to savepower, therefore, the cloud turns off most of thefunctionality

● custom - custom mode, individual features andresponsibilities are governed via profile in theCloud

factory_reset boolean Indicates the status of the device after factory reset hasbeen issued

firmware_url string The descriptor in URL format indicating a new SW releasedownload location(Only applicable when Upgrade Manager is used)

firmware_pass string Password for firmware-encrypted images

firmware_version string OpenSync firmware package version

platform_version string Joined platform firmware version containing OpenSync

serial_number string Device serial number as seen on the BAR code

model string Device-friendly name used in the network

revision string Device HW revision

sku_number string Device SKU number/revision

version_matrix key/value map Detailed firmware version description including● OpenSync version● Date of generation● Firmware package version● Build number● Source code repository version details● other details

upgrade_dl_timer integer The "upgrade_" fields specify the node upgrading behavior.

Note: The settings are only applicable when the UpgradeManager is used.

Time in seconds that is given to the device to completedownloading of the image. Actual success of the operation isindicated in upgrade_status.

upgrade_status integer Status code that indicates status of upgrade process. Canhave negative values indicating various types of errors, orpositive values which indicate successful upgrade steps.

upgrade_timer integer Delay in seconds after the upgrade process is started fromthe time the field is set.

redirector_addr string The cloud redirector address used to differentiate betweendifferent deployments (production or development). Thesyntax is : <protocol>:<cloud>:<port>

manager_addr string Manager Address field is populated by the redirector andtells to which Controller Address should the OVSDconnection be established. The syntax is:<protocol>:<controller_hostname|ip>:<port>

9/102

mqtt_headers key/value map Contains location and node ID.

mqtt_settings key/value map MQTT server settings. QM uses the mqtt_settings field toget all the required parameters for establishing an MQTTconnection.

Parameters:● broker: hostname● port: port number● compress: none, zlib● topics: topic name● QoS: 0, 1, 2

mqtt_topics key/value map A key/value map that defines which MQTT topics are usedfor certain features.

Example: aggregatedStats (wifi statistics) MQTT topic

led_config key/value map Specifies LED behavior(Only applicable when the LED Manager is used)

min_backoff integerCM reconnect backoff timer configuration

max_backoff integer

vendor_name string Device vendor name. Up to 64 characters can be used.

vendor_part_number string Device model as defined by the vendor. Up to 64 characterscan be used.

vendor_manufacturer string Name of the device manufacturer. Up to 64 characters canbe used.

vendor_factory string Factory at which the device has been produced. Up to 64characters can be used.

vendor_mfg_date string Manufacturing date. Up to 16 characters can be used.

redirector_addr string Redirector URL. The ovsdb-server supports IPv4 and IPv6connections.

Example:

# ovsh s AWLAN_Node

--------------------------------------------------------------------------------------------

_uuid | d120~9bc2 |

_version | 6ae6~76d7 |

boot_time | 1641893054 |

device_mode | ["set",[]] |

factory_reset | ["set",[]] |

firmware_pass | |

firmware_url | |

firmware_version | 4.4.0-7-g430b56-dev-debug |

id | EM7E000059 |

led_config | ["map",[["mode","off"]]] |

manager_addr | ssl:osync-01-pub.xxxx.us-west-2.aws.xxxx.tech:443 |

max_backoff | 60 |

min_backoff | 30 |

10/102

model | PP403Z |

mqtt_headers | ["map",[["locationId","61dd495d782ac935de20ee6c"],["nodeId","EM7E000059"]]] |

mqtt_settings | ["map",[["broker","emqtt-development.shared.us-west-2.aws.xxxx.tech"], |

: ["compress","zlib"],["port","443"],["qos",""],["topics", :

: "s1/osync/61dd495d782ac935de20ee6c/01"]]] :

mqtt_topics | ["map",[["Crash.Reports", |

: "Crash/Reports/osync/EM7E000059/61dd495d782ac935de20ee6c"], :

: ["DHCP.Signatures", :

: "DHCP/Signatures/osync/EM7E000059/61dd495d782ac935de20ee6c"],["DNS.Queries", :

: "DNS/Queries/osync/EM7E000059/61dd495d782ac935de20ee6c"],["HTTP.Requests", :

: "HTTP/Requests/osync/EM7E000059/61dd495d782ac935de20ee6c"],["LteStats", :

: "LteStats/osync/EM7E000059/61dd495d782ac935de20ee6c"],["ObjectStore", :

: "ObjectStore/osync/EM7E000059/61dd495d782ac935de20ee6c"],["UPnP.Devices", :

: "UPnP/Devices/osync/EM7E000059/61dd495d782ac935de20ee6c"], :

: ["WifiBlaster.Results", :

: "WifiBlaster/osync/EM7E000059/61dd495d782ac935de20ee6c"],["aggregatedStats", :

: "aggregatedStats/osync/EM7E000059/61dd495d782ac935de20ee6c"]]] :

platform_version | 1 |

redirector_addr | ssl:wildfire-dualstack.xxxx.tech:443 |

revision | EVT.0 |

serial_number | EM7E000059 |

sku_number | 945102700 |

upgrade_dl_timer | 0 |

upgrade_status | 0 |

upgrade_timer | 0 |

vendor_factory | Suzhou-1 |

vendor_manufacturer | Sercomm |

vendor_mfg_date | 2020/16 |

vendor_name | Vendor |

vendor_part_number | PP403Z |

version_matrix | ["map",[["/data/jenkins/workspace/build_augustus_v4.4.0/device-sdk-bcm-5.", |

: "0.0/=784/g2d1e2e8"],["3rdparty/xxxx","0.0/=64/g1554f1d"], :

: ["3rdparty/decawave","0.0/=17/g3d4d9a5"],["3rdparty/ookla", ... :

:

:

:

:

:

:

:

:

:

:

:

--------------------------------------------------------------------------------------------

11/102

Open_vSwitchWhen Open_vSwitch is used, this table contains the reference to the networking elements.Details are available in EUB-020-013-001_OpenSync_Overview, section Network Manager -NM [2].


bridges uuid Reference to the table: Bridge

manager_options uuid Reference to the table: Manager

ssl uuid Reference to the table: SSL

other_config string Additional configuration

external_ids string Not used by CM2

next_cfg integer Not used by CM2

cur_cfg integer Version of the current configuration

statistics string Not used by CM2

ovs_version string Version of OVS

db_version string Version of database

dpdk_initialized boolean If True, the DPDK EAL initialization has succeeded.

dpdk_version string Library version linked to ovs-vswitchd

system_type string Not used by CM2

system_version string Identifies the platform to the controller

datapath_types string Not used by CM2

iface_types string Supported type of interfaces

Example:

# ovsh s Open_vSwitch

-----------------------------------------------------------------

_uuid | f5eb~58cc |

_version | 84c9~97d5 |

bridges | [ca0e~2356,ca66~5670] |

cur_cfg | 4 |

datapath_types | ["set",["netdev","system"]] |

db_version | ["set",[]] |

dpdk_initialized | false |

dpdk_version | ["set",[]] |

external_ids | ["map",[]] |

iface_types | ["set",["geneve","gre","internal","lisp","patch","stt","system","tap","vxlan"]] |

manager_options | 569e~bbda |

next_cfg | 4 |

other_config | ["map",[["stats-update-interval","3600000"]]] |

12/102

ovs_version | ["set",[]] |

ssl | fc24~5e95 |

statistics | ["map",[]] |

system_type | ["set",[]] |

system_version | ["set",[]] |

-----------------------------------------------------------------

SSLSSL table contains SSL-related information, including the path to the currently used certificates.


private_key string Path to private key

certificate string Path to certificate

ca_cert string Path to CA certificate

bootstrap_ca_cert boolean Enable/disable bootstrap certificate

external_ids key/value map Not used by CM2

Example:

# ovsh s SSL

-----------------------------------------------

_uuid | 8e9a~8be8 |

_version | c61b~d046 |

bootstrap_ca_cert | false |

ca_cert | /var/certs/ca.pem |

certificate | /var/certs/client.pem |


private_key | /var/certs/client_dec.key |

-----------------------------------------------

ManagerThe table contains information required to establish and keep the Cloud connection. TheManager table status field is a useful source when debugging the Cloud connection.


target string Direct SSL address to the Cloud

max_backoff integer Reconnect backoff timer configurationNot used by CM2

inactivity_probe integer Inactive timer, default value: 30000 ms

connection_mode enum(in-band, out-of-band)

Not used by CM2

13/102

other_config string Not used by CM2

external_ids string Not used by CM2

is_connected boolean Connection state

status string Connection status

Example:# ovsh s Manager

-------------------------------------------------------------------------------

_uuid | 0d1e~0c85 |

_version | ba1a~efba |

connection_mode | ["set",[]] |


inactivity_probe | 30000 |

is_connected | true |

max_backoff | ["set",[]] |

other_config | ["map",[]] |

status | ["map",[["sec_since_connect","16001"],["state","ACTIVE"]]] |

target | ssl:IP:443 |

-------------------------------------------------------------------------------

Connection_Manager_UplinkThe Connection_Manager_Uplink table provides info and status for the uplink connection.


bridge string Manages WAN bridges for the mainactive link.

has_L2 boolean Physical link state

has_L3 boolean Uplink available

if_name string Interface name

if_type enum(bridge, eth, vif, gre, gre6,pppoe, softwds, tap, vlan)

Interface type

is_used boolean Link used as a main link

loop boolean Used for ethernet link, notify potentialloop if link will be used in br-homebridge

ntp_state boolean System clock valid (NTP success)

priority integer Link priority, link with the highestpriority should be used as a main link

unreachable_cloud_counter integer Counter that increments each timethe Cloud connection is lost.

14/102

unreachable_internet_counter integer Counter that increments each timethe internet connection is lost.

unreachable_link_counter integer stats

unreachable_router_counter integer stats

eth_client boolean Notifies when an ethernet client isdetected on the interface.

ipv4 enum Information about link state. Availableoptions:

● "ready": IP address assigned● "active": link validated for use● "inactive": not ready● "blocked": link blocked due to

poor quality● "unblocking": moving from

blocked to active state

ipv6 enum Information about link state. Availableoptions:

● "ready": IP address assigned● "active": link validated for use● "inactive": not ready● "blocked": link blocked due to

poor quality● "unblocking": moving from

blocked to active state

unblock_ts string Timestamp of the moment when thelink is unblocked.

Example:# ovsh s Connection_Manager_Uplink

-------------------------------------------------------

_uuid | 4910~4011 | e22c~1143 |

_version | d522~0e4c | a338~2451 |

bridge | ["set",[]] | br-home |

eth_client | ["set",[]] | ["set",[]] |

has_L2 | true | true |

has_L3 | false | true |

if_name | eth0 | eth1 |

if_type | eth | eth |

ipv4 | ["set",[]] | ready |

ipv6 | ["set",[]] | ready |

is_used | ["set",[]] | true |

loop | false | ["set",[]] |

ntp_state | ["set",[]] | true |

priority | 11 | 11 |

unblock_ts | ["set",[]] | ["set",[]] |

unreachable_cloud_counter | ["set",[]] | 0 |

unreachable_internet_counter | ["set",[]] | 0 |

unreachable_link_counter | ["set",[]] | 0 |

unreachable_router_counter | ["set",[]] | 0 |

--------------------------------------------------------

15/102

Wifi_Radio_ConfigWifi_Radio_Config table stores the system-wide wireless radio (physical) configuration.



freq_band enum(2.4G, 5G,5GL, 5GU)

Frequency band of the specified interface. If two separate 5GHz radios are available on the device, these radios shouldbe specified as “lower”: 5GL or “upper”: 5GU.

enabled boolean The desired interface state. “True” if the interface should beconfigured.

dfs_demo boolean Controls the demo mode for DFS.

hw_type string The descriptor of the hardware type for a specific wifi radio.For example this is useful e.g. for differentiating theconfigurations for different hardware chips.

hw_config string Configuration type, complementing the “hw_type” parameter

country string Two-letter country code descriptor for setting the wirelessregulatory domain. Examples: “AT”, “AU”, “BE”, etc.

channel integer Channel number of the specified radio. The availablechannels list depends on the frequency band, regulatorydomain, and channel width.

channel_sync integer Deprecated

channel_mode enum(auto,manual,cloud,acs)

Channel mode; specifies the method using which thechannel is set:

● auto: device sets channel config automatically● manual: manually override channel config● cloud: the cloud pushes channel configurations● ACS: auto channel selection activated

hw_mode enum(11a, 11b, 11g,11n, 11ab,11ac)

Specifies the IEEE 802.11 standard used for the specifiedradio.

ht_mode enum(HT20,HT2040,HT40,HT40+,HT40-,HT80,HT160,HT80+80)

Stands for “high throughput mode”; specifies the bandwidthof the selected channel, in MHz:

● HT20: single 20 MHz channel● HT2040: deprecated● HT40: dual 20 MHz channels, automatic selection of

upper or lower secondary channel● HT40-: dual 20 MHz channels, upper channel is

primary or control● HT40+: dual 20 MHz channels, lower channel is

primary or control● HT80: dual 40 MHz channels● HT160: dual 80 MHz channels

16/102

● HT80+80: deprecated

thermal_shutdown integer Temperature in degrees (℃) at which the unit shuts down

thermal_downgrade_temp integer Temperature at which the tx_chainmask is reduced

thermal_upgrade_temp integer Temperature at which the tx_chainmask is increased

thermal_integration integer Time required for the device to upgrade or downgradechainmask after exceeding the temperature threshold

temperature_control integer deprecated

vif_configs set if uuids Array of VIF uuids linked to entries (columns) in theWifi_VIF_Config table

tx_power integer Transmission power of the specified radio (in dBm)

bcn_int integer Beacon interval in TU (time units), which depend on thesystem, e.g., TU = 1.024 ms

tx_chainmask integer Transmission chainmask: bitmask that specifies whichantennas are used for transmission. Each WiFi radio can beconnected to many antennas (2, 3, 4), so disabling one ormore of the antennas affects the temperature of the WiFichip.

zero_wait_dfs (availablein OpenSync 2.0 andlater)

enum Adds zero-wait DFS options.● "disable": default value. Executes the channel

switch, switches channel and runs CAC.● "enable": If the cloud enables this and chooses a

DFS channel in Wifi_Radio_Config::channel thedevice runs background CAC. In case of success,the device switches to a new DFS channel.

● "precac": extends the “enable” mode. Runsbackground CAC on all DFS channels.

Example:

17/102

# ovsh s Wifi_Radio_Config

------------------------------------------------------------------------------------------------

_uuid | 5074~e243 | c9aa~f7f0 | 38fc~4d0b |

_version | f0ee~c713 | a33a~b519 | 0a39~809d |

bcn_int | ["set",[]] | ["set",[]] | ["set",[]] |

channel | 44 | 6 | 108 |

channel_mode | cloud | cloud | cloud |

channel_sync | 0 | 0 | 0 |

country | ["set",[]] | ["set",[]] | ["set",[]] |

dfs_demo | false | ["set",[]] | false |

enabled | true | true | true |

fallback_parents | ["map",[]] | ["map",[]] | ["map",[]] |

freq_band | 5GL | 2.4G | 5GU |

ht_mode | HT160 | HT20 | HT80 |

hw_config | ["map",[]] | ["map",[]] | ["map",[]] |

hw_mode | 11ax | 11ax | 11ax |

hw_type | bcm43684 | bcm6755 | bcm6755 |

if_name | wl0 | wl1 | wl2 |

temperature_control | ["map",[]] | ["map",[]] | ["map",[]] |

thermal_downgrade_temp | ["set",[]] | ["set",[]] | ["set",[]] |

thermal_integration | ["set",[]] | ["set",[]] | ["set",[]] |

thermal_shutdown | ["set",[]] | ["set",[]] | ["set",[]] |

thermal_tx_chainmask | ["set",[]] | ["set",[]] | ["set",[]] |

thermal_upgrade_temp | ["set",[]] | ["set",[]] | ["set",[]] |

tx_chainmask | 15 | 3 | 3 |

tx_power | ["set",[]] | ["set",[]] | ["set",[]] |

vif_configs | [a064~1f13,c5f1~9011, | [1800~ea0d,71fd~6156, | [5d9f~bdfa,900b~9770] |

: fcbe~2c12] : 7c46~1289] : :

zero_wait_dfs | disable | ["set",[]] | disable |

------------------------------------------------------------------------------------------------

18/102

Wifi_Radio_StateWifi_Radio_State table represents the actual state of the device and is therefore read by theCloud. The table is pushed by WM2 and reflects the current system-wide wireless radio(physical) configuration.

Entries marked in gray differ from the Wifi_Radio_Config table, while the other rows are equal.



radio_config uuid The uuid linked to the entity (column) in theWifi_Radio_Config table

freq_band Enum(2.4G, 5G,5GL, 5GU)

The frequency band of the specified interface. If twoseparate 5GHz radios are available on the device, theyshould be specified as “lower”: 5GL or “upper”: 5GU.

enabled boolean The desired interface state. “True” if the interface should bein the UP state; otherwise the interface should be in theDOWN state (the equivalent of ifconfig up/down)

dfs_demo boolean Controls the demo mode for DFS

hw_type string Hardware type for a specific wifi radio. For example, use thisvalue for differentiating the configurations between differenthardware chips.

hw_params string Field for hardware-specific configuration

radar string Field for DFS-specific information

hw_config string Configuration type, complementing the “hw_type” parameter

country string Two-letter country code descriptor for setting wirelessregulatory domain. Examples: “AT”, “AU”, “BE”, etc.

channel integer Channel number of the specified radio. The availablechannels list depends on the frequency band, regulatorydomain, and channel width.

channel_sync integer TBD

channel_mode enum(auto,manual,cloud)

Channel mode; specifies the method with which the channelis set:

● auto: device sets channel config automatically● manual: manually override channel config● cloud: the Cloud pushes channel configurations

mac string MAC address of the specified radio

hw_mode enum Specifies the IEEE 802.11 standard used for the specifiedradio

19/102

(11a, 11b, 11g,11n, 11ab,11ac)


Stands for “high throughput mode”; specifies the bandwidthof the selected channel, in MHz:

● HT20: single 20 MHz channel● HT2040: deprecated● HT40: dual 20 MHz channels, automatic selection of

upper or lower secondary channel● HT40-: dual 20 MHz channels, upper channel is

primary or control● HT40+: dual 20 MHz channels, lower channel is

primary or control● HT80: dual 40 MHz channels● HT160: dual 80 MHz channels● HT80+80: deprecated

thermal_shutdown integer Temperature in degrees (℃), at which the unit shuts down

thermal_downgrade_temp integer Temperature at which the tx_chainmask is reduced

thermal_upgrade_temp integer Temperature at which the tx_chainmask is increased

thermal_integration integer Time required for the device to upgrade or downgrade thechainmask after exceeding the temperature threshold

thermal_downgraded boolean Information if device chainmask is currently downgraded dueto the exceeded thermal threshold

temperature_control integer Deprecated

vif_states set of uuids Array of VIF uuids linked to the entries (columns) in theWifi_VIF_State table

tx_power integer Transmission power of the specified radio (in dBm).

bcn_int integer Beacon interval in TU (time units), which depend on thesystem, e.g. TU = 1.024 ms

tx_chainmask integer Transmission chainmask: bitmask to specify which radiochains are used for transmission

thermal_tx_chainmask integer Value used by thermal manager

allowed_channels integer The list of allowed channels for the specified interface. Thelist depends on several other parameters, like frequency andregulatory domain.

channels map The map is keyed with channel numbers to json statedescriptions. The json is expected to be a dictionary andshould include “state” keys with one of the 4 values:

● allowed: non-dfs channel● nop_finished: dfs channel, requires cac before using● cac_completed: dfs channel, cac completed, usable● nop_started: dfs channel, radar was detected and it

must not be used

zero_wait_dfs (available enum Adds zero-wait DFS options.

20/102

in OpenSync 2.0 andlater)

● "disable": default value. Executes the channelswitch, switches channel and runs CAC.

● "enable": If the cloud enables this and chooses aDFS channel in Wifi_Radio_Config::channel thedevice runs background CAC. In case of success,the device switches to a new DFS channel.

● "precac": extends the “enable” mode. Runsbackground CAC on all DFS channels.

Wifi_Route_ConfigThis table contains static routes for IPTV traffic that are pushed from Cloud to the nodes.


dest_addr string IPv4 destination address.

dest_mask string IPv4 destination mask.

gateway string IPv4 address of the next hop router.

metric integer 32-bit integer value to help the router choose the best routeamong the multiple feasible routes. Lower metric routes arepreferred. Optional field.

if_name string The name of the output interface device for the route. Thename should be specified unless the decision on whichinterface to select is delegated to the kernel routing logic(based on the gateway address specification). The if_namefield value is required if the gateway address is not provided.

Wifi_Route_StateThis table reflects the current state of the routing tables in the system.


dest_addr string IPv4 destination address.

dest_mask string IPv4 destination mask.

gateway string IPv4 address of the next hop router.

if_name string The name of the output interface device for the route.

gateway_hwaddr string MAC address of the gateway.

21/102

Wifi_Speedtest_ConfigAn update to this table configures and initiates a speedtest, either using Ookla, iPerf or SamKnows.


test_type enum (OOKLA,IPERF3_S, IPERF3_C,SAMKNOWS)

Type of speedtest to be run.

traffic_cap real If the current amount of traffic exceeds this value,speedtest does not start.

delay integer Delay the test start in seconds (currently not in use).

testid integer Arbitrary test ID for your reference. Copied toWifi_Speedtest_Status.

select_server_id integer Ookla: Initiate Ookla speedtest with a specific server ID.

preferred_list integer list Ookla: a list of Ookla server IDs that will be preferred forthe speedtest.

st_bw integer iPerf: target bandwidth (0 for unlimited) for UDP tests.[bits/s]

st_dir enum (DL, UL, DL_UL) iPerf: Specify direction (download, upload, both)

st_len integer iPerf: Time in seconds to transmit - test length (one way)

st_parallel integer iPerf: number of parallel client streams to run

st_pkt_len integer iPerf: MTU - 40 bytes

st_port integer iPerf: server port to listen on/connect to

st_server string iPerf: server host or IP to connect to or bind to

st_udp boolean iPerf: use UDP rather than TCP

st_endpoint_url string Ookla endpoint URL

Note: This table is available in OpenSync 2.0 and later.

22/102

Wifi_Speedtest_StatusThis table serves to report speedtest results.


UL real Download speed (MB/s)

DL real Upload speed (MB/s)

server_name string Test server FQDN or test server ID (Ookla).

server_IP string Test server IP.

ISP string ISP name.

RTT real Round trip time.

jitter real Ookla: measured jitter (in ms)

duration real Test duration in seconds

timestamp integer Unix timestamp

status integer Test status. 0 if successful, negative values signal various errors.

DL_bytes integer The amount of downloaded bytes.

UL_bytes integer The amount of uploaded bytes.

DL_duration real Duration of download part of speedtest (in s)

UL_duration real Duration of upload part of speedtest (in s)

test_type enum (OOKLA,IPERF_S,IPERF_C,SAMKNOWS.)

The type of speed test that was run.

testid integer The test ID used when running this speedtest.

pref_selected boolean Ookla: If true, the preferred server was used for speedtest

hranked_offered boolean Ookla: If true, the preferred server was chosen even if anon-preferred server was ranked higher due to better latency.

DL_pkt_loss real iPerf: packet loss [percent] - download direction

UL_pkt_loss real iPerf: packet loss (percentage) - upload direction

DL_jitter real iPerf: measured jitter (in ms) - download direction

UL_jitter real iPerf: measured jitter (in ms) - upload direction

host_remote string iPerf: remote host IP


23/102

Wifi_VIF_ConfigThe Wifi_VIF_Config table is used for the system-wide wireless (logical) interface - AP and STAconfiguration.



enabled boolean Defines if the specified interface is enabled or not

mode enum(ap,monitor,sta)

Interface mode:● ap: access point● monitor: monitor (promiscuous) mode - not used● sta: station (client)

parent string Parent BSSID to which the STA needs to be connected(Only for extenders). If empty, any BSSID is allowed tomatch.

vif_radio_idx integer Consecutive radio index per VIF type, e.g.● 1=bhaul-ap,● 2=home-ap, etc.

vif_dbg_lvl integer Introduces Wi-Fi debug config switch.

wds boolean Deprecated

ssid string Interface SSID

ssid_broadcast enum(enabled,disabled,disabled_null)

Determines if the interface SSID is broadcast or not

security key/value map Deprecated. Should remain unset.

credential_configs uuid Wifi_Credential_Config. This is for extender only. Thiscolumn is respected only if “ssid” is empty.

bridge string Specifies the bridge interface on which the authenticationlistens for EAPOL.

mac_list string ACL MAC list for layer 2 packet filtering

mac_list_type enum(whitelist,blacklist,none)

How to filter the MAC addresses:● whitelist: only forward traffic from addresses in

mac_list, block all other traffic● blacklist: only block traffic from addresses in

mac_list, forward all other traffic● none: no filtering

vlan_id integer Identification number for VLAN-tagged traffic (min 1, max4096).

min_hw_mode enum Minimum required IEEE 802.11 standard for the specifiedinterface

24/102

(11b, 11g, 11a,11n, 11ac)

uapsd_enable boolean Enables uAPSD power saving capability for the specifiedinterface

group_rekey integer Time in seconds between the GTK rekeying. Valid for APmode only. Empty or -1 means default, 0 means disabled, >0is interval in seconds.

ap_bridge boolean AP isolation (intra-bss communication)

ft_psk integer “Fast transition” (802.11R) pre-shared key

ft_mobility_domain integer “Fast transition” (802.11R) mobility domain

btm integer (0, 1) Enable (1) or disable (0) WNM BSS Transition support.

rrm integer (0, 1) Enable (1) or disable (0) RRM support. Current minimumrequirement is to enable RRM Neighbor Report support.

dynamic_beacon boolean Only applicable if ssid_broadcast is disabled. When enabled,the AP stops beaconing until a non-ap STA attempts toassociate.

mcast2ucast(available in OpenSync2.0 and later)

boolean Enables multicast-to-unicast packet conversion:● 0: disabled● 1: enabled

multi_ap(available in OpenSync2.0 and later)

string Device type as defined by the Multi AP specification:● Backhaul STA● Backhaul BSS● Fronthaul BSS● Fronthaul Backhaul BSS (available with OpenSync

2.4 and later)

wpa boolean Enables support for WPA on AP:● “True”: Enable WPA● “False”: AP uses OPEN mode (unencrypted mode;

the AP does not request client password)

wpa_key_mgmt enum list Configures the WiFi security mode:● "dpp"● "wpa-psk"● "wpa2-psk"● "wpa2-eap"● "sae"● "ft-wpa2-psk"● "ft-sae"

wpa_psks map List of passwords used by WPA1/2, HomePass and SAE.

wpa_oftags map WPA1/2 passwords' oftags

radius_srv_addr string Remote RADIUS server address (IP or domain name)

radius_srv_port integer Remote RADIUS server port number

radius_srv_secret string Remote RADIUS server secret

default_oftag string An oftag used for OPEN, WPA-EAP or as a fallback oftag.

25/102

dpp_connector string Signed public part of the client dpp_netaccesskey, with extrainfo, such as role, expiry time, etc.

dpp_csign_hex string Public part of the Configurator end-user client key.

dpp_netaccesskey_hex string Exposes the DPP Configuration Object’s WPA/SAE PSKwhen acting as Enrollee.

dpp_cc boolean A marker that can be added by the APto its Beacon and Probe Resp frames. The marker is thenused by chirping enrollees tobuild their scan lists on which they will chirpon.

min_rssi integer RSSI threshold to prevent low RSSI clients from associatingto specified VAPs.

max_sta integer Limits the number of allowed public clients to be associatedwith each VAP.

passpoint_hessid string Configures a Homogenous Extended Service Set Identifier(HESSID) for a Hotspot 2.0 network.

airtime_precedence string Sets percentage for the WiFi air time per each VAP on thesame radio. Available values:

● "low"● "medium"● "high"

wps boolean Enables support for WPS on AP (i.e., broadcast support forWPS in beacons):

● “True”: Enable WPS● “False”: Disable WPS

wps_pbc boolean Initiate WPS single session:● “True”: Start WPS session● “False”: Cancel ongoing WPS session

wps_pbc_key_id string The value must match one of the password key IDs stored inthe security field of the AP's configuration.

26/102

Example:

root@augustus:~# ovsh s Wifi_VIF_Config -w if_name==wl0.1

---------------------------------------------------------------------------------------------

_uuid | a064~1f13 |

_version | 3571~1dc9 |

airtime_precedence | ["set",[]] |

ap_bridge | ["set",[]] |

bridge | ["set",[]] |

btm | ["set",[]] |

credential_configs | ["set",[]] |

default_oftag | ["set",[]] |

dpp_cc | ["set",[]] |

dpp_connector | ["set",[]] |

dpp_csign_hex | ["set",[]] |

dpp_netaccesskey_hex | ["set",[]] |

dynamic_beacon | false |

enabled | true |

ft_mobility_domain | ["set",[]] |

ft_psk | ["set",[]] |

group_rekey | ["set",[]] |

if_name | wl0.1 |

mac_list | ["set",["e4:26:86:64:7a:81","e4:26:86:64:7b:3e"]] |

mac_list_type | whitelist |

max_sta | ["set",[]] |

mcast2ucast | ["set",[]] |

min_hw_mode | ["set",[]] |

min_rssi | ["set",[]] |

mode | ap |

multi_ap | none |

parent | ["set",[]] |

passpoint_hessid | ["set",[]] |

radius_srv_addr | ["set",[]] |

radius_srv_port | ["set",[]] |

radius_srv_secret | ["set",[]] |

rrm | ["set",[]] |

security | ["map",[]] |

ssid | we.backhaul |

ssid_broadcast | disabled |

uapsd_enable | ["set",[]] |

vif_dbg_lvl | ["set",[]] |

vif_radio_idx | 1 |

vlan_id | ["set",[]] |

wds | ["set",[]] |

wpa | true |

wpa_key_mgmt | wpa2-psk |

wpa_oftags | ["map",[["key--1","bhaul--1"]]] |

wpa_psks | ["map",[["key--1", |

: "33070BD49FE4970FC28F6BC2ABCE0XXXX4BA2729168AC272FD20886C8882EC4"]]] :wps | ["set",[]] |

wps_pbc | ["set",[]] |

wps_pbc_key_id |

---------------------------------------------------------------------------------------------

27/102

Wifi_VIF_StateWifi_VIF_State table represents the actual state on the device, and is therefore read by theCloud. The table is pushed by WM2 and reflects the current system-wide wireless (logical)interface configuration.

Entries marked in gray are different to the Wifi_VIF_Config table, while the other rows are equal.


vif_config uuid The associated Wifi_VIF_Config entry


enabled boolean Shows if the specified interface is enabled or not.

mode enum(ap, ap_vlanmonitor,sta)

Interface mode:● ap: access point● ap_vlan: interface used by WDS with multi-AP

functionality● monitor: monitor (promiscuous) mode - not used● sta: station (client)

state string Client state

channel integer Channel of the radio interface is attached (some platformssupport multiple channel configurations).

mac string MAC address of the interface

vif_radio_idx integer VIF index of the radio interface

wds boolean Defines if the specified interface support supports WDS

parent string Parent BSSID to which the STA needs to be connected(Only for extenders)

ssid string Interface SSID

ssid_broadcast enum(enabled,disabled,disabled_null)

Determines if the interface SSID is broadcasted or not.

security key/value map Deprecated. Should remain unset.

bridge string Specifies the bridge interface to which the VIF is added

mac_list string ACL MAC list for layer 2 packet filtering

mac_list_type enum(whitelist,blacklist,none)

How to filter MAC addresses:● whitelist: only forward traffic from addresses in

mac_list, block all other traffic● blacklist: only block traffic from addresses in

mac_list, forward all other traffic

28/102

● none: no filtering

associated_clients uuid MAC list of all associated clients

vlan_id integer Identification number for VLAN-tagged traffic

min_hw_mode enum(11a, 11b, 11g,11n, 11ab,11ac)

Minimal required IEEE 802.11 standard for the specifiedinterface

uapsd_enable boolean Indicates uAPSD power saving capability for the specifiedinterface

group_rekey integer Time in seconds between the GTK rekeying. Valid for APmode only. Empty or -1 means default, 0 means disabled, >0is interval in seconds.

ap_bridge boolean AP isolation (infra-bss communication)

ap_vlan_sta_addr(available in OpenSync2.0 and later)

string MAC address of connected WDS station (Backhaul STA)

ft_psk integer Deprecated. “Fast transition” (802.11R) pre-shared key.

ft_mobility_domain integer “Fast transition” (802.11R) mobility domain

rrm integer (0, 1) Indicates if the RRM support is enabled. If RRM NeighborReport isn’t available, 0 must be reported.

btm integer (0, 1) ● Indicates whether WNM BSS Transition support isenabled or not.

dynamic_beacon boolean Indicates if the dynamic_beacon configuration is enabled. Itdoes not reflect if the feature is actively quiescing beaconsat the moment or not.

mcast2ucast boolean Indicates multicast-to-unicast packet conversion:● 0: disabled● 1: enabled

multi_ap string Device type as defined by the Multi AP specification:● Backhaul STA● Backhaul BSS● Fronthaul BSS● Fronthaul Backhaul BSS (available with OpenSync

2.4 and later)

wps boolean Indicates support for WPS on AP (i.e., broadcast support forWPS in beacons):

● “True”: Enable WPS● “False”: Disable WPS

wps_pbc boolean Indicates WPS single session:● “True”: Start WPS session● “False”: Cancel ongoing WPS session

wps_pbc_key_id string ● The value must match one of the password key IDsstored in the security field of the AP's configuration.

29/102

wpa boolean Enables support for WPA on AP:● “True”: Enable WPA● “False”: AP uses OPEN mode (unencrypted mode;

the AP does not request client password)

wpa_key_mgmt enum WiFi security mode in use:● dpp"● "wpa-psk"● "wpa2-psk"● "wpa2-eap"● "sae"● "ft-wpa2-psk"● "ft-sae"

wpa_psks map List of passwords used by WPA1/2, HomePass and SAE.

radius_srv_port integer Remote RADIUS server port number

radius_srv_secret string Remote RADIUS server secret

dpp_connector string Signed public part of the client dpp_netaccesskey with extrainfo, such as role, expiry time, etc.

dpp_csign_hex string Public part of the Configurator end-user client key.

dpp_netaccesskey_hex string Exposes the DPP Configuration Object’s WPA/SAE PSKwhen acting as Enrollee.

dpp_cc boolean A marker that can be added by the AP to its Beacon andProbe Resp frames. The marker is then used by chirpingenrollees to build their scan lists on which they will chirpon.

min_rssi integer RSSI threshold to prevent low RSSI clients from associatingto specified VAPs.

max_sta integer Limits the number of stations associated with eachVAP.

airtime_precedence string Displays percentage for the WiFi air time per each VAP onthe same radio. Available values:

● "low"● "medium"● "high"

DPP_ConfigThe DPP_Config table stores the parameters that are necessary for enrolling devices without auser interface in a secure WiFi network.


configurator_key_hex string Private key for signing the end-user clients

configurator_key_curve enum End-user client key parameters alias:● prime256v1 (default)

30/102

● secp384r1● secp521r1● brainpoolP256r1● brainpoolP384r1● brainpoolP512r1

configurator_conf_role enum Set of configuration parameters given out to the Enrolleeupon DPP Authentication:

● "sta-psk"● "sta-sae"● "sta-psk-sae"● "sta-dpp"● "sta-dpp-sae"● "sta-dpp-psk-sae"● "ap-psk"● "ap-sae"● "ap-psk-sae"● "ap-dpp"● "ap-dpp-sae"● "ap-dpp-psk-sae"

configurator_conf_ssid_hex string The hex-encoded SSID to be given out to the Enrollee.

configurator_conf_psk_hex string The hex-encodepassphrase to be given out to theEnrollee.

peer_bi_uri string The DPP URI of an Enrollee.

own_bi_key_hex string The local DPP key to be used. Currently planned only tobe used for node onboarding.

own_bi_key_curve enum The own key parameters to be used in own_bi_key_hexr:● prime256v1 (default)● secp384r1● secp521r1● brainpoolP256r1● brainpoolP384r1● brainpoolP512r1

timeout_seconds integer Once a device queue arrives at the particular DPP_Configrow (ie. it moves it into in_progress status), the device willspend up to the timeout_seconds value (in seconds)waiting for a success/failure.

auth enum The DPP pairing intent type that implies which otherparameters need to be set:

● initiate_on_announce (for zero touch, andpod-to-pod onboarding AP side)

● initiate_now (for non-zero touch qr-code scanning)● respond_only (when providing qr code for another

device to connect to the AP)● chirp_and_respond (for pod-to-pod STA side)

31/102

ifnames string The Wifi_VIF_Config ifnames this DPP pairing intentshould be run at. These interfaces’ statuses are then usedto infer if a given DPP_Config row can be started or not, orshould be restarted.

config_uuid uuid Points the result rows to their associated job config.

renew boolean When enabled, the node will provide results in a separatechild-like DPP_Config row entry. This entry will be createdwhile holding onto the given job config and withoutstopping the job.

status enum Current device status:● requested (set by the Cloud only, can be also set

on the onboarding nodes)● in_progress (set by the device when it picks up the

given DPP_Config row and processes it; thedevice processes only 1 DPP_Config row at anygiven time)

● succeeded (DPP Auth completed, and the belowsta_* or dpp_* columns are filled accordingly asmuch as possible)

● timed_out (timeout_seconds have elapsed withnothing else happening)

● failed (DPP Auth failed for whatever reason, as faras the target goes, could sometimes mean"internal timeout" if there is one, specific to targetimplementation)

sta_mac_addr string The Enrollee MAC address. Populated upon DPPsuccessful completion.

sta_netaccesskey_sha256_hex string The public part of the end-user client key of the enrollee.These keys are ephemeral and bound to the given DPPAuthentication. This column is intended for the cloudcontroller to later use the value to the populate DPP_Oftagtable.

Note: These are not bootstrap keys.

akm string Exposes the DPP Configuration Object's AKM that wasreceived when acting as an Enrollee. The DPPConfiguration Object is handed upon DPP ConfigurationRequest after the DPP Authentication has been completed.

Note: This is valid only for node onboarding and does notbelong to the OpenSync 3.0 release. The options are:

● "psk"● "sae"● "psk-sae"● "dpp"● "dpp-sae"● "Dpp-psk-sae"

32/102

Note: AKM support is planned for OpenSync 3.2 release.

psk_hex string Exposes the DPP Configuration Object’s WPA/SAE PSKwhen acting as Enrollee. This is expected only when theakm column includes "psk" or "sae".

ssid_hex string Exposes the DPP Configuration Object’s SSID when actingas Enrollee. The value is expected only whenauth=chirp_and_respond.

pmk_hex string Same as psk_hex, but instead, the WPA PMK can beexposed. Reserved for possible future use.

dpp_netaccesskey_hex string Same as psk_hex, but expected for "dpp" akm.

dpp_connector string Same as psk_hex, but expected for "dpp" akm.

dpp_csign_hex string Same as psk_hex, but expected for "dpp" akm.

DPP_AnnouncementThis table stores information about the onboarded client devices. The table rows are aged outautomatically by the OpenSync node itself.


sta_mac_addr string Chirping Enrollee MAC address observed on the air.

chirp_sha256_hex string The hash of "chirp" public key.

DPP_OftagThis table enables handling of HomePass zoning for the non-PSK (DPP AKM) client devices.

Note: AKM support is planned for OpenSync 3.2 release.


sta_netaccesskey_sha256_hex string The public part of the Enrollee's ephemeral client key.This key is generated during the DPP Auth, is signed bythe Configurator/AP, and handed over back to theEnrollee as a DPP Connector. This is the same keyhash as the one reported in the DPP_Config table.

oftag string The device reads and applies the oftags to non-PSK(DPP AKM) STA connections.

33/102

Wifi_VIF_NeighborsThe Wifi_VIF_Neighbors table contains the neighboring AP information for steering and otherfeatures.


bssid string BSSID of the neighbor

if_name string Associated interface name

channel integer Channel used by the neighbor


Bandwidth used

priority integer Not used (always set to 1)

Wifi_ChannelsThe table enables configuration of maximum Tx power per radio from the Cloud using OVSDB.


channel integer Channel number

radio_ifname string Radio interface name

tx_power integer Desired absolute max TX power in mdBm for the givenchannel

max_tx_power_allowed integer Absolute max TX power in mdBm that the device iscapable of for the given channel

acs_enable boolean Enables or disables ACS

acs_is_enabled boolean Shows current ACS status

34/102

Public_Wifi_ConfigThis table enables Home-as-a-hotspot feature management.


vlan_id integer Defines which vlan is used for traffic.

gre_of_port integer Defines the GRE port number.

gre_endpoint string GRE endpoint FQDN.

keepalive_interval integer GRE tunnel keepalive parameter.

vif_ifnames string Defines which VIFs are to be connected to the GRE tunnel.

tunnel_ifname string Tunnel interface name

Lte_ConfigIn case of an internet outage over primary Ethernet WAN connection, the nodes switch tobackup LTE link. The Lte_Config table stores the necessary parameters to enable LTE to act asa primary link, and Ethernet as a backup link.


if_name string wwan0

lte_failover_enable boolean Enable/disable failover on WAN outage.

manager_enable boolean Enable/disable the LTE manager.

ipv4_enable boolean Enable/disable IPv4 addresses on LTE interface


force_use_lte boolean Test mode to force LTE as the primary WAN interface

esim_download string Name of esim profile being downloaded

esim_active string Name of active esim profile

active_sim_card_slot string Active sim card slot (slot0 or slot1)

modem_enable boolean Enable/disable LTE modem

35/102

report_interval integer MQTT report interval (in seconds)

apn string Access Point Name for the LTE network

lte_bands_enable string Enables/disables the LTE bands.

os_persist boolean Once set to true, the LTE interface configuration remainspersistent after a reboot.

enable_persist boolean Setting “enable_persist” to “true” makes the LTEinterface configuration persistent and brings up the LTEinterface during a wired Ethernet outage.

esim_activation_code string Esim activation code.

esim_download_start boolean Triggers the LTE Manager to pass theesim_activation_code to the LPA code to download a profileto the eSIM.

esim_profile_activate boolean Triggers the LTE Manager to reset the modem and to startusing the downloaded profile.

Lte_StateThe Lte_state table represents the actual state on the device, and is therefore read by theCloud.


if_name string wwan0

lte_failover_enable boolean Enable/disable failover on WAN outage.

manager_enable boolean Enable/disable the LTE manager.



force_use_lte boolean Test mode to force LTE as the primary WAN interface

active_simcard_slot string Active SIM card slot (slot0 or slot1)

modem_enable boolean Enable/disable LTE modem

report_interval integer MQTT report interval (in seconds)

apn string Access Point Name for the LTE network

36/102

lte_bands_enable string LTE bands state.

modem_present boolean Presence of LTE modem

iccid string Integrated circuit card ID

imei string International Mobile Equipment Identifier

imsi string International Mobile Subscriber Identity

chip_serial string Same as IMEI

sim_status string “Inserted”, “Removed”, "Bad", “Unknown”

service_provider_name

string Carrier name (AT&T, T-Mobile, etc.)

mcc integer Mobile Country Code

mnc integer Mobile Network Code

tac integer Tracking Area Code

lte_net_state string LTE network state. The options are:● Not Registered● Registered, Home Network● Not Registered but searching● Registration Denied● Unknown● Roaming

enable_persist boolean State of the “enable_persist” field.

esim_activation_code string Esim activation code.

esim_download_start boolean Triggers the LTE Manager to pass theesim_activation_code to the LPA code to download aprofile to the eSIM.

esim_profile_activate boolean Triggers the LTE Manager to reset the modem and tostart using the downloaded profile.

esim_download_in_progress

boolean Once the download starts, LTE Manager setsesim_download_in_progress to True.

esim_download_complete

boolean When the download is complete, LTE Manager setsesim_download_complete to True.

esim_active_profile boolean Reports the active eSIM profile.

37/102

Wifi_Associated_ClientsWifi_Associated_Clients lists all connected clients and their MAC addresses. OpenSync alsoupdates the reference index in the proper Wifi_VIF_State row.


mac string MAC address of the associated client

state enum(power save,idle, active)

The state of client connection

capabilities enum(11b, 11g,11a, 11n,11ac)

Client wireless capabilities, described by theconformity to one of the specified IEEE 802.11standards

key_id string (Not used)

oftag string OpenFlow tag associated with the client

uapsd integer TBD

kick string The cloud uses this field to instruct the WM to kick aconnected client.

dpp_netaccesskey_sha256_hex string Hash of the DPP Enrollee's public dpp_netaccesskey

The Wifi_Associated_Clients table needs to show all clients on any interface: backhaul, home,guest, etc.

Example:

# ovsh s Wifi_Associated_Clients

---------------------------------------------------------------------

_uuid | 5bba~c937 | 8652~69d0 |

_version | 51b9~1523 | c771~6db9 |

capabilities | ["set",[]] | ["set",[]] |

dpp_netaccesskey_sha256_hex | ["set",[]] | ["set",[]] |

key_id | key--1 | key--1 |

kick | ["map",[]] | ["map",[]] |

mac | e4:26:86:64:7a:81 | e4:26:86:64:7b:3e |

oftag | bhaul--1 | bhaul--1 |

state | active | active |

uapsd | ["set",[]] | ["set",[]] |

---------------------------------------------------------------------

Wifi_Credential_ConfigWifi_Credential_Config provides authentication details for the STA connection.

38/102


ssid string SSID for which the credentials apply

security key/value map credentialsencryption: encryption type (e.g., WPA-PSK )key: authentication key value

onboard_type string gre, no-gre

Example:

# ovsh s Wifi_Credential_Config

------------------------------------------------------

_uuid | 03f2~d792 |

_version | f9b9~5a4a |

onboard_type | gre |

security | ["map",[["encryption","WPA-PSK"], |

: ["key","sample"]]] :

ssid | sample |

------------------------------------------------------

Wifi_Inet_ConfigThe Wifi_Inet_Config is a configuration table and is therefore read by the NM. The table ispushed by the Cloud or CM. The table stores system-wide network configuration:

● Interface address assignment method (DHCP, static, PPPoE, etc.)● Interface MTU● Interface creation for certain interface types (most notably, for GRE tunnels)● DNS services (dnsmasq)


if_name string Interface name. Ethernet and VIF type interfaces must alreadyexist. If they do not, an error should be reported. GRE, VLANand possibly other types of interfaces will be created with thename specified by this field.

if_type enum(bridge,eth, vif,gre, gre6,vlan,pppoe,softwds,tap, lte)

Interface type. Specifies the type of the selected interface.Some interface types are fixed (exist at boot), while the othersmust be created on the fly. Interface creation typically occurswhen a row with the appropriate if_type is inserted into OVS.

● bridge - Specifies the bridge interface. The interface iscreated on the fly.

● eth - Contains the specific configuration for anEthernet interface. The interface must already exist.

● vif - Specifies a wifi interface. It is assumed that theinterface is created by the WM.

39/102

● gre - GRE tunneling interface. The interface is createdon-the-fly when this row is inserted.The gre_ifname,gre_remote_inet_addr, and gre_local_inet_addr fieldsmust not be empty.

● gre6 - Specifies a GREv6 tunneling interface. Enablessetting up GRE tunnels with IPv6 endpoint addresses.

● vlan - Specifies a VLAN interface. The interface iscreated on the fly when a row of this type is inserted.The parent_ifname field must not be empty.

● pppoe - PPP over Ethernet interface(Not supported in OpenSync 2.0)

● softwds - SoftWDS interface; deprecated● tap● lte

if_uuid uuid

enabled boolean The desired interface state. “True” if the interface should be inthe UP state, otherwise the interface is in the DOWN state (theequivalent of ifconfig up/down).

network boolean In certain conditions, the interfaces must be in the UP state,but should not have any configuration applied. This field is“True” if the network configuration should be applied to theinterface, and “False” if it should not.

NAT boolean “True” if NAT/Masquerading should be effective for theoutgoing traffic on this interface.

ip_assign_scheme enum(none,dhcp,static)

● none - the interface has no address configuration. Thisis the equivalent of setting the network field to false

● dhcp - dynamic address configuration using the DHCPprotocol. The dhcp or some other variant of the DHCPclient should be started on this interface.

● static - The interface has static IP configuration. Theaddress present in the “inet_addr” and “netmask” fieldsshould be used for the IP address configuration.

inet_addr string The IP address when “ip_assign_scheme” == “static”

netmask string Interface netmask when “ip_assign_scheme” == “static”

gateway string The default gateway when “ip_assign_scheme” == “static”

broadcast string The broadcast address when “ip_assign_scheme” == “static”

gre_remote_inet_addr string Only applicable when “if_type” == “gre”. Specifies the remotetunnel IP address.

gre_local_inet_addr string Only applicable when “if_type” == “gre”. Specifies the localtunnel IP address.

gre_remote_mac_addr string Only applicable when “if_type” == “gre”. Specifies the remote

40/102

tunnel MAC address.

gre_ifname string Only applicable when “if_type” == “gre”. Specifies the parentinterface for the GRE tunnel.

mtu integer Desired MTU

dns key/valuemap

Only applicable when “ip_assign_scheme” == “static”. DNSserver list.

dhcpd key/valuemap

If populated, the DHCP server should be enabled on thisinterface. This field specifies a list of DHCP options that shouldbe used to configure the DHCP server. See DHCP ServerConfiguration.

upnp_mode enum(disabled,internal,external)

If populated and not set to “disabled”, UPnP is enabled on thisinterface. For more information, see the UPnP Configuration.

● disabled - UPnP is disabled, this is the default.● internal - UPnP is enabled. Only one interface with

this option value must exist. This specifies that a UPnPservice must be started on this interface and that this isthe interface facing the internal network.

● external - UPnP is enabled. Only one interface withthis option value must exist. This specifies that a UPnPservice must be started on this interface and that this isthe interface facing the “external” network (internet).

● internal_iptv - Enabled secondary UPnP server forIPTV. This specifies that a UPnP service must bestarted on this interface and that this is the interfacefacing the internal network. Only one interface with thisoption value must exist.

● external_iptv - Enabled secondary UPnP server forIPTV. This specifies that a UPnP service must bestarted on this interface and that this is the interfacefacing the external network. Only one interface withthis option value must exist.

dhcp_sniff boolean True if DHCP sniffing is enabled on this interface

vlan_id integer Only applicable when “if_type” == “vlan”. This is the VLAN ID.

vlan_egress_qos_map string Enables mapping of ethernet packet-assigned linux internalPRI (QoS) value to any other pri value represented in the PCPfield of the 802.1Q header tag. Mapping is applied for egresstraffic (i.e. output packets). Format of this string must followTO:FROM convention, where TO defines input priority in 0..7range, FROM defines output priority in 0..7 range. Up to 8 pairsseparated by space are allowed.

E.g., “0:4 3:7” modifies the priority field of output VLANpackets, so that pri 0 is changed to 4 and priority 3 is changed

41/102

to 7 in the PCP field of 802.1Q header tag.

parent_ifname string Only applicable when “if_type” == “vlan”. Parent interfacename.

ppp_options key/valuemap

Only applicable when “if_type” == “pppoe”. PPPoE options. Notsupported in OpenSync 2.0.

softwds_mac_addr string Only applicable when “if_type” == “softwds”. Deprecated.

softwds_wrap boolean Only applicable when “if_type” == “softwds”. Deprecated.

igmp boolean Enables IGMP multicast snooping on the interface. Applicableto OVS bridges only (mcast_snooping_enable).

igmp_age integer IGMP multicast snooping aging time in seconds(mcast-snooping-aging-time)

igmp_tsize integer IGMP multicast snooping table size(mcast-snooping-table-size)

igmp_proxy enum(disabled,IGMPv1,IGMPv2,IGMPv3)

Enables or disables ipv4 multicast proxy i.e IGMP on thisinterface. When a version is specified the proxy is enabled withthat version.

mld_proxy enum(disabled,MLDv1,MLDv2)

Enables or disables ipv6 multicast proxy i.e MLD on thisinterface. When a version is specified the proxy is enabled withthat version.

role string Identifies the role of the interface against its name. The value isdefined by the controller and used for reporting to the datapipeline.

mac_reporting boolean Enables or disables MAC reporting for the interface.

no_flood boolean Enables or disables port-flooding for the specified interface.

● “min": 0 (disabled)● "max": 1 (enabled)

Note: Enabling this flag on non-OVS interfaces issues awarning.

collect_stats boolean Enables or disables stats monitoring for each interface.

os_persist boolean Once set to true, the LTE interface configuration remainspersistent after a reboot.

42/102

Note: IP forwarding must always be enabled on the device, regardless of the Wifi_Inet_Config table

settings.

Example:

# ovsh s Wifi_Inet_Config

NAT : false

_uuid : 0ebc~239c

_version : e6f5~ca31

broadcast : 192.168.40.255

dhcp_sniff : ["set",[]]

dhcpd :

["map",[["dhcp_option","3,192.168.40.1;6,192.168.40.1"],["force","false"],["lease_time","12h"],["start","1

92.168.40.50"],["stop","192.168.40.254"]]]

dns : ["map",[]]

enabled : true

gateway : ["set",[]]

gre_ifname : ["set",[]]

gre_local_inet_addr : ["set",[]]

gre_remote_inet_addr : ["set",[]]

gre_remote_mac_addr : ["set",[]]

if_name : br-home

if_type : bridge

if_uuid :

igmp : true

igmp_age : ["set",[]]

igmp_tsize : ["set",[]]

igmp_proxy : IGMPv2

inet_addr : 192.168.40.1

mld_proxy : MLDv2

ip_assign_scheme : static

mtu : ["set",[]]

netmask : 255.255.255.0

network : true

no_flood : true

parent_ifname : ["set",[]]

ppp_options : ["map",[]]

softwds_mac_addr : ["set",[]]

softwds_wrap : ["set",[]]

upnp_mode : internal

vlan_id : ["set",[]]

43/102

Wifi_Inet_StateThis table reflects the current system status and is updated by the NM. The Cloud/CM reads thistable to determine the current network status. If some data is not available on the platform, thisdata can be taken from the homonymous values that are available in the Wifi_Inet_Config tableafter they are applied to the system.



inet_config Uuidreference

Reference to the corresponding row in Wifi_Inet_Config

if_type enum(bridge, eth,vif, gre, gre6,vlan, pppoe,softwds, tap)

Interface type. Can be derived from the homonymous fieldin Wifi_Inet_Config.

if_uuid uuid

enabled boolean “True” if the interface is administratively enabled. Can bederived from the homonymous field in Wifi_Inet_config.

network boolean “True” if the network configuration is applied.Can be derived from the homonymous field inWifi_Inet_Config.

NAT boolean “True” if the Network Address Translation is enabled for theoutgoing traffic on this interface. Can be derived from thehomonymous field in Wifi_Inet_Config.

ip_assign_scheme string The IP address assignment scheme. Can be derived fromthe homonymous field in Wifi_Inet_Config.

inet_addr string Currently configured IP address. If ip_assign_scheme ==“dhcp”, this field must contain the assigned IP address; ifip_assign_scheme == “static”, the value can be derivedfrom the homonymous field in Wifi_Inet_config.

netmask string Currently configured IP netmask. If ip_assign_scheme ==“dhcp”, this field must contain the assigned IP netmask; ifip_assign_scheme == “static”, the value can be derivedfrom the homonymous field in Wifi_Inet_config.

gateway string Currently configured default gateway associated with thisinterface. The value can be derived from the homonymousfield in Wifi_Inet_config.

44/102

broadcast string Currently configured IP broadcast address. Ifip_assign_scheme == “dhcp”, this field should contain theassigned IP broadcast address; if ip_assign_scheme ==“static”, the value can be derived from the homonymousfield in Wifi_Inet_config.

gre_remote_inet_addr string Only applicable if if_type == “gre”. Currently configuredGRE remote tunnel address. Can be derived from thehomonymous field in Wifi_Inet_config.

gre_local_inet_addr string Only applicable if if_type == “gre”. Currently configuredGRE local tunnel address. Can be derived from thehomonymous field in Wifi_Inet_config.

gre_ifname string Only applicable if if_type == “gre”. GRE parent interface.Can be derived from the homonymous field inWifi_Inet_config.

mtu integer Currently configured MTU. Can be derived from thehomonymous field in Wifi_Inet_config.

dns key/valuemap

Currently applied DNS settings related to this interface; canbe derived from the homonymous field in Wifi_Inet_config

dhcpd key/valuemap

Currently applied DHCP server settings pertaining to thisinterface. Can be derived from the homonymous field inWifi_Inet_config.

hwaddr string Interface hardware address

dhcpc key/valuemap

Only applicable if ip_assign_scheme == “dhcp”. This fieldcontains the list of received DHCP client options.

upnp_mode string Currently configured UPnP mode of operation. Can bederived from the homonymous field in Wifi_Inet_config.

vlan_id integer Only applicable if if_type == “vlan”. The VLAN tagassociated with the current interface. can be derived fromthe homonymous field in Wifi_Inet_config.

vlan_egress_qos_map string Enables mapping of ethernet packet-assigned linux internalPRI (QOS) value to any other pri value represented in thePCP field of the 802.1Q header tag.

parent_ifname string Only applicable if if_type == “vlan”, The parent interface.Can be derived from the homonymous field inWifi_Inet_config.

softwds_mac_addr string Only applicable if if_type == “softwds”. Not supported inOpenSync 2.0.

softwds_wrap boolean Only applicable if if_type == “softwds”. Not supported inOpenSync 2.0.

45/102

Wifi_Master_StateThe Wifi_Master_State table enables synchronization between WM, NM, and CM. CM uses thistable for determining the preferred backhaul connection (read-only). WM and NM update thevalues in this table. WM updates interfaces of type vif, while NM updates the rest.


dhcpc map DHCP client parameters


if_type enum Interface type. Specifies the type of the selected interface.Some interface types are fixed (exist at boot), while theothers must be created on the fly. Interface creationtypically occurs when a row with the appropriate if_type isinserted into OVS.

● bridge - this row specifies the bridge interface. Theinterface is created on the fly.

● eth - this row contains the specific configuration foran Ethernet interface. The interface must alreadyexist.

● vif - this row specifies a wifi interface. It isassumed that the interface is created by the WM.

● gre - GRE tunneling interface. The interface iscreated on-the-fly when this row is inserted.Thegre_ifname, gre_remote_inet_addr, andgre_local_inet_addr fields must not be empty.

● gre6 - specifies a GREv6 tunneling interface.Enables setting up GRE tunnels with IPv6 endpointaddresses.

● vlan - this row specifies a VLAN interface. Theinterface is created on the fly when a row of thistype is inserted. The parent_ifname field must notbe empty.

● pppoe - PPP over Ethernet interface(Not supported in OpenSync 2.0)

● softwds - SoftWDS interface; deprecated

if_uuid uuid Pointer to the Wifi_Inet_Config record

inet_addr string IP address

netmask string Netmask

network_state enum Network state● up● down

46/102

onboard_type string Onboard type

port_state enum Physical port state:● active● inactive

uplink_priority integer Uplink priority (deprecated)

Example:

# ovsh s Wifi_Master_State

--------------------------------------------------------------------------------

_uuid | 995f~e506 | 9a72~ea4c | c69e~dab5 | 14df~c3a3 |

_version | 0491~5aa8 | 13a7~017f | 1ce1~9b2e | 2849~b720 |

dhcpc | ["map",[]] | ["map",[]] | ["map",[]] | ["map",[]] |

: : : : :

: : : : :

: : : : :

: : : : :

: : : : :

if_name | eth1 | pgd3-169 | wl2.1 | wl0.3 |

if_type | eth | gre | vif | vif |

if_uuid | 0000~0000 | 0000~0000 | 0000~0000 | 0000~0000 |

inet_addr | 0.0.0.0 | 0.0.0.0 | 169.254.171.129 | 169.254.3.1 |

netmask | 0.0.0.0 | 0.0.0.0 | 255.255.255.128 | 255.255.255.128 |

network_state | up | up | up | up |

onboard_type | ["set",[]] | ["set",[]] | ["set",[]] | ["set",[]] |

port_state | active | active | active | active |

uplink_priority | ["set",[]] | ["set",[]] | ["set",[]] | ["set",[]] |

--------------------------------------------------------------------------------

IP_Port_ForwardThe IP_Port_Forward table contains the user-defined port forwarding rules.This feature is only used when a device is configured to run in bridge mode.


protocol enum(tcp, udp)

Protocol type

src_ifname string Source interface for the rule

src_port integer Source port

dst_port integer Destination port

dst_ipaddr string Destination IP address

47/102

OVS_MAC_LearningThe OVS_MAC_Learning table reports the current bridge MAC learning table to the Cloud. Inthe case of OVS bridges, the contents of this table are derived from various OVS tables.


brname string Bridge name

ifname string Interface from which the learned MAC address originates

hwaddr string Learned MAC address

vlan integer VLAN ID

Example:

# ovsh s OVS_MAC_Learning

------------------------------

_uuid | 631e~2674 |

_version | a321~1956 |

brname | br-home |

hwaddr | 00:11:22:33:44:55 |

ifname | eth0 |

vlan | 0 |

------------------------------

48/102

DHCP_leased_IPThe DHCP_leased_IP table presents all device-specific information retrieved through DHCPfingerprinting, such as IP (only IPv4 in OpenSync 2.0) or MAC address.


hwaddr string MAC address of the associated client

inet_addr string IP address

hostname string Client hostname

fingerprint string DHCP options

lease_time string Lease time of DHCP

Example:

# ovsh s DHCP_leased_IP

------------------------------------------------------------------------------

_uuid | 728f~a081 | 480c~b840 | 404e~ad5f |

_version | 3b7a~6e5f | 94be~33ca | 1f07~9a49 |

fingerprint | | | 1,121,33,3,6,12,15,28, |

: : : 42,51,54,58,59,119 :

hostname | P1K634058600_Pod | P1K634073700_Pod | rpi-4 |

hwaddr | 00:00:00:00:00:11 | 00:00:00:00:00:22 | 11:22:33:44:55:66 |

inet_addr | 192.168.2.17 | 192.168.2.19 | 192.168.2.27 |

lease_time | 259200 | 259200 | 259200 |

------------------------------------------------------------------------------

49/102

DHCP_reserved_IPThe DHCP_reserved_IP table assigns a specific IP address to a known device MAC address.


hostname string Client hostname

hw_addr string MAC address of associated client

ip_addr string IP address

Example:

# ovsh s DHCP_reserved_IP

------------------------------

_uuid | ff76~1ece |

_version | a18f~b288 |

hostname | ["set",[]] |

hw_addr | 11:22:33:44:55:66 |

ip_addr | 192.168.40.77 |

------------------------------

50/102

DHCP Server ConfigurationThe DHCP server configuration is represented as a map of strings (array of keys, value pairs) inthe dhcpd column of the Wifi_Inet_Config table. Since a map is a very flexible structure, theformat used by the dhcpd column requires some explanation.

The format that is understood by the NM is as follows:

Key Value / Description

dhcp_option “option_id,value;option_id,value”Specifies a list of DHCP options to be provided by the DHCP server to the DHCPclient.Example: “3,192.168.40.1;6,192.168.40.1”Note: DHCP option 3 = router; dhcp option 6 = DNS server

force “true” or “false”Not used in OpenSync 2.0

lease_time Lease time in the N[mhs] format.his format must be understood by the dnsmasq.Example: “12h”

start IP pool start address

stop IP pool end address

UPnP ConfigurationThe UPnP configuration requires exactly two interfaces to work properly: one WAN and oneLAN interface. These interfaces are referred to as “external” and “internal” respectively.

These two interfaces create dynamic port forwards from the WAN interface to the IP address onthe LAN interface.

DHCP SniffingThe DHCP sniffing feature allows NM to capture DHCP packets on the configured interface, andextract the assigned hostname and DHCP fingerprint. This feature is mainly used when thedevice is configured to run in bridge mode.

51/102

Wifi_Stats_ConfigThe Wifi_Stats_Config table is used to configure the stats collected on the device.


stats_type enum(neighbor,survey,client,capacity,radio,essid,quality,device,rssi,steering)

The Cloud selects the stats type when it wants to fetchcertain statistics from the device.

NOTE: Only neighbor, survey, client, device, rssi, andsteering are used in OpenSync 2.0.

report_type enum(raw,average,histogram,percentile,diff)

Cloud can specify different reporting formats:● raw: bins of samples collected during the

sampling_interval time● average: value of samples or specific parameters

collected during the reporting_interval time● histogram: distributed sample values through the

reproting_interval● percentile: of sampled values inside the

reporting_interval● diff: special reporting when only diff values

between samples are sent to the Cloud

radio_type enum(2.4G, 5G,5GL, 5GU)

The selection of radio_type configuration depends on thedevice wireless capabilities listed inside theWifi_VIF/Radio_State tables.

survey_type enum(on-chan,off-chan,full)

For surveying (scan and utilization), the Cloud specifies thefollowing types:

● on-chan: measurements on the home channel canbe done frequently and without user interruption.They are done periodically.

● off-chan: measurements on the foreign channelmust be done with care, since they involveswitching to off-channel. The channelmeasurements listed in channel_list areperiodically chosen using the round robin fashion(“1,6,11” -> t0=1, t1=6, t2=11, t3=1) to minimizeuser impact.

● full: the measurements are done on all channels atonce and as specified in the channel_list (“1,6,11”-> t0=1,6,11 t1=1,6,11) which is very intrusive.

reporting_interval integer Interval specifying the time after which the report is sent

52/102

reporting_count integer Max number of consecutive reports. 0 means periodic.

sampling_interval integer Interval specifying the time between sample collections

survey_interval_ms integer Scan DWEL time used for surveying

channel_list set ofintegers

Channel list that needs to be surveyed

threshold key/valuemap

Threshold specifies the intrusiveness behavior of the scan,while it can also contain the diff thresholds:

● max_delay: max delay of measurement when thethreshold is reached - each sampling interval thethreshold delta is used

● util: utilization percentage that still allowsmeasurements

Example:

# ovsh s Wifi_Stats_Config-------------------------------------------------------------------------------------------------------..._uuid | b5db~37e6 | de8e~6de0 | 006d~c137 | 88e8~9d00 | 0d50~4d65 |_version | 0572~d01b | 37ff~8d4e | 4a66~909b | 735f~01af | 82a9~ea8f |channel_list | ["set",[40,153]] | ["set",[]] | ["set",[1,6,11]] | ["set",[]] | ["set",[]] |radio_type | 5G | 2.4G | 2.4G | 5G | 2.4G |reporting_count | 0 | 0 | 0 | 0 | 0 |reporting_interval | 0 | 60 | 120 | 60 | 900 |sampling_interval | 0 | 0 | 0 | 10 | 0 |stats_type | survey | neighbor | neighbor | client | device |survey_interval_ms | 10 | 0 | 0 | ["set",[]] | ["set",[]] |survey_type | off-chan | on-chan | off-chan | ["set",[]] | ["set",[]] |threshold | ["map",[["max_delay", | ["map",[]] | ["map",[]] | ["map",[]] | ["map",[]] |

: 600],["util",10]]] : : : : :-------------------------------------------------------------------------------------------------------...

...-------------------------------------------------------------------------------------------------| 27f5~40e1 | 3c28~cbb1 | 52e5~0480 | d943~6425 | ebe4~aa07 | 9205~441b || a271~1855 | a4aa~db93 | ad9a~918c | cf24~f006 | da27~99f0 | ff08~5577 || ["set",[1,6,11]] | ["set",[]] | ["set",[40,153]] | ["set",[]] | ["set",[]] | ["set",[]] || 2.4G | 5G | 5G | 2.4G | 5G | 2.4G || 0 | 0 | 0 | 0 | 0 | 0 || 120 | 60 | 0 | 60 | 60 | 60 || 10 | 10 | 0 | 10 | 0 | 10 || survey | survey | neighbor | client | neighbor | survey || 50 | 0 | 10 | ["set",[]] | 0 | 0 || off-chan | on-chan | off-chan | ["set",[]] | on-chan | on-chan || ["map",[["max_delay", | ["map",[]] | ["map",[]] | ["map",[]] | ["map",[]] | ["map",[]] |: 600],["util",10]]] : : : : : :

...-------------------------------------------------------------------------------------------------

53/102

Band_Steering_ConfigThe table enables general configuration of band steering and client steering parameters.


chan_util_avg_count integer Channel utilization average count

chan_util_check_sec integer Channel utilization sampling period for pre-associationband steering (in seconds)

chan_util_hwm integer Channel utilization high water mark

chan_util_lwm integer Channel utilization low watermark

dbg_2g_raw_chan_util boolean Enables channel utilization logging on the 2.4G interface

dbg_2g_raw_rssi boolean Enables raw RSSI logging on the 2.4G interface

dbg_5g_raw_chan_util boolean Enables channel utilization logging on the 2.4G interface

dbg_5g_raw_rssi boolean Enables raw RSSI logging on the 5G interface

debug_level integer Sets overall logging severity level

def_rssi_inact_xing integer Inactive RSSI threshold

def_rssi_low_xing integer Inactive RSSI low threshold

def_rssi_xing integer Inactive RSSI high threshold

gw_only boolean Indicates if this is the only OpenSync device (gateway) inthis location

if_name_2g string 2.4G interface name

if_name_5g string 5G interface name

inact_check_sec integer Client inactivity check period

inact_tmout_sec_normal integer Client inactivity timeout in normal mode

inact_tmout_sec_overload integer Client inactivity timeout in overload mode

kick_debounce_period integer Time for which client kick is blocked due to failed attempts

kick_debounce_thresh integer Number of failed attempts before client kicks are disabledfor the time period defined by kick_debounce_period

stats_report_interval integer Time period in seconds which defines band steering relatedstats reporting to the Cloud

54/102

Band_Steering_ClientsThis table contains per client band steering configuration and states.


backoff_exp_base integer Exponential duration after pre-assoc steeringfailures

backoff_secs integer Backoff timer before another steering event isprocessed

cs_mode enum(off, home,away)

Client steering mode:● off● home● away

cs_params string Client steering parameters

cs_state enum(none,steering,expired,failed,xing_low,xing_high,xing_disabled)

Client steering state:● none● steering● expired● failed● xing_low● xing_high● xing_disabled

force_kick enum(none,speculative,directed,ghost_device)

Trigger force client kick

hwm integer High watermark

kick_debounce_period integer When a kick has failed, another kick will not beattempted for this amount of seconds (and onceclient’s RSSI crosses the HWM/LWM thresholdagain).

kick_reason integer Client kick reason

kick_type enum(none,deauth,disassoc,bss_tm_req,rrm_br_req,btm_deauth,btm_disassoc)

Different kick types:deauth - sending deauthentication frame to theclientdisassoc - sending disassociation frame to theclientbss_tm_req - sending BSS TransitionManagement(802.11v) frame to the clientbtm_deauth - If client is 11v capable, send a

56/102

802.11v frame, else send a deauthenticationframe.btm_disassoc - If the client is 11v capable, senda 802.11v frame, else send a disassociationframe.

kick_upon_idle boolean If kicking is enabled, attempt to “kick” the clientonly if it is not ‘busy’ (doing data transfer). If theclient is busy, wait until it becomes idle.

lwm integer Low watermark - if kicking is enabled, when aclient's active RSSI goes below this value,attempt to "kick" it for being a “sticky” client.

mac string Client MAC address

max_rejects integer If we get this number of rejects within the timeperiod (rejects_tmout_secs), we considersteering as failed.

pre_assoc_auth_block boolean Block responses to authorization requests from aclient during pre-association band steering.

pref_5g enum(hwm,never,always)

Prefer connecting clients on 5 GHz radio basedon these settings:

● hwm - depending on the signal strengthon 5 GHz, the radio blocks 2.4 GHz

● never● always

reject_detection string Why was the client rejected? Possible values:● none● probe_all● probe_null● probe_direcet● auth_blocked

rejects_tmout_secs integer Number of rejects (max_rejects) within the timeperiod (rejects_tmout_secs) to be considered asteering failure, and to not go into backoff for 300seconds (backoff_secs).Note: Deprecated field. A timer-based pre-assoc5 GHz steering is used instead.

pref_5g_pre_assoc_block_timeout_msecs

integer This field specifies how long the 2.4 GHz bandshould be blocked for an ST. The value is validonly when pref_5g == always policy.

rrm_bcm_rpt_params map 802.11k beacon report request parameters

sc_kick_debounce_period integer Steering from Cloud(sc) client kick debounceperiod

57/102

sc_kick_reason integer Steering from Cloud(sc) client kick reason

sc_kick_type enum(none,deauth,disassoc,bss_tm_req,rrm_br_req,btm_deauth,btm_disassoc,rrm_deauth,rrm_disassoc)

Possible kick types:● none● disassoc● deauth● 802.11v BSS Transition Request● 80211k Beacon Report Request● 802.11v request or deauth● 80211v request or disassoc

sc_btm_params map 802.11v BSS Transition request parameters

stats_2g map Not used

stats_5g map Not used

steer_during_backoff bool Allow/disallow steering during backoff

sticky_kick_guard_time integer Guard time (in seconds) describe how longBM will monitor connection(s) aftersteering/sticky kick.

steering_kick_guard_time integer Guard time (in seconds) describe how longBM will monitor connection(s) aftersteering/sticky kick.

steering_btm_params map BSS Transition Management (802.11v)configuration

steering_fail_cnt integer Client steering failed attempt count

steering_kick_cnt integer Client steering kick count

steering_success_cnt integer Client steering successful attempt count

sticky_kick_cnt integer Sticky client kick count

sticky_kick_debounce_period integer Sticky client kick debounce period

sticky_kick_reason integer Sticky client kick reason

sticky_kick_type enum(none,deauth,disassoc,bss_tm_req,rrm_br_req,btm_deauth,btm_disassoc)

Possible kick types:● none● disassoc● deauth● 802.11v BSS Transition Request● 80211k Beacon Report Request● 802.11v request or deauth● 80211v request or disassoc

58/102

pref_6g string Prefer connecting clients on 6 GHz radio basedon these settings:

● never● always

pref_6g_pre_assoc_block_timeout_msecs

integer This field specifies for how long an STA should beblocked. The value is valid only when pref_6g ==hwm policy.

neighbor_list_filter_by_beacon_report

boolean Enables/disables filtering of neighbors per STAusing the 11k/v neighbor report.

59/102

Example:

# ovsh s Band_Steering_Clients

---------------------------------------------------------------------------------------------------

_uuid | de8a~5d9e |

_version | b09a~1360 |

backoff_exp_base | 2 |

backoff_secs | 120 |

cs_mode | ["set",[]] |

cs_params | ["map",[]] |

cs_state | ["set",[]] |

force_kick | ["set",[]] |

hwm | 35 |

kick_debounce_period | 60 |

kick_reason | 1 |

kick_type | btm_deauth |

kick_upon_idle | true |

lwm | 20 |

mac | 30:07:4d:33:60:c8 |

max_rejects | 7 |

pre_assoc_auth_block | true |

pref_5g | always |

reject_detection | probe_all |

rejects_tmout_secs | 120 |

rrm_bcn_rpt_params | ["map",[]] |

sc_btm_params | ["map",[]] |

Sc_kick_debounce_period | 0 |

sc_kick_reason | 0 |

sc_kick_type | ["set",[]] |

stats_2g | ["map",[]] |

stats_5g | ["map",[]] |

steer_during_backoff | false |

steering_btm_params | ["map",[["abridged","1"],["bss_term","0"],["btm_max_retries","3"], |

: ["btm_retry_interval","10"],["disassoc_imminent","1"],["pref","1"], :

: ["valid_interval","255"]]] :

steering_fail_cnt | 0 |

steering_kick_cnt | 0 |

steering_success_cnt | 0 |

sticky_btm_params | ["map",[["abridged","1"],["bss_term","0"],["btm_max_retries","3"], |

: ["btm_retry_interval","10"],["disassoc_imminent","1"],["inc_neigh", :

: "true"],["pref","0"],["valid_interval","255"]]] :

sticky_kick_cnt | 0 |

sticky_kick_debounce_period | 60 |

sticky_kick_reason | 1 |

sticky_kick_type | btm_deauth |

---------------------------------------------------------------------------------------------------

60/102

AW_LM_ConfigThis table enables the logpull functionality.


upload_location string URL for uploading the collected files

upload_token string Security token for uploading the collected files

name string (Deprecated)

periodicity string (Deprecated)

AW_LM_StateThis table is DEPRECATED.

AW_DebugThe table is currently used for setting the log levels to the registered modules. Note that thistable is used only as a local interface.


name string Module name used for registration to the OpenSync loglibrary

log_severity string Dynamic log severity, which can be one of these values:● EMERG - System is unusable● ALERT - Action must be taken immediately● CRIT - Critical conditions● ERR - Error conditions● WARNING - Warning conditions● NOTICE - Normal but significant condition● INFO - Informational message● DEBUG - Debug message● TRACE - Trace messages

61/102

Openflow_ConfigThis table contains all the flows that need to be applied to the system. Flows can be set as aconstant or defined as a template by using variables described in Openflow_Tag orOpenflow_Tag_Group table.


action string Flow action (drop, normal, resubmit, etc.)

bridge string Bridge name

priority integer Flow priority

rule string Flow rule or flow rule template

table integer Flow table

token string Name of the flow

Openflow_StateThis table reflects the status of all currently applied flows.


bridge string Bridge name

openflow_config string NOT USED

success boolean Marks successfully applied flow

token string Name of the flow

Openflow_TagThis table enables expansion of the packet flow rules. Defines variables used to construct a flowin combination with a template rule from Openflow_Config table


cloud_value string Cloud-only tag value

device_value string Device-only tag value

62/102

name string Tag value name

Openflow_Local_TagIf Captive Portal is used at a location, this table stores the white-listed domains for resolving theIP addresses. These are used subsequently to create openflow rules to allow traffic to thestored white-listed domains.


values string White-listed domain address

name string Descriptive name of the white-listed domain

Openflow_Tag_GroupThis table combines a list of tags defined in the Openflow_Tag table to create a new group tag.Group tag can be used to construct a flow in combination with a template rule from theOpenflow_Config table.


tags string List of tags from Openflow_Tag table

name string Tag group name

Client_Nickname_Config (not used)Used for nickname synchronization between the device and the Cloud.



nickname string Client nickname

63/102

Example:

# ovsh s Client_Nickname_Config

------------------------------

_uuid | c431~a7a0 |

_version | 4913~5531 |

mac | 00:11:22:33:44:55 |

nickname | device_test_name |

------------------------------

Client_Freeze_Config (not used)The device freeze feature restricts client access to the internet or local network. Users set therules over mobile app/cloud or local GUI if present. The user can perform instant freeze or mayarrange multiple scheduled freezes (Bedtime, School nights, custom).


blocked bool Block or unblock the client


source enum(init,cloud,gw)

Mark the source of truth:● init - unknown owner after reboot● cloud - cloud managed client● gw - gateway or device is the owner

type enum(schedule,always)

The cloud controller only sets "always" value here.However, some devices might set the values to "schedule"if the device supports a schedule mode that is configuredoutside the scope of the cloud controller.

Example:

# ovsh s Client_Freeze_Config

------------------------------

_uuid | 5382~faee |

_version | f039~bd24 |

blocked | false |

mac | 69:78:65:66:76:69 |

source | gw |

type | schedule |

------------------------------

64/102

Flow_Service_Manager_ConfigThis table provisions the plugins to the FSM service. The table informs the FSM about theplugin name, and provides additional information: location of the shared library instantiating theplugin, and plugin type (parser dedicated to a specific traffic type, DPI plugin, or webcategorization backend plugin).


handler string Unique FSM plugin identifier

type enum(parser,web_cat_provider,dpi)

Plugin type:- parser: dedicated to a specific traffic type- dpi: DPI plugin- web_cat_provider: dedicated to categorize the webaccess type

if_name string Name of the tap interface, from which the FSM gets thepackets and forwards them to the plugin packet handler

pkt_capt_filter string An optional BPF filter applied to the incoming traffic.Originally used to filter out the multicast/broadcast traffic;now optional.

plugin string The DSO file instantiating the plugin.

other_config key/valuemap

A (key, value) map allowing the opaque parameters to passto the plugin.

Example:

# ovsh s Flow_Service_Manager_Config -w handler==http

-------------------------------------------------------------------------------------------------

_uuid | 63d6~3fc4 |

_version | d3a1~0f61 |

handler | http |

if_name | br-home.http |

other_config | ["map",[["mqtt_v","HTTP/Requests/dog1/4C7770142A/59efd33d2c93832025330a3e"]]] |

pkt_capt_filter | tcp dst port 80 |

plugin | |

type | ["set",[]] |

-------------------------------------------------------------------------------------------------

65/102

FSM_PolicyThe FSM_Policy table instructs the requesting FSM plugins which action to take in case of aspecific event. Its main usage targets advanced device typing, IP threat detection, and contentfiltering.

The organized policy names are contained in the rules columns. A rule is a set made of filters,an action, and a report policy. Should an event pass the filters, the plugin applies the rules’saction, and reports the event according to the report policy.


name string Policy rule name

idx integer Within a policy name space; the sorted index of thecurrent rule

mac_op enum(in, out)

{event mac} (mac_op) [set of macs] filter. IE is mac Xin/out the given set of macs

macs set of strings The set of macs to compute an event against

fqdn_op enum(in, out, sfr_in,sfr_out, sfl_in,sfl_out)

{event fqdn} (fqdn_op) [set of fqdns] filter● sfr denotes “start from right”● sfl denotes “start from left”

These prefixes allow wildcard matching.

fqdns string The set of FQDNs to compute an event against

fqdncat_op enum(in, out)

{event fqdn category} (fqdncat_op) [set of fqdncategories] filter.The FQDN category is determined by theweb_cat_provider plugin.

fqdncats set of integers The set of FQDN categories to compute an eventagainst.

ipaddr_op enum(in, out)

{ip addr} (ipaddr_op) [set of ip addr] filter.

ipaddrs set of strings The set of ip addresses to compute an event against.

risk_level integer The web remote resource risk level to compareagainst.

risk_op enum(eq, neq, gt, lt,gte, lte)

The risk operation to use in the risk assessment.

app_op string Allows the controller to request invalidation of

66/102

Gatekeeper cache entries.

apps string Allows the controller to request invalidation ofGatekeeper cache entries.

log enum(none, all,blocked)

none - do not log the eventall - log the event regardless of the actionblocked - log only blocked events (web categorization)

action enum(allow, drop,update_tag,gatekeeper,flush, flush all)

Applies to web categorization events.

next key:integer Enables jumping to the specific rule of the requestedtable, chaining up the event processing across multipletables.

policy string Policy rule name

redirect[0..2] string Redirects a FQDN resolution to the providedIpv4/IPv6/cname

other_config key/value map A (key, value) map allowing the opaque parameters topass the rule.

Example:

# ovsh s FSM_Policy -w idx==2

-------------------------------

_uuid | 6333~af57 |

_version | b5be~006c |

action | ["set",[]] |

fqdn_op | ["set",[]] |

fqdncat_op | ["set",[]] |

fqdncats | ["set",[]] |

fqdns | ["set",[]] |

idx | 2 |

ipaddr_op | ["set",[]] |

ipaddrs | ["set",[]] |

log | all |

mac_op | out |

macs | $[dns-exclude] |

name | dt_dns |

next | ["map",[]] |


policy | my_policy |

redirect | ["set",[]] |

risk_level | ["set",[]] |

risk_op | ["set",[]] |

-------------------------------

67/102

FCM_Collector_ConfigThis table contains configurations for the FCM plugin. This plugin collects and reports thenetwork flow statistics.


name string Name of the plugin used for network flow collection.Important! Do not modify the name of the plugin.

interval integer Collection interval for network flow samples in seconds.

filter_name string Name of FCM_Filter to be applied on network flows duringthe collection time

report_name string Name of FCM_Report_Config to be used for sendingreports about the collected flows.

other_config key/valuemap

Contains plugin-specific configurations such as sharedlibrary path, entry function name of the plugin, andconntrack zone to be used for flow collection.

Example:

# ovsh s FCM_Collector_Config

-----------------------------------------------------------------------------------------

_uuid | 7315~98ec |

_version | 7fe0~97b1 |

filter_name | ip_filter |

interval | 10 |

name | ct_stats |

other_config | ["map",[["ct_zone","1"],["dso_init","ct_stats_plugin_init"],["dso_path", |

: "/usr/xxxx/lib/"]]] :

report_name | ip_flow_report |

-----------------------------------------------------------------------------------------

68/102

FCM_FilterThis table contains various FCM filter attributes that can be applied to the network flows.


name string Name of the filter

index integer Priority of the filter. Index 0 is applied first, and so on.

smac set of strings Array of source mac addresses. Accepts smac Tags.

dmac set of strings Array of destination mac addresses. Accepts dmac tags.

vlanid set of integers Array of VLAN ID values

src_ip set of strings Array of source IP addresses

dst_ip set of strings Array of destination IP addresses

src_port set of strings Array of source port values

dst_port set of strings Array of destination port values

proto set of integers Array of protocol number values

smac_op enum(in, out, none)

in - Flows matching ‘smac’ values will be considered forfinal ‘action’out - Flows not matching ‘smac’ values will be consideredfor final ‘action’

dmac_op enum(in, out, none)

in - Flows matching ‘dmac’ values will be considered forfinal ‘action’out - Flows not matching ‘dmac’ values will be consideredfor final ‘action’

vlanid_op enum(in, out, none)

in - Flows matching ‘vlanid’ values will be considered forfinal ‘action’out - Flows not matching ’vlanid’ values will be consideredfor final ‘action’

src_ip_op enum(in, out, none)

in - Flows matching ’src_ip’ values will be considered forfinal ‘action’out - Flows not matching ’src_ip’ values will be consideredfor final ‘action’

dst_ip_op enum(in, out, none)

in - Flows matching ’dst_ip’ values will be considered forfinal ‘action’out - Flows not matching ’dst_ip’ values will be consideredfor final ‘action’

69/102

src_port_op enum(in, out, none)

in - Flows matching ’src_port’ values will be considered forfinal ‘action’out - Flows not matching ‘src_port’ values will beconsidered for final ‘action’

dst_port_op enum(in, out, none)

in - Flows matching ‘dst_port’ values will be considered forfinal ‘action’out - Flows not matching ‘dst_port’ values will beconsidered for final ‘action’

proto_op enum(in, out, none)

in - Flows matching ‘proto’ values will be considered forfinal ‘action’out - Flows not matching ‘proto’ values will be consideredfor final ‘action’

pktcnt integer Number of packets in a flow

pktcnt_op enum(lt, leq, gt, geq, eq,neq)

le - Flows having packet count less than ‘pktcnt’ will beconsidered for final ‘action’leq - Flows having packet count less than or equal to `pktcnt’ will be considered for final ‘action’gt - Flows having packet count greater than ‘pktcnt’ will beconsidered for final ‘action’geq - Flows having packet count greater than or equal to‘pktcnt’ will be considered for final ‘action’eq - Flows having packet count equal to ‘pktcnt’ will beconsidered for final ‘action’neq - Flows having packet count not equal to ‘pktcnt’ willbe considered for final ‘action’

action enum(include, exclude)

Final action of the considered flows based on the abovesaid options:include - Flow will be included for further processing inFCMexclude - Flow will be excluded from further processing inFCM

other_config set of key:value Not used

70/102

Example:

# ovsh s FCM_Filter

------------------------------------------------

_uuid | ba66~04a1 | fe11~6498 |

_version | 6227~3ad0 | 7b57~780b |

action | include | include |

dmac | ${iot_devices} | ["set",[]] |

dmac_op | in | ["set",[]] |

dst_ip | ["set",[]] | ["set",[]] |

dst_ip_op | ["set",[]] | ["set",[]] |

dst_port | ["set",[]] | ["set",[]] |

dst_port_op | ["set",[]] | ["set",[]] |

index | 1 | 2 |

name | ip_filter | ip_filter |

other_config | ["map",[]] | ["map",[]] |

pktcnt | ["set",[]] | ["set",[]] |

pktcnt_op | ["set",[]] | ["set",[]] |

proto | ["set",[]] | ["set",[]] |

proto_op | ["set",[]] | ["set",[]] |

smac | ["set",[]] | ${iot_devices} |

smac_op | ["set",[]] | in |

src_ip | ["set",[]] | ["set",[]] |

src_ip_op | ["set",[]] | ["set",[]] |

src_port | ["set",[]] | ["set",[]] |

src_port_op | ["set",[]] | ["set",[]] |

vlanid | ["set",[]] | ["set",[]] |

vlanid_op | ["set",[]] | ["set",[]] |

------------------------------------------------

71/102

FCM_Report_ConfigThis table is used for configuring statistics reports from FCM to the Cloud.


name string Report config name

interval integer Reporting interval of collected flows to MQTT server inseconds

format enum(cumulative, delta,raw)

Specifies format of reporting of flows.cumulative - Reports consolidated bytes/packets of flowsfrom the start of flow at each report intervaldelta - Reports difference in bytes/packets of flowsbetween each consecutive report interval.

hist_interval integer Histogram interval of reports. Not used.

hist_filter string Name of FCM_Filter to be used for histogram reports. Notused.

report_filter string Name of FCM_Filter to be used when reporting

mqtt_topic string MQTT topic to be used for reporting

other_config set ofkey:value

Not used.

Example:

# ovsh s FCM_Report_Config

-----------------------------------------------------------------------

_uuid | bfbe~c686 |

_version | 1689~4b6d |

format | cumulative |

hist_filter | ["set",[]] |

hist_interval | 0 |

interval | 60 |

mqtt_topic | IP/Flows/IoT/dog1/4C777013FE/5c58ae5050d44e0b8df6da11 |

name | ip_flow_report |


report_filter | ["set",[]] |

-----------------------------------------------------------------------

72/102

IP_InterfaceThis table includes information for L3 configuration and status reporting. The IPv6 tables refer toor are referenced by this table.


name string Name of the IP interface

enable boolean Enable or disable the interface

status enum Current operational state of the interface. Enumeration of:● up● down● unknown● dormant● notpresent● lowerlayerdown● error

interfaces set ofuuids

Reference to the table:Interface

if_name string Interface name as configured in the operating system

ipv4_addr set ofuuids

Reference to the table: IPv4_Address

ipv6_addr set ofuuids

Reference to the table: IPv6_Address

ipv6_prefix set ofuuids

Reference to the table: IPv6_Prefix

qos set ofuuids

Reference to the table: Interface_QoS

73/102

IPv4_Address (not used)This table is used for IPv4 address configuration and reporting. Tables that directly require anIPv4 address (either for configuration or reporting) strongly reference the rows in this table.


enable boolean Enables or disables this IPv4 address

status enum(disabled,enabled,error)

The status of this IPv4 address entry. Enumeration of:● disabled● enabled● error

address string IPv4 address

subnet_mask string Subnet mask (CIDR notation)

type enum Addressing method used to assign the IPv4 address.Enumeration of:

● dhcpikev2

● auto_ip● ipcp● static

Note: Not used in OpenSync 2.0.

74/102

IPv6_AddressThis table enables IPv6 address configuration and reporting. Tables that directly require an IPv6address (either for configuration or reporting) refer to the rows in this table.


enable bool Enables or disables this IPv6 address


The status of this IPv6 address entry. Enumeration of:● disabled● enabled● error

address_status enum The status of the IPv6 address, indicating whether it can beused for communication. Enumeration of:

● preferred● deprecated● invalid● inaccessible● unknown● tentative● duplicate● optimistic

address string IPv6 address

origin enum Mechanism using which the IPv6 address is assigned.Enumeration of:

● auto_configured● dhcp● ikev2● map● well_known● static

prefix string Prefix of the IPv6 address (CIDR notation)

preferred_lifetime string The time at which this address will cease to be preferred(i.e. will become deprecated), or empty if not known. For aninfinite lifetime, the parameter value MUST be infinite.

valid_lifetime string The time at which this address will cease to be valid (i.e.will become invalid), or empty if unknown. For an infinitelifetime, the parameter value MUST be infinite.

75/102

IPv6_PrefixThis table enables IPv6 prefix configuration and reporting. Tables that directly require an IPv6prefix (either for configuration or reporting) refer to the rows in this table.


enable boolean Enables or disables this IPv6 prefix


The status of this IPv6 prefix entry. Enumeration of:● disabled● enabled● error

prefix_status enum The status of the IPv6 prefix, indicating whether it can beused for communication. Enumeration of:

● preferred● deprecated● invalid● inaccessible● unknown

address string IPv6 address prefix

origin enum Mechanism using which the IPv6 prefix was assigned ormost recently updated. Enumeration of:

● auto_configured● prefix_delegation● ra● well_known● static● child

static_type enum Static prefix sub-type. For a Static prefix, this can be set toPrefixDelegation or Child, thereby creating an unconfiguredprefix of the specified type that will be populated withpreference to creating a new instance. This allows thecontroller to pre-create the "prefix slots" with known pathnames that can be referred to from elsewhere in the datamodel before they are populated. Enumeration of:

● static● inapplicable● prefix_delegation● child

parent_prefix uuid The value is a reference in the table:IPv6_Prefix. If thereferenced object is deleted, the parameter value MUST beset to an empty string. Indicates the parent prefix fromwhich this prefix was derived. The parent prefix is relevantonly for Child prefixes and for Static Child prefixes (both of

76/102

which will always be on downstream interfaces), i.e. forOrigin=Child and for (Origin,StaticType) = (Static,Child)prefixes.

child_prefix_bits string A prefix that specifies the length of Static Child prefixesand how they are derived from their ParentPrefix. It will beused if, and only if, it is not an empty string and is longerthan the parent prefix (if it is not used, derivation of suchprefixes is implementation-specific). Any bits to the right ofthe parent prefix are set to the bits in this prefix.

For example, for a parent prefix of fedc::/56, if thisparameter had the value 123:4567:89ab:cdef::/64, the child/64 would be fedc:0:0:ef::/64. For a parent prefix offedc::/60, the child /64 would be fedc:0:0:f::/64.

on_link boolean On-link flag [Section 4.6.2/RFC4861] as received (in theRA) for RouterAdvertisement. Indicates whether this prefixcan be used for on-link determination.

autonomous boolean Autonomous address configuration flag [Section4.6.2/RFC4861] as received (in the RA) forRouterAdvertisement. Indicates whether this prefix can beused for generating global addresses as specified bySLAAC [RFC4862].

preferred_lifetime string This parameter is based onipAddressPrefixAdvPreferredLifetime from [RFC4293]. Thetime at which this prefix will cease to be preferred (i.e. willbecome deprecated), or empty if not known. For an infinitelifetime, the parameter value MUST be infinite.

valid_lifetime string This parameter is based onipAddressPrefixAdvValidLifetime from [RFC4293]. The timeat which this prefix will cease to be valid (i.e. will becomeinvalid), or empty if not known. For an infinite lifetime, theparameter value MUST be infinite.

77/102

DHCPv4_Client (not used)This table enables DHCPv4 client configuration and status reporting.


enable boolean Enable or disable the DHCPv4 Client

ip_interface uuid Reference to the table:IP_interface

request_options[0..32] set ofintegers

DHCPv4 options requested by the client

received_options[0..32] set ofuuids

Reference to table:DHCP_Option. DHCPv4 options arereceived from the server.

send_options[0..32] set ofuuids

Reference to table:DHCP_Option. DHCPv4 options sent tothe server.


78/102

DHCPv6_ClientThis table enables DHCPv6 client configuration and status reporting.


enable boolean Enable or disable the DHCPv6 Client

ip_interface uuid Reference to the table:IP_interface

request_address boolean Enables or disables inclusion of the Identity Association forNon-Temporary Address.

request_prefixes boolean Enables or disables inclusion of the Identity Association forPrefix Delegation.

rapid_commit boolean Enables or disables inclusion of the Rapid Commit.

renew boolean When set to true, the Client renews its DHCPv6-suppliedinformation.

request_options set ofintegers

DHCPv6 options requested by the client

received_options set ofuuids

Reference to table:DHCP_Option. DHCPv4 optionsreceived from the server.

send_options set ofuuids

Reference to table:DHCP_Option. DHCPv4 options sent tothe server.

79/102

DHCP_OptionThis table stores various DHCP options related to DHCPv4 and DHCPv6 configuration, andstatus reporting. IPv6 and IPv4 DHCP configuration tables refer to the rows in this table.


enable bool True if this option is active, or false if ignored

version enum(v4, v6)

DHCP version for this option, used only to help read thetable. It should be consistent with what is configured in thetable:DHCPv4_Client or table:DHCPv6_Client.Enumeration of:

● v4● v6

type enum(rx, tx)

Type of the DHCP option, used only to help read the table.It should be consistent with what is configured in thetable:DHCPv4_Client or table:DHCPv6_Client.Enumeration of:

● rx● tx

tag integer Option tag (code)

value string The DHCP Client option value. Base64-encoded. Themaximum size of a 255-byte binary string encoded tobase64 is 340.

80/102

NetfilterThe Netfilter table defines firewall (iptables) rules. Each row in the table maps to a single iptables rule.This table is managed by the Netfilter Manager (NFM).


enable boolean True whether the rule is enabled.

status enum Rule status, populated by NFM:● "disabled" - Rule is disabled.● "enabled" - Rule is enabled and was successfully

configured.● "error" - Rule is enabled, but there was an error

while applying the rule configuration to the system.

protocol string Rule protocol family:● "ipv4"● "ipv6"

table enum Iptables table. This translates to the -t parameter of theiptables command.

● "filter",● "nat",● "mangle",● "raw",● "security

chain string Iptables chain name.● "minLength": 1,● "maxLength": 64

priority integer Rule priority. Rules with lower priority will be applied first.Note: This affects the rule number, but it is a 1:1 mappingto the rule numbers.

rule string Rule specification. The rule specification can referencetags in the Openflow_Tag table to create dynamicallyexpanding rules.

● "minLength": 0,● "maxLength": 512

target string The iptables target name. This roughly translates to theparameter of the -j command line switch.

● "minLength": 1,● "maxLength": 64

81/102

Netfilter_IpsetIpset is a companion application for the iptables Linux firewall. Ipset allows you to create rules tomanage sets of IP addresses. The Netfilter_Ipset table stores various ipset options.


name string This value directly correlates with the name given to theipset command. The name must be unique.

type enum The ipset command type:["bitmap:ip", "bitmap:ip,mac", "bitmap:port","hash:ip","hash:mac", "hash:ip,mac", "hash"net","hash:net,net", "hash:ip,port","hash:net,port", "hash:ip,port,ip", "hash:ip,port,net","hash:ip,mark", "hash:net,port,net", "hash:net,iface","list:set", "local"]

options string Ipset creation options. These are the options that areissued on top of the ipset command when creating anipset.

values key Ipset entries. Max number of strings: 64.

origin string Rule origin.

status string Ipset command status:● success: active● error: error when configuring● unset: not processed yet

Note: The status value is ephemeral and updated by theNet Filter Manager (NFM).

82/102

DHCPv4_Server (not used)Used for DHCPv4 server configuration and status reporting.


interface uuid Reference to table:IP_Interface. Parent interface


Indicates the status of this entry. Enumeration of:- disabled (origin: cloud)- enabled (origin: cloud)- error (origin: device)

min_address string Specifies the first IPv4 address in the pool to be assignedby the DHCP server on the interface.

max_address string Specifies the last IPv4 address in the pool to be assignedby the DHCP server on the interface.

lease_time integer Lease time in seconds. -1 indicates infinite.

options[0..256] set ofuuids

Reference to table:DHCP_Option. DHCP options offered toclients.

static_address[0..64] set ofuuids

Reference to table:DHCPv4_Lease. List of staticallyassigned IP addresses.

leased_address[0..256] set ofuuids

Reference to table:DHCPv4_Lease. List of leased IPaddresses.


83/102

DHCPv4_Lease (not used)Used for configuration and reporting of DHCPv4 leases. The DHCPv4_Server table refers tothis table.


status enum(leased,static,error)

Indicates the status of this entry. Enumeration of:leased - This is a lease, reported by manager (origin:device)static - Static lease entry (origin: cloud)error - Error applying static entry (origin: device)

address string IPv4 Address of lease/static entry

hwaddr string Hardware address (MAC) of lease/static entry

hostname string Hostname

leased_time integer Lease time. Only applicable if status==leased.

leased_fingerprint string DHCP fingerprint. Only applicable if status==leased.


84/102

DHCPv6_ServerThis table enables DHCPv6 server configuration and status reporting.


interface uuid Reference to IP_Interface


Indicate the status of this entry. Enumeration of:- disabled (origin: cloud)- enabled (origin: cloud)- error (origin: device)

prefixes set ofuuids

Reference to table:IPv6_Prefix. List of prefixes that theDHCPv6 server will be offering (stateful DHCP).

prefix_delegation boolean If “True”, this Server row is used for prefix delegation

options set ofuuids

Reference to table:DHCP_Option. DHCP options offered toclients.

lease_prefix set ofuuids

Reference to table:DHCPv6_Lease. List of leased IPprefixes.

static_prefix set ofuuids

Reference to table:DHCPv6_Lease. List of staticallyassigned IP prefixes/addresses.

85/102

DHCPv6_LeaseUsed for configuration and reporting of DHCPv6 leases. The DHCPv6_Server table refers to thistable.


status enum(leased,static,error)

Indicates the status of this entry.leased - This is a lease, reported by the manager (origin:device)static - Static lease entry (origin: cloud)error - Error applying static entry (origin: device)

prefix string IPv6 address of prefix (/XX notation)

duid string Client unique identifier (DUID) (2 bytes header + 128 bytesmax data in hex notation without separators)

hwaddr string Hardware address (MAC) of lease/static entry in hexnotation

hostname string Assigned/Requested hostname

leased_time integer Leased time

86/102

IPv6_RouteAdvThis table enables IPv6 Router Advertisement configuration and status reporting.


interface set ofuuids

Reference to table:IP_Interface. Parent interface.


Router advertisement status:disabled - disable this entry (origin: cloud)enabled - enable Router Advertisement on interface(origin: cloud)error - error configuring Router Advertisement (origin:device)

prefixes set ofuuids

Reference to the table:IPv6_Prefix. Prefixes advertisedthrough RA.

managed boolean Managed address configuration -- the (M) flag

other_config boolean Other configuration -- the (O) flag

home_agent boolean Home Agent flag -- the (H) flag

max_adv_interval integer Maximum time allowed between sending unsolicitedmulticast Router Advertisements from the interface; inseconds.

min_adv_interval integer Minimum time allowed between sending unsolicitedmulticast Router Advertisements from the interface; inseconds.

The value must be greater than 3/4 * max_adv_interval.

default_lifetime integer Router lifetime. 0 indicates that the router should not beused as the default router.

preferred_router enum(low,medium,high)

reference associated with the default router, as either "low","medium", or "high".

mtu integer The MTU option is used in router advertisement messagesto ensure that all nodes on a link use the same MTU valuein those cases where the link MTU is not a well- knownvalue.

reachable_time integer The time, in milliseconds, that a node assumes a neighboris reachable after having received a reachabilityconfirmation. Used by the Neighbor Unreachability

87/102

Detection algorithm (see Section 7.3 of RFC 4861). Avalue of zero means unspecified (by this router).

retrans_timer integer The time, in milliseconds, between retransmitted NeighborSolicitation messages. Used by address resolution and theNeighbor Unreachability Detection algorithm (see Sections7.2 and 7.3 of RFC 4861). A value of zero meansunspecified (by this router).

current_hop_limit integer The default value that should be placed in the Hop Countfield of the IP header for outgoing (unicast) IP packets.The value should be set to the current diameter of theInternet. The value zero means unspecified (by this router).

rdnss set ofuuids

Reference to the table:IPv6_Address. Recursive DNSservers advertised via RA.

dnssl set ofstrings

List of DNS search domains that will be advertised via RA

88/102

IPv6_NeighborsThis table enables IPv6 neighbor reporting. This is a tentative list of neighbors that areparticipating in an IPv6-enabled network.


address string Client device IPv6 address

hwaddr string Client device MAC address


Example:

root@caesar:~# ovsh -T s IPv6_Neighbors -w if_name==br-home.tndp

+-----------+-----------+----------------------------------------+-------------------+--------------+

| _uuid | _version | address | hwaddr | if_name |

+-----------+-----------+----------------------------------------+-------------------+--------------+

| 3626~9727 | fd69~fc9b | fe80::cd1:6a3f:29a1:35f9 | 00:05:1B:D1:A5:7B | br-home.tndp |

| 9961~6ce5 | e5fa~7cd4 | fe80::225:90ff:fe87:175d | 00:25:90:87:17:5D | br-home.tndp |

| 9895~3737 | 81dc~d033 | 2601:647:4900:1f63:115a:5cc2:f08f:7d68 | 26:16:29:D8:CF:99 | br-home.tndp |

| e754~0b49 | 5b84~decb | 2601:647:4900:1f63:cd32:d093:dd9e:dda1 | 26:16:29:D8:CF:99 | br-home.tndp |

+-----------+-----------+----------------------------------------+-------------------+--------------+

IPv4_NeighborsARP protocol provides IPv4-to-MAC mappings to the devices. This table stores the ARPmappings exchange. Collecting the ARP messages exchanged on the LAN enhances theOpenSync IPv4-to-MAC mapping performance.


address string Client device IPv4 address

hwaddr string Client device MAC address

if_name string Incoming interface of the ARP packet which triggered theentry.

source string Source of ARP mapping - either FSM or the system ARPtable.

89/102

IGMP_ConfigThis table sets various IGMP parameters in the system.


igmp_version string Default IGMP version selection. Available options:● "IGMPv1"● "IGMPv2"● "IGMPv3"

snooping_enabled boolean Enable or disable snooping behavior on thespecified bridge.

snooping_bridge string Bridge on which snooping should be used.

static_mrouter_port string Specifies the port to which IGMP reports should besent.

mcast_group_exceptions string Multicast groups that should bypass snoopingbehavior. A comma-separated string of CIDR IPaddresses.

unknown_mcast_group_behavior string Default forwarding behavior for multicast groups thatare not stored in the snooping table.

query_robustness_value integer Controls the IGMP query robustness variable. Whenthe system receives an IGMP leave message on ashared network running IGMPv2, the query routermust send an IGMP group query message for aspecified number of times. The number of IGMPgroup query messages sent is determined by therobust count.

maximum_groups integer Maximum number of groups that can be learned bythe system.

fast_leave_enable boolean If True, the option instructs to immediately drop thestream when an IGMP leave message is received.

proxy_enabled boolean Enables or disables IGMP Proxy behavior.

proxy_upstream_if string The interface on which IGMP reports are proxied,and where multicast stream is expected.

proxy_dowstream_if string The interface on which Proxy is listening for IGMPreports.

proxy_group_exceptions string This option instructs not to proxy the specifiedmulticast groups.

90/102

proxy_allowed_subnets string Proxy only multicast groups for the specified sourceIP subnet.

querier_enabled boolean Enables or disables the IGMP Querier.

query_interval integer Interval duration between queries.

query_response_interval integer The interval to wait for a response after sending outa query.

last_member_query_interval integer The interval defines the maximum response timeadvertised in IGMP group-specific queries.

maximum_sources integer Maximum number of addresses allowed in thesource filter list for a multicast group.

other_config string Platform-specific options represented as a JSONstring.

Note: This table is available in OpenSync 2.0 and later, and has been expanded in OpenSync 3.2.

Example:ovsh s IGMP_Config

----------------------------------------

_uuid | 3896~0ed6 |

_version | 1ef6~09ff |

fast_leave_enable | false |

last_member_query_interval | 150 |

maximum_groups | 150 |

maximum_members | 10 |

maximum_sources | 30 |

query_interval | 125 |

query_response_interval | 20 |

query_robustness_value | 10 |

---------------------------------------

91/102

MLD_ConfigThis table sets various MLD parameters in the system.


snooping_enabled boolean Enables or disables snooping behavior on the specifiedbridge.

snooping_bridge string The bridge on which snooping should be used.

static_mrouter_port string The port to which the IGMP reports should be sentexplicitly – even if querier is not learned on that port.

mcast_group_exceptions string Multicast groups that should bypass snooping behavior.

unknown_mcast_group_behavior

string Default forwarding behavior for the mcast groups that arenot stored in the snooping table.

proxy_enabled boolean Enables or disables IGMP Proxy behavior.

proxy_upstream_if string Interface on which IGMP reports are proxied, and wheremulticast stream is expected.

proxy_downstream_if string Interface on which Proxy is listening for IGMP reports.

proxy_group_exceptions string This option instructs not to proxy the specified multicastgroups.

proxy_allowed_subnets string This option instructs to only proxy the multicast groups forthe specified source IP subnet.

fast_leave_enable boolean This option instructs to immediately drop the stream whenIGMP leave is received.

last_member_query_interval integer The interval defines the maximum response timeadvertised in the MLD group-specific queries.

maximum_groups integer Maximum number of multicast groups that can be learned.

maximum_members integer Maximum number of members in a group that can besupported.

maximum_sources integer Maximum number of addresses allowed in the source filterlist for a multicast group.

querier_enabled boolean Enables or disables the MLD Querier.

query_interval integer The interval between General Queries sent by the Querier.

query_response_interval integer The interval to wait for a response after sending out a

92/102

query.

query_robustness_value integer Controls the MLD query robustness variable. When thesystem receives an MLD leave message on a sharednetwork running MLDv2, the query router must send anMLD group query message for a specified number of times.The number of MLD group query messages sent isdetermined by the robust count.

other_config string Platform-specific options.


Example:----------------------------------------

_uuid | fd46~7352 |

_version | 1d59~bee9 |

fast_leave_enable | false |

last_member_query_interval | 160 |

maximum_groups | 40 |

maximum_members | 20 |

maximum_sources | 30 |

query_interval | 125 |

query_response_interval | 20 |

query_robustness_value | 4 |

----------------------------------------

93/102

Node_ServicesThis table lists all OpenSync services (managers) that are available on the device, theirconfiguration and current status. Services can be dynamically started or stopped by modifyingthe enable column of this table.


service string The name of the service name (executable name)

enable bool “True” if the service is enabled

status enum One of:● enabled: If the service has been started● disabled: If the service has been stopped● error: If there was an error during starting/stopping

of the service

other_config map Additional service configuration. This is the current list ofvalues as interpreted by the DM:

● needs_plan_b (boolean): Must be stopped (“True”)whether a service crash requires restart ofOpenSync

● restart_delay (integer): Restart delay in seconds● always_restart (boolean): If true, services should

always be restarted even if they are killed by thesignals that usually do not trigger a restart.


Example:

+-----------+-----------+--------+------------------------------------------------------------+---------+---------+

| _uuid | _version | enable | other_config | service | status |

+-----------+-----------+--------+------------------------------------------------------------+---------+---------+

| 7b84~a134 | e9f0~b11a | true | ["map",[["needs_plan_b","true"]]] | blem | enabled |

| 5afe~e959 | 3952~a6b8 | true | ["map",[]] | bm | enabled |

| 80d5~cec1 | 204e~399e | true | ["map",[["needs_plan_b","true"]]] | cm | enabled |

| 24fb~7096 | 0db9~988e | true | ["map",[]] | csc_man | enabled |

| 3582~7096 | e4a1~e3c3 | true | ["map",[["always_restart","true"],["restart_delay","-1"]]] | fcm | enabled |

| e35d~45ac | 8537~e9b2 | true | ["map",[["needs_plan_b","true"]]] | fm | enabled |

| 432c~9d74 | 4bc4~f874 | true | ["map",[["always_restart","true"],["restart_delay","-1"]]] | fsm | enabled |

| e178~f0fc | 7bd4~3fa5 | true | ["map",[["needs_plan_b","true"]]] | nm | enabled |

| d617~4bb9 | bf2b~2e44 | true | ["map",[["needs_plan_b","true"]]] | om | enabled |

| a4b5~5096 | be53~296c | true | ["map",[]] | pm | enabled |

| b391~47b0 | 88ad~88a8 | true | ["map",[]] | ppm | enabled |

| de54~48da | 9b1e~e683 | true | ["map",[]] | qm | enabled |

| 4fbe~ba7e | 8c23~f270 | true | ["map",[]] | sm | enabled |

| 4921~c04f | 834a~aab3 | true | ["map",[["needs_plan_b","true"]]] | um | enabled |

| 3f51~74e2 | d955~f38a | true | ["map",[["needs_plan_b","true"]]] | wm | enabled |

+-----------+-----------+--------+------------------------------------------------------------+---------+---------

94/102

OMS_ConfigNormally, the device firmware upgrades require upgrading the entire firmware image. However, it is alsopossible to upgrade only specific firmware modules. Examples of such upgrades are signatures for thirdparty components, or adding new modules or managers. OMS_Config is the table that the receivingmodules are monitoring for the object updates. This table lists the available versions for a given objectname. In case of multiple versions for the same object name, it is up to the receiving module to decidewhich one to use.


object_name string Name of the object to be upgraded

version string Version of the object (set by the Cloud)

other_config string

Object_Store_ConfigThe Object_Store_Config table enables the Cloud-to-device communication when upgrading only specificfirmware modules.


dl_url string Download url:● Set by the Cloud when a new object is available● Cleared by device when download is done (even if download

fails)

dl_timeout integer Download timeout:● Set by the Cloud for download timeout● Cleared by device when download is done (even if download

fails)

name string Name of the object:● Set by the Cloud when a new download is triggered● Set by the device at boot (from the already installed objects)

version string Version of the object:● Set by the Cloud when a new download is triggered● Set by device at boot (from already installed objects)

95/102

Object_Store_StateThis table enables the device-to-Cloud communication when upgrading only specific firmware modules.


fw_integrated boolean Object pre integrated in the firmware image:● True if the object is pre integrated in the image - it is installed by

default.● False if the object is installed from the Cloud

(Object_Store_Config table).

The pre- integrated objects can not be removed.

status enum Status of object:● always set only by the device● enum:

○ ACTIVE○ ERROR○ DOWNLOAD_STARTED○ DOWNLOAD_COMPLETED○ DOWNALOD_ERROR○ INSTAL_FAILED○ INSTAL_COMPLETED○ VER_MISMATCH

name string Name of the object:● Set by the device

version string Version of object:● Set by the device at boot

Captive_PortalThis table configures Captive Portal authentication parameters on the devices.


name string This column is the name of the Captive_Portal config tableentry.

proxy_method string This column is for configuring the proxy either in “reverse”or “forward” proxy method.

uam_url string URL of the NAS server that will be accessed using thedevice and location id

additional_headers string Map of key-value pairs for any tinyproxy config

96/102

other_config string

Interface_QoSThis table defines the QoS schema.


queues set of uuids Reference table to Interface_Queue.

other_config map ofstrings

Key/value pairs representing auxiliary and/or QoSimplementation specific configuration.

status enum QoS status as reported by the device:● “success”● “error”● “ephemeral”

Interface_QueueName Type Description

priority integer The queue priority (lower value indicates higher priority).

bandwidth integer The queue maximum bandwidth expressed in Kbit/s.

tag string Name of the entry that will be populated in theOpenflow_Tag table:

● The `tag` entry will be populated with the firewallmark value.

● The `tag_class` entry will be populated with thequeue class value.

This can be used to create dynamic Netfilter rules thatexpand according to the `tag` value.

other_config map ofstrings

Key/value pairs representing auxiliary and/or Queueimplementation specific configuration

mark integer The firewall (iptables) mark that shall be used to categorizepackets for this queue.

97/102

Reboot_StatusThis table enables reporting of device reboot/boot reason. Entries in this table are automatically populatedby the device upon system startup. Table rows are persistent until deleted.


count int This column indicates the reboot sequence number. Eachtime the system boots, this counter increases by 1.

reason string Optional: Information provided in addition to the type. Thisstring may include, for example, a snippet from the kernelstack trace upon crash, reason why the health-check failed,etc.

type enum This field indicates the reboot type and is an enum of:● UNKNOWN - Unable to determine reboot reason● COLD_BOOT - First boot after device power on● POWER_CYCLE - Device was power cycled● WATCHDOG - Reboot due to watchdog timeout● CRASH - Reboot due to system crash● USER - Reboot issued by user (reboot command)● DEVICE - Firmware initiated reboot● HEALTH_CHECK - Reboot due to health check

failure● UPGRADE - Reboot due to system upgrade● THERMAL - Reboot due to critical thermal event● CLOUD - Cloud-initiated reboot (for example,

reboot from NOC)


Example:

│+-----------+-----------+-------+--------------------------+-------------+│ _uuid | _version | count | reason | type |│+-----------+-----------+-------+--------------------------+-------------+│ a66d~d8f5 | 0277~bbc7 | 23 | delayed-reboot | CLOUD |

│ 1455~5c54 | 1189~6df6 | 74 | | COLD_BOOT |

│ 8a66~c0aa | 118c~1c84 | 69 | | COLD_BOOT |

│ 9fe1~4367 | 11c3~ae43 | 61 | delayed-reboot | CLOUD |

│ dbdf~9a35 | 1a79~2b54 | 40 | delayed-reboot | CLOUD |

┤ 0676~345e | 21d5~831f | 43 | delayed-reboot | CLOUD |

│ 3ac8~f9c2 | 26fe~d218 | 32 | delayed-reboot | CLOUD |

│ ef64~976b | 2e36~3c13 | 24 | delayed-reboot | CLOUD |

│ 3ece~6f2a | 348d~6a46 | 50 | delayed-reboot | CLOUD |

│ 37cd~5fba | 374f~3e3c | 84 | (unknown) | POWER_CYCLE |

│ 0569~53c5 | 3887~3617 | 67 | delayed-reboot | CLOUD |

│ dac1~7cfb | 3bf6~cd03 | 54 | delayed-reboot | CLOUD |

│+-----------+-----------+-------+--------------------------+-------------+

98/102

Service_AnnouncementThis table contains service name, metadata, and interval for mDNS service advertising.


name string Name of the service being announced.

protocol string This is the type, i.e http or ftp. For example: _http._tcp or_smb._udp

port integer Port number of the service, for example: 80 or 443.

txt string Text records of the service. This could be any arbitrary textwith the format “type=value”Example: "v1","https://bd.plume.com/api/v1/"


Example:

------------------------------------------------------------

_uuid | aa8d~f70f |

_version | 1d4c~787e |

name | bw.plume |

port | 3000 |

protocol | _smb._udp |

txt | ["map",[["v1","https://bd.plume.com/api/v1/"]]] |

------------------------------------------------------------

WAN_ConfigWith the introduction of persistent OVSDB rows (OpenSync 3.2), the WAN settings were moved frompersistent storage to OVSDB. The WAN_Config table includes the new WAN settings.


enable boolean True if the configuration in this row is active.

type enum WAN configuration type. Available options:● dhcp● "pppoe"● "vlan"● "static_ipv4"

99/102

priority integer WANO always uses the row with the highest priority(according to its type). If multiple entries exist, the entrieswith lower priorities are ignored. The value can be atimestamp.

other_config map of strings WAN type-specific configuration. The field depends on the"type" parameter. The supported parameters are defined inthe table other_config supported parameters below.

os_persist boolean True if the row is set as persistent data.1

status enum Enum of "success" or "error". Unset if WAN provisioningwith the current settings is still in progress or is not beingused. Value "success" if WANO was able to use thesettings in this row to establish a WAN connection. Value"error" if provisioning was unsuccessful.

other_config supported parameters

Type Setting Description

pppoe username PPPoE username

pppoe password PPPoE password

vlan vlan_id The VLAN ID

static_ipv4 gateway The default IPv4 gateway

static_ipv4 ip The static IP address of the device

static_ipv4 subnet The static IP subnet of the device

static_ipv4 primary_dns The primary DNS IP address

static_ipv4 secondary_dns(optional)

The secondary DNS IP address

1 The os_persist boolean column is a generic column that can be defined in any OVSDB table.When detecting a change in the OVSDB data, and if the os_persist column value is set to true,Persistent Storage Manager (PSM) serializes the data and adds the data to persistent storage.

100/102

TELOG_ConfigThis table enables configuration of the time-event logging system. The time-event loggingsystem generates and transports the time-event reports from target to the specified MQTT topicdestination.


mqtt_topic string MQTT topic for the transmitted reports. Reports won’t begenerated when this field is cleared.

mqtt_qos integer MQTT QoS for the transmitted reports. The recommendedvalue is 1 (deliver at least once).

report_interval integer Time-event reports generation interval in the 1–3600 srange. Recommended value: 60 sec.

log_severity string Controls local time-event logs verbosity in the syslog.Optional field to be used for development only.

Passpoint_ConfigThe Passpoint_Config table stores the Hotspot 2.0 network parameters.


enabled boolean Enables or disables Homespot 2.0.

hessid string The Homogenous ESSID (HESSID) is an MAC addressfield that is the same for all APs belonging to the samenetwork.

list_3gpp list of strings List of 3GPP Cellular Network ANQP-elements. Containsthe cellular network identity based on public land mobilenetwork (PLMN) information.

roaming_consortium list of strings The Roaming Consortium ANQP-element and beaconelements provide a list of identifiers of roaming consortiumsand SPs that are roaming partners of the Passpoint hotspotservice provider and that are accessible from the PasspointAP. OI values assigned by the IEEE1 identify the roamingconsortium (i.e., a group of SPs with an inter-SP roamingagreements) or a single SP.

domain_name string Domain name of the entity operating the hotspot network.

nairealm_list list of strings A list of NAI realms corresponding to the Home SPs thatcan authenticate a mobile device with username/passwordor certificate credentials.

101/102

adv_wan_status boolean Advertise WAN link status.

adv_wan_symmetric boolean Advertise WAN link symmetry (whether link speed is thesame in the uplink and downlink).

adv_wan_at_capacity boolean In this condition the AP won't allow additional mobiledevices to associate.

102/102

OpenSync 3.4 Northbound API

Documents

Transcript of OpenSync 3.4 Northbound API