obuspa

section | description | multi | name | options | required
obuspa | OBUSPA daemon Configuration | false | global |
name | type | required | default | description
enabled | boolean | no | true | Enables USP agent daemon
dhcp_discovery | boolean | no | true | Enables controller discovery via DHCP over the interface specified in interface option
trust_cert | file | no |  | USP agent trust control certificate
client_cert | file | no |  | USP agent mtp client certificate
interface | string | yes | wan | Interface name network block, configures USP_BOARD_IFNAME. option interface has higher precedence than ifname
debug | boolean | no | false | Enables debug logs in obuspa and proto trace
log_level | uinteger | no | 1 | Configures the log level verbosity, higher number meaning more logs. This option only applied if debug is enabled
prototrace | boolean | no | false | Enables logging of protocol traces in human readable format, This option only applied if debug is enabled
log_dest | file | no | syslog | debug log destination
db_file | file | no |  | Database file name with absolute path
dm_caching_exclude | file | no |  | Json file path, containing list of multi instance object for which instances wont be cached in obuspa. Json schema for the defined file is as '{"dmcaching_exclude":["Device.Hosts.Host."]}'
max_cache_time | integer | no | 25 | This value is used to measure the maximum caching time at runtime.
ipc_timeout | integer | no | 30 | Configure max ipc timeout in seconds for ubus calls to lower layers
dualstack_pref | string | no | IPv6 | Configures the IP version preference in dual stack mode. Possible values are IPv4 and IPv6.
localagent | Configure USP agent endpoint and boot-params | false |  |
name | type | required | default | description
EndpointID | string | no | OS::OUI-SERIAL | Override default USP endpoint
controller | OBUSPA controller configuration | true |  |
name | type | required | default | description
EndpointID | string | yes |  | USP controller endpoint id
Enable | boolean | no | true | Configure controller enable parameter
SessionMode | string | no | Allow | Configures Device.LocalAgent.Controller.{i}.E2ESession.SessionMode for the controller
AssignedRole | string | no |  | Defines the assigned role for the controller. ex: Device.LocalAgent.ControllerTrust.Role.1
assigned_role_name | string | no |  | Easy alternative to assign value in AssignedRole paramter, values in this parameter has to be a role name as present in Device.LocalAgent.ControllerTrust.Role.*.Name, in case of miss-match assigned role defaults to Untrusted role.
Protocol | string | yes |  | Connection protocol for MTP connection, valid values(STOMP, MQTT, CoAP, WebSocket)
Reference | string | yes |  | Refer to configured MTP method instance in case of STOMP and MQTT
Destination | string | no | controller-notify-dest | Configures stomp destination
Topic | string | no |  | Configures controller Topic for MQTT connection
mqtt | string | no |  | Points to a named mqtt uci section for mqtt reference, option Reference has higher precedence than this option.
stomp | string | no |  | Points to a named stomp uci section for stomp reference, option Reference has higher precedence than this option
Host | host | no |  | Required if protocol is websocket, see Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket.Host for more details
Port | port | no |  | Required if protocol is websocket, see Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket.Port for more details
Path | string | no |  | See Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket.Path for more details
EnableEncryption | bool | no | 1 | See Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket.EnableEncryption for more details
ParameterName | list(string) | no | Device.DeviceInfo.SoftwareVersion | Configures controller boot parameter name
subscription | Adds subscriptions in USP agent, for valid value refer to Device.LocalAgent.Subscription.{i}. Object of TR181 | true |  |
name | type | required | default | description
Enable | boolean | no | true | Enables the subscription
NotifType | string | no |  | Configure the notiftype for subscription, refer to Device.LocalAgent.Subscription.{i}.NotifType parameter in TR181 for valid values
ReferenceList | list(string) | no |  | Reference list of datamodel objects
Recipient | boolean | no |  | Reference to Controller instance
controller | string | no |  | Reference to controller named uci section for Recipient option, Recipient option has higher precedence.
| no
mtp | MTP connection Settings, refer to Device.LocalAgent.MTP. Object in TR-181 for valid values | true |  |
name | type | required | default | description
Enable | boolean | no | true | enables controller
Protocol | string | yes |  | Connection protocol to use valid values(STOMP, MQTT, CoAP, WebSocket)
Destination | string | no |  | MTP queue destination
Reference | string | no |  | Reference to MQTT client or STOMP instance
ResponseTopicConfigured | string | no |  | Agent MQTT response topic
mqtt | string | no |  | Reference to named mqtt uci section for Reference, option Reference has higher precedence
stomp | string | no |  | Reference to named stomp uci section for Reference, option Reference has higher precedence
Path | string | no |  | Refer TR181 Device.LocalAgent.MTP.{i}.WebSocket.Path
Port | port | no |  | Refer TR181 Device.LocalAgent.MTP.{i}.WebSocket.Port
EnableEncryption | bool | no | 1 | Refer TR181 Device.LocalAgent.MTP.{i}.WebSocket.EnableEncryption
stomp | Stomp connection Settings, refer to Device.STOMP.Connection. Object in TR-181 for valid values | true |  |
name | type | required | default | description
Host | string | yes | usp-controller.com | Stomp host name
Username | string | yes | username | Username for stomp mtp connection
Password | string | yes | password | Password for stomp mtp connection
Enable | boolean | no | true | Configures stomp Enable parameter
Port | uinteger | yes | 61613 | port number of mtp connection
VirtualHost | string | yes | / | virtual host to use for connection
EnableHeartbeats | boolean | yes | true | connection heartbeat
EnableEncryption | boolean | yes | true | When true, encryption MUST be used for this STOMP Connection
| no
mqtt | MQTT connection Settings, refer to Device.MQTT.Client. Object in TR-181 for valid values | true |  |
name | type | required | default | description
BrokerAddress | host | yes |  | MQTT broker address
BrokerPort | port | yes | 1883 | Broker port for mqtt connection
Enable | boolean | yes | true | Enables mqtt connection
Username | string | yes |  | Username for mqtt connection
Password | string | yes |  | Password for mqtt connection
ProtocolVersion | string | yes | 5.0 | MQTT protocol version or("3.1", "3.1.1","5.0")
ClientID | string | yes |  | MQTT client id
TransportProtocol | string | yes | TCP/IP | Valid values (TCP/IP, TLS)
| no
challenge | To define factory default challenges to be used by ControllerTrust, as described in TR181 for Device.LocalAgent.ControllerTrust.Challenge.{i}. | true |  |
name | type | required | default | description
Enable | boolean | no |  | Parameter to enable this challenge instance
Description | string | no |  | Parameter to provide meaningful description for this challenge entry, e.g Request Admin access
role_name | string | yes |  | Easy alternative method to assign a role instance when challenge succeeded, role_name value will internally mapped to Device.LocalAgent.ControllerTrust.Role. table
Role | string | yes |  | Either Role or role_name is required, if both defined Role gets the priority. Instance of Device.LocalAgent.ControllerTrust.Role. table which get assigned when this challenge succeeds
Value | string | yes |  | The value of the challenge that is specific to the type of challenge.
Retries | uinteger | no | 3 | The number of times a challenge is retried before the challenge procedure is terminated.
LockoutPeriod | uinteger | no | 0 | The time, in seconds that a Controller that has failed the challenge is locked out (based on the value of the Retries parameter) prior to being provided the challenge again.
| no