mirror of https://dev.iopsys.eu/bbf/bbfdm.git synced 2025-12-10 07:44:39 +01:00

Amin Ben Romdhane 09882ba799 Update documentation

2025-03-18 12:56:15 +01:00

28 KiB

Raw Blame History

bbf Schema

https://dev.iopsys.eu/bbf/bbfdm/-/blob/devel/docs/api/ubus/bbfdm.md

Custom Properties	Additional Properties
Forbidden	Forbidden

bbf

List of Methods
add
del
get
instances
operate
schema
services
set

add

Add a new object instance

Add a new object in multi instance object

add

type: Method

add Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Required

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`obj_path`	object	Optional
`path`	string	Required

obj_path

obj_path

is optional
type: object

obj_path Type

object with following properties:

Property	Type	Required
None	None	None

path

Complete object element path as per TR181

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.

Device.WiFi.

Ubus CLI Example

ubus call bbf add {"path":"pariatur","obj_path":{}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "bbf", "add", { "path": "pariatur", "obj_path": {} }]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "data": {
          "type": "string"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        }
      },
      "required": ["path"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{
  "results": [
    {
      "path": "enim ut voluptate eu ",
      "data": "Ut in exercitation officia Excepteur",
      "fault": 7966,
      "fault_msg": "Ut"
    }
  ]
}

del

Delete object instance

Delete a object instance from multi instance object

del

type: Method

del Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Required

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`path`	string	Required
`paths`	array	Optional

path

Complete object element path as per TR181

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.

Device.WiFi.

paths

paths

is optional
type: array

paths Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "uniqueItems": true,
  "items": [
    {
      "$ref": "#/definitions/query_path_t"
    }
  ],
  "simpletype": "`array`"
}

Ubus CLI Example

ubus call bbf del {"path":"qui nisi id","paths":["adipis"]}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "bbf", "del", { "path": "qui nisi id", "paths": ["adipis"] }]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "data": {
          "type": "string"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        }
      },
      "required": ["parameter", "type"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{ "results": [{ "path": "sint elit", "data": "cupidatat do sit ", "fault": 8574, "fault_msg": "dolore et Duis" }] }

get

Get handler

Query the datamodel object

get

type: Method

get Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Required

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`optional`	object	Optional
`path`	string	Required

optional

optional

is optional
type: object

optional Type

object with following properties:

Property	Type	Required	Default
`format`	string	Optional	`"pretty"`
`proto`	string	Optional	`"both"`

format

format

is optional
type: reference
default: "pretty"

format Type

string

The value of this property must be equal to one of the known values below.

format Known Values

Value
raw
pretty

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

path

DM object path with search queries

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.BSSID

Device.WiFi.SSID.*.BSSID

Device.WiFi.

Ubus CLI Example

ubus call bbf get {"path":"magna consequat ut","optional":{"format":"pretty","proto":"both"}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": [
    "<SID>",
    "bbf",
    "get",
    { "path": "magna consequat ut", "optional": { "format": "pretty", "proto": "both" } }
  ]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "data": {
          "type": "string"
        },
        "type": {
          "$ref": "#/definitions/type_t"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        }
      },
      "required": ["path"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{
  "results": [
    {
      "path": "id sunt Duis",
      "data": "id",
      "type": "xsd:command",
      "fault": 8916,
      "fault_msg": "dolor amet irure sed nulla"
    }
  ]
}

instances

Instance query handler

Get the instances of multi object

instances

type: Method

instances Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Optional

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`optional`	object	Optional
`path`	string	Required

optional

optional

is optional
type: object

optional Type

object with following properties:

Property	Type	Required	Default
`proto`	string	Optional	`"both"`

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

path

DM object path with search queries

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.BSSID

Device.WiFi.SSID.*.BSSID

Device.WiFi.

Ubus CLI Example

ubus call bbf instances {"path":"dolore n","optional":{"proto":"usp"}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "bbf", "instances", { "path": "dolore n", "optional": { "proto": "usp" } }]
}

output

output

is optional
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        }
      },
      "required": ["path"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{ "results": [{ "path": "veniam amet", "fault": 7810, "fault_msg": "quis" }] }

operate

Operate handler

Operate on object element provided in path

operate

type: Method

operate Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Required

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`command_key`	string	Optional
`input`	object	Optional
`optional`	object	Optional
`path`	string	Required

command_key

command_key

is optional
type: string

command_key Type

string

input

Input arguments for the operate command as defined in TR-181-2.13

input

is optional
type: object

input Type

object with following properties:

Property	Type	Required
None	None	None

input Example

{ "path": "Device.IP.Diagnostics.IPPing()", "input": { "Host": "iopsys.eu" } }

optional

optional

is optional
type: object

optional Type

object with following properties:

Property	Type	Required	Default
`proto`	string	Optional	`"both"`

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

path

Datamodel object schema path

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.IP.Diagnostics.IPPing()

Device.DHCPv4.Client.{i}.Renew()

Device.FactoryReset()

Ubus CLI Example

ubus call bbf operate {"path":"velit nostrud ullamco","command_key":"ullamco officia nulla pariatur","input":{},"optional":{"proto":"both"}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": [
    "<SID>",
    "bbf",
    "operate",
    {
      "path": "velit nostrud ullamco",
      "command_key": "ullamco officia nulla pariatur",
      "input": {},
      "optional": { "proto": "both" }
    }
  ]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "data": {
          "$ref": "#/definitions/boolean_t"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "output": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "path": {
                  "$ref": "#/definitions/path_t"
                },
                "data": {
                  "$ref": "#/definitions/boolean_t"
                },
                "type": {
                  "$ref": "#/definitions/type_t"
                }
              }
            }
          ]
        }
      },
      "required": ["path", "data"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{
  "results": [
    {
      "path": "sitveniam pa",
      "data": "0",
      "fault": 8302,
      "fault_msg": "eiusmod laborum",
      "output": [{ "path": "dolore pariatur qui", "data": "0", "type": "xsd:dateTime" }]
    }
  ]
}

schema

Get list of supported datamodel parameters

Schema will have all the nodes/objects supported by libbbf

schema

type: Method

schema Type

object with following properties:

Property	Type	Required
`input`	object	Optional
`output`	object	Required

input

input

is optional
type: object

input Type

object with following properties:

Property	Type	Required
`first_level`	boolean	Optional
`optional`	object	Optional
`path`	string	Optional

first_level

gets only first level objects if true

first_level

is optional
type: boolean

first_level Type

boolean

optional

optional

is optional
type: object

optional Type

object with following properties:

Property	Type	Required	Default
`proto`	string	Optional	`"both"`

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

path

DM object path with search queries

path

is optional
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.BSSID

Device.WiFi.SSID.*.BSSID

Device.WiFi.

Ubus CLI Example

ubus call bbf schema {"path":"idnisi Lorem","first_level":true,"optional":{"proto":"both"}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": [
    "<SID>",
    "bbf",
    "schema",
    { "path": "idnisi Lorem", "first_level": true, "optional": { "proto": "both" } }
  ]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/schema_path_t"
        },
        "data": {
          "$ref": "#/definitions/boolean_t"
        },
        "type": {
          "$ref": "#/definitions/type_t"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "input": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "path": {
                  "$ref": "#/definitions/schema_path_t"
                },
                "data": {
                  "$ref": "#/definitions/boolean_t"
                },
                "type": {
                  "$ref": "#/definitions/type_t"
                }
              }
            }
          ]
        },
        "output": {
          "type": "array",
          "items": [
            {
              "type": "object",
              "properties": {
                "path": {
                  "$ref": "#/definitions/schema_path_t"
                },
                "data": {
                  "$ref": "#/definitions/boolean_t"
                },
                "type": {
                  "$ref": "#/definitions/type_t"
                }
              }
            }
          ]
        }
      },
      "required": ["path"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{
  "results": [
    {
      "path": "deserunt sed",
      "data": "0",
      "type": "xsd:event",
      "fault": 7839,
      "fault_msg": "velit sed",
      "input": [{ "path": "ullamco magna aliquip", "data": "0", "type": "xsd:dateTime" }],
      "output": [{ "path": "aliqua", "data": "0", "type": "xsd:long" }]
    }
  ]
}

services

show the list of micro-service registred in the Data Model

services

type: Method

services Type

object with following properties:

Property	Type	Required
`intput`		Optional
`output`	object	Required

intput

intput

is optional
type: complex

intput Type

Unknown type ``.

{
  "simpletype": "complex"
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required	Default
`name`	string	Optional
`objects`	object	Optional
`proto`	string	Optional	`"both"`
`unified_daemon`	boolean	Optional

name

name

is optional
type: string

name Type

string

objects

objects

is optional
type: object

objects Type

object with following properties:

Property	Type	Required	Default
`object`	string	Optional
`parent_dm`	string	Optional
`proto`	string	Optional	`"both"`

object

object

is optional
type: string

object Type

string

parent_dm

parent_dm

is optional
type: string

parent_dm Type

string

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

proto

proto

is optional
type: reference
default: "both"

proto Type

string

The value of this property must be equal to one of the known values below.

proto Known Values

Value
usp
cwmp
both

unified_daemon

unified_daemon

is optional
type: boolean

unified_daemon Type

boolean

Output Example

{
  "name": "reprehenderit proident nisi",
  "objects": { "parent_dm": "adipisicing culpa in", "object": "elit", "proto": "both" },
  "proto": "usp",
  "unified_daemon": false
}

set

Set handler

Set values of datamodel object element

set

type: Method

set Type

object with following properties:

Property	Type	Required
`input`	object	Required
`output`	object	Required

input

input

is required
type: object

input Type

object with following properties:

Property	Type	Required
`datatype`	string	Optional
`obj_path`	object	Optional
`path`	string	Required
`value`	string	Required

datatype

datatype of the object element provided in path

datatype

is optional
type: reference

datatype Type

string

The value of this property must be equal to one of the known values below.

datatype Known Values

Value
int
unsignedInt
long
unsignedLong
string
boolean
dateTime
base64
hexBinary

datatype Examples

{ "path": "Device.WiFi.SSID.1.SSID", "value": "test_ssid", "datatype": "string" }

{ "path": "Device.WiFi.SSID.2.Enable", "value": "true", "datatype": "boolean" }

{ "path": "Device.DHCPv4.Relay.Forwarding.1.ClientID", "value": "0103060C", "datatype": "hexBinary" }

{ "path": "Device.DHCPv4.Server.Pool.1.LeaseTime", "value": "120", "datatype": "int" }

{ "path": "Device.DHCPv4.Relay.Forwarding.1.Order", "value": "1", "datatype": "unsignedInt" }

{ "path": "Device.QoS.Queue.1.ShapingRate", "value": "1002", "datatype": "long" }

{ "path": "Device.IP.Diagnostics.UploadDiagnostics.TestFileLength", "value": "1002", "datatype": "unsignedLong" }

{ "path": "Device.USPAgent.ControllerTrust.Challenge.1.Value", "value": "01Z3A6YC", "datatype": "base64" }

{ "path": "Device.ManagementServer.ScheduleReboot", "value": "2024-08-23T23:59:59Z", "datatype": "dateTime" }

obj_path

To set multiple values at once, path should be relative to object elements

obj_path

is optional
type: object

obj_path Type

object with following properties:

Property	Type	Required
None	None	None

obj_path Examples

{ "path": "Device.WiFi.SSID.1.", "obj_path": { "SSID": "test_ssid", "Name": "test_name" } }

{ "path": "Device.WiFi.SSID.2.", "obj_path": { "SSID": "test_ssid" } }

path

DM object path with search queries

path

is required
type: reference

path Type

string

minimum length: 6 characters
maximum length: 1024 characters

path Examples

Device.

Device.DeviceInfo.Manufacturer

Device.WiFi.SSID.1.BSSID

Device.WiFi.SSID.*.BSSID

Device.WiFi.

value

value of the object element provided in path, path should contains valid writable object element

value

is required
type: string

value Type

string

value Examples

{ "path": "Device.WiFi.SSID.1.SSID", "value": "test_ssid" }

{ "path": "Device.WiFi.SSID.2.Enable", "value": "true" }

{ "path": "Device.WiFi.SSID.1.Enable", "value": "0" }

Ubus CLI Example

ubus call bbf set {"path":"consectetur proident Ut consequat tempor","value":"cillum quis sed aliquip","datatype":"boolean","obj_path":{}}

JSONRPC Example

{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": [
    "<SID>",
    "bbf",
    "set",
    {
      "path": "consectetur proident Ut consequat tempor",
      "value": "cillum quis sed aliquip",
      "datatype": "boolean",
      "obj_path": {}
    }
  ]
}

output

output

is required
type: object

output Type

object with following properties:

Property	Type	Required
`results`	array	Optional

results

results

is optional
type: array

results Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": [
    {
      "type": "object",
      "properties": {
        "path": {
          "$ref": "#/definitions/path_t"
        },
        "data": {
          "$ref": "#/definitions/boolean_t"
        },
        "fault": {
          "$ref": "#/definitions/fault_t",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        },
        "fault_msg": {
          "type": "string",
          "Description": "Any discrepancy in input will result in fault. The type of fault can be identified by fault code"
        }
      },
      "required": ["path"]
    }
  ],
  "simpletype": "`array`"
}

Output Example

{ "results": [{ "path": "quis u", "data": "1", "fault": 7028, "fault_msg": "qui pariatur ipsum nisi" }] }

28 KiB Raw Blame History

bbf Schema

bbf

add

Add a new object instance

add Type

input

input Type

obj_path

obj_path Type

path

path Type

path Examples

Ubus CLI Example

JSONRPC Example

output

output Type

results

results Type

Output Example

del

Delete object instance

del Type

input

input Type

path

path Type

path Examples

paths

paths Type

Ubus CLI Example

JSONRPC Example

output

output Type

results

results Type

Output Example

get

Get handler

get Type

input

input Type

optional

optional Type

format

format Type

format Known Values

proto

proto Type

proto Known Values

path

path Type

path Examples

Ubus CLI Example

JSONRPC Example

output

output Type

results

results Type

Output Example

instances

Instance query handler

instances Type

input

input Type

optional

optional Type

proto

proto Type

proto Known Values

path

path Type

path Examples

Ubus CLI Example

JSONRPC Example

output

output Type

results

results Type

Output Example

28 KiB

Raw Blame History