1
prplMesh with rbuscli
Igor Plesser edited this page 2023-10-19 05:57:41 +00:00

[[TOC]]

Usage Northbound API via rbuscli

Read parameters of specific object

Show parameters and their values (whole hierarchy)

rbuscli getvalues {path_to_object}

Example:

rbuscli getvalues Device.WiFi.DataElements.Network.Device.

Show names of parameters (whole hierarchy)

rbuscli getnames {path_to_object} true

Example:

rbuscli getnames Device.WiFi.DataElements.Network.Device. true

Show names of parameters (depth 0)

rbuscli getnames {path_to_object} false

Example:

rbuscli getnames Device.WiFi.DataElements.Network.Device. false

Set value for parameters

rbuscli setvalues {path_to_parameter} <type> <value>

Example:

rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Band2_4G boolean false               

Add/remove an instance of an object

Add instance

rbuscli addrow {path_to_template_object}

Example:

rbuscli addrow Device.WiFi.DataElements.Network.AccessPoint.

Remove instance

rbuscli delrow {path_to_object_instance}

Example:

rbuscli delrow Device.WiFi.DataElements.Network.AccessPoint.1.

Methods calls

Call method without args

rbuscli method_noargs {path_to_method}

Example:

rbuscli method_noargs "Device.WiFi.DataElements.Network.AccessPointCommit()"

Call method with args

rbuscli method_values {path_to_method} <arg_name> <arg_type> <arg_value> ...

Example:

rbuscli method_values "Device.WiFi.DataElements.Network.ClientSteering()" station_mac string "e4:5f:01:27:40:75" target_bssid string "4a:00:09:bd:2f:1f"

Commands for using some features

Raising the access point

rbuscli addrow Device.WiFi.DataElements.Network.AccessPoint.
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.SSID string "prplmesh"
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Band2_4G boolean false
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Band5GL boolean true
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Band5GH boolean true
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Security.ModeEnabled string "WPA2-Personal"
rbuscli setvalues Device.WiFi.DataElements.Network.AccessPoint.1.Security.KeyPassphrase string "prplmesh_pass"
rbuscli method_noargs "Device.WiFi.DataElements.Network.AccessPointCommit()"

Manual client steering

rbuscli method_values "Device.WiFi.DataElements.Network.ClientSteering()" station_mac string "e4:5f:01:27:40:75" target_bssid string "4a:00:09:bd:2f:1f"