WebPA (Xmidt) Reference Setup

Unknown User (gprasad)

Would you be able to provide an example on how to set a parameter on the RDK device. For example, if we need to change the SSID.

Thanks,

Simer

@Ganesh Sahu

Could you please provide an example to set/get attributes for tr069 webpa client.

Thanks and Regards,

Haseena

Hi Unknown User (gprasad)

what is the connection between webpa and xconf server, Any documentation is there to check.

I have raspberry pi 3 B+ I am able to install RDK-B image on it.

I am not able to find parodus logs in it.

Can anyone please let me know where I can find the logs.

I am trying to setup a connection between rasp pi and my Web server. 

Hi Unknown User (gprasad)

Is there any feature in xconf server to update webpa cluster url in device ?

Hi  Unknown User (gprasad)

Can you share the steps to setup themis as key server for authorization to scytale.

Is there a way to configure url having "https://" instead of "http://"  in fanout configuration in scytale. 

We are looking at webpa to support management of RDK based devices...Very very new to webpa and trying to understand how this fits in. Few questions:

• If I understand, applications will be consuming data from device via tr1d1um component of Xmidt/WebPA which is a cloud hosted infrastructure, right?
• WebPA server cluster is cloud hosted by any specific vendor or can that be deployed as as part of an onprem management application serving only that application? Technically it should be possible, but question is, is that the way it is conceived?
• How an application can onboard/discover a webpa managed devices? How does application know which devices are connected to webpa server? Should that be separate provided to application through a separate workflow outside the scope of WebPA?
• Other than using http(s) to get/set parameters on devices via WebPA server, is it possible to receive data/notification from device periodically? Mainly for bulk data collection with say 5-10 minutes interval. Is it possible to share some sample code for bulk data collection or subscribing to for bulk data reporting?
• Is there a client (manage application side) library available to talk to tr1d1um or we can use plain HTTP libraries?
• Is the WebSocket interface of "Parodus" standard and published? Can that be directly used by applications? Is that a recommended way to leverage it?

Hi Unknown User (gprasad),

I was trying to use the below webpa api which was there in swagger : https://swagger.webpa.comcast.net/#!/webpa/addRow

POST /device/{device_id}/config/{table}

My post request url is : http://35.158.129.120:6100/api/v2/device/mac:112233445566/config/10003?names=Device.WiFi.SSID.10001.SSID

Body :

[{"name":"Device.WiFi.SSID.10001.SSID","row": "rowAb2","value":"Test_RS_PI_123_WIFI2"}]

I get the below response:

{
"message": "row property is invalid"
}

Could you please help on  this as to what needs to be changed.

Does anyone know the port number of tr1d1um and SCYTALE???

Hello,

My client seems able to regist to server. But, when I try to retrive Device.DeviceInfo.Manufacturer, I always got is 400 bad request.

log from tr1d1um.log shows connection refused when sending request to webhooks.

Misconfiguration in tr1d1um? 

--

{"bindAddress":":9003","level":"debug","listenAddress":"[::]:9003","listenNetwork":"tcp","msg":"accepted connection","remoteAddress":"10.10.103.1:52940","serverName":"tr1d1um","ts":"2021-04-27T09:24:14.971965795Z"}
{"caller":"constructor.go:138","key":"Basic","level":"debug","method":"GET","msg":"authentication added to context","requestHeaders":{"Accept":["*/*"],"Authorization":["Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg=="],"User-Agent":["curl/7.29.0"]},"requestURL":"/api/v2/device/mac:ccd42e154be4/config","span-id":"c3d6629fdcca8af4","token":{},"trace-id":"82fd498865cbd0fbf81c88b871da1c11","ts":"2021-04-27T09:24:14.972286202Z"}
{"caller":"enforcer.go:91","level":"debug","method":"GET","msg":"authentication accepted by enforcer","requestHeaders":{"Accept":["*/*"],"Authorization":["Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg=="],"User-Agent":["curl/7.29.0"]},"requestURL":"/api/v2/device/mac:ccd42e154be4/config","span-id":"c3d6629fdcca8af4","trace-id":"82fd498865cbd0fbf81c88b871da1c11","ts":"2021-04-27T09:24:14.972363022Z"}
{"caller":"utils.go:81","duration":"1.808891ms","level":"info","msg":"record","request":{"address":"10.10.103.1:52940","path":"/api/v2/device/mac:ccd42e154be4/config","query":"names=Device.DeviceInfo.ModelName","method":"GET"},"response":{"code":400,"headers":{"X-Midt-Span-Id":["c3d6629fdcca8af4"],"X-Midt-Trace-Id":["82fd498865cbd0fbf81c88b871da1c11"],"X-Scytale-Build":["0.1.4"],"X-Scytale-Flavor":["mint"],"X-Scytale-Region":["east"],"X-Scytale-Server":["10.10.103.1"],"X-Scytale-Start-Time":["27 Apr 21 09:23 UTC"],"X-Tr1d1um-Build":["0.1.3-434"],"X-Tr1d1um-Flavor":["mint"],"X-Tr1d1um-Region":["east"],"X-Tr1d1um-Server":["10.10.103.1"],"X-Tr1d1um-Start-Time":["27 Apr 21 09:23 UTC"],"X-Webpa-Transaction-Id":["zQF6htK7dm-V7o9C1lsQrA"]}},"satClientID":"user123","span-id":"c3d6629fdcca8af4","tid":"zQF6htK7dm-V7o9C1lsQrA","trace-id":"82fd498865cbd0fbf81c88b871da1c11","ts":"2021-04-27T09:24:14.974310118Z"}
{"error":"http client failed while sending request: Get \"http://127.0.0.1:6600/api/v1/store/webhooks\": dial tcp 127.0.0.1:6600: connect: connection refused","level":"error","msg":"Failed to get items for listeners","ts":"2021-04-27T09:24:18.042488333Z"}

--

curl -H 'Authorization:Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg==' -i 'http://10.10.103.1:9003/api/v2/device/mac:ccd42e154be4/config?names=Device.DeviceInfo.Manufacturer'
HTTP/1.1 400 Bad Request
X-Midt-Span-Id: 3aa9c76583fcf436
X-Midt-Trace-Id: e7a6d8bbad3cf5d2792d1682f6ae5502
X-Scytale-Build: 0.1.4
X-Scytale-Flavor: mint
X-Scytale-Region: east
X-Scytale-Server: localhost
X-Scytale-Start-Time: 27 Apr 21 08:45 UTC
X-Tr1d1um-Build: 0.1.3-434
X-Tr1d1um-Flavor: mint
X-Tr1d1um-Region: east
X-Tr1d1um-Server: localhost
X-Tr1d1um-Start-Time: 27 Apr 21 08:45 UTC
X-Webpa-Transaction-Id: CrCRX8Wa1nFizYhe5jFqmA
Date: Tue, 27 Apr 2021 09:09:38 GMT
Content-Length: 0

curl -H 'Authorization:Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg==' -i 'http://10.10.103.1:8080/api/v2/devices'

HTTP/1.1 200 OK
Content-Type: application/jsonebe4", "pending": 0, "statistics": {"bytesSent": 0, "messagesSent": 0, "bytesReceived": 558, "messagesReceived": 1, "duplications": 0, "connectedAt": "2021-04-27T08:49:34.361204263Z", "upTime": "16m5.356395748s"}}]}

Hello, 

I'm trying to run parodus with mtls feature. the certifacates were ready.  Also configured certificateFile and keyFile in talaria.yaml.

But, I got one error message from talaria.log

{"caller":"webpa.go:244","error":"open : no such file or directory","level":"error","msg":"Error in reading ClientCACertFile ","ts":"2021-06-08T07:25:43.53186511Z"}

Seems the log is output from webpa-common.

anyone know how to config the path of ClientCACertFile?

Hi Unknown User (gprasad) 

Is there any package which supports front end webui for this webpa server?

Regards,

Mohana

Some of the information in this document is very out of date.  For example, Xmidt migrated from Zookeeper to Consul, and the build system migrated to Go modules instead of using Glide for dependency management.  There are also resources to support Docker Compose in the public repository.

For the latest, see https://xmidt.io/docs/operating/getting_started/.

Hi Team,

Please suggest me where can I find webPA component REST API document..?

Thanks & Regards,

Krishna.

Hello Team,

I am getting following error:

ts=2021-09-09T04:44:33.887602706Z level=error msg="All HTTP transaction retries failed" url=http://192.168.1.17:6300/api/v3/notify error="dial tcp 192.168.1.17:6300: connect: connection refused" retries=1
ts=2021-09-09T04:44:33.887673518Z caller=workerPool.go:81 level=error msg="HTTP transaction error" error="Post http://192.168.1.17:6300/api/v3/notify: dial tcp 192.168.1.17:6300: connect: connection refused"

My all three services (talaria,  scytale, tr1d1um) are running on same ip 192.168.1.17

Can anyone pls hel resolve the above errors, pls.

Hi team how to test the WebPA client and server?
And how to add parameter in xml file? And how to test? Give some examples.

can some on please explain about below parameters, these parameters are used in "TEST_AND_SET" operaiton.

But i do not know how to  use them exactly adn what these fileds signify

Regards

Krishna

Question about the RDK-B parodus parameter webpa-ping-time. Is this a different parameter to the webpa-ping-timeout parameter, if so what is the difference between the two.

Unknown User (gprasad) 

Do you have any documents to introduce the REST API of WebPA, especially for tr1d1um?

Is there any REST API to support to reboot or upgrade the software of CPE?

Thank you!

I am attempting to set a keep alive ping time of 29 minutes. I have set 

pingPeriod: "1740s"
idlePeriod: "1800s"

In the talaria.yaml file. And on the device I have set --webpa-ping-time=1800 in parodus_start.sh. 
However I no longer connect to the device and cannot make requests.
Can anyone guide me to where I am going wrong or if I am missing any steps?

Hi Unknown User (gprasad) ,

     I'm try to install the WebPA by following your step.  Thank you for the detail description.

     Where is the shell script 'build_rpm.sh' from? I can't find this file.

4. Create the package
    $ mkdir $HOME/rpmbuild
    $ ./build_rpm.sh --no-sign
   Thank you!

Hello Unknown User (vxiong) 

you can use xmidt-org/xmidt for reference.

Hi  Unknown User (gprasad) ,

     At last when we run "$ sudo systemctl enable talaria", we find the service 'talaria‘ fails to start up as below:

• [root@localhost talaria]# systemctl enable talaria
  Created symlink from /etc/systemd/system/multi-user.target.wants/talaria.service to /usr/lib/systemd/system/talaria.service.
  [root@localhost talaria]#
  [root@localhost talaria]#
  [root@localhost talaria]# systemctl status talaria
  ● talaria.service - The Xmidt API interface server.
     Loaded: loaded (/usr/lib/systemd/system/talaria.service; enabled; vendor preset: disabled)
     Active: failed (Result: start-limit) since Fri 2022-10-28 05:10:14 EDT; 8min ago
  Main PID: 2416 (code=exited, status=1/FAILURE)
• Oct 28 05:10:14 localhost.localdomain systemd[1]: talaria.service: main process exited, code=exited, status=1/FAILURE
  Oct 28 05:10:14 localhost.localdomain systemd[1]: Unit talaria.service entered failed state.
  Oct 28 05:10:14 localhost.localdomain systemd[1]: talaria.service failed.
  Oct 28 05:10:14 localhost.localdomain systemd[1]: talaria.service holdoff time over, scheduling restart.
  Oct 28 05:10:14 localhost.localdomain systemd[1]: Stopped The Xmidt API interface server..
  Oct 28 05:10:14 localhost.localdomain systemd[1]: start request repeated too quickly for talaria.service
  Oct 28 05:10:14 localhost.localdomain systemd[1]: Failed to start The Xmidt API interface server..
  Oct 28 05:10:14 localhost.localdomain systemd[1]: Unit talaria.service entered failed state.
  Oct 28 05:10:14 localhost.localdomain systemd[1]: talaria.service failed.
  [root@localhost talaria]#

     Why does the service 'talaria' fail to boot up?

     Hope get your suggestion, thank you!

Regards

Venty

Unknown User (gprasad) when I GET any node bu "curl", it always returns HTTP 403 error as below. can you help to check why it happens?

root@home:~# curl -H 'Authorization: Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg==' -i http://10.120.14.169:9003/api/v2/device/mac:5cfa2535cdc0/config?names=Device.DeviceInfo.ModelName
HTTP/1.1 403 Forbidden
X-Scytale-Build: 0.1.4-1
X-Scytale-Flavor: mint
X-Scytale-Region: east
X-Scytale-Server: 10.120.14.169
X-Scytale-Start-Time: 31 Oct 22 01:42 UTC
X-Talaria-Build: 0.1.3-1
X-Talaria-Flavor: mint
X-Talaria-Region: east
X-Talaria-Server: 10.120.14.169
X-Talaria-Start-Time: 31 Oct 22 01:42 UTC
X-Tr1d1um-Build: 0.1.2-1
X-Tr1d1um-Flavor: mint
X-Tr1d1um-Region: east
X-Tr1d1um-Server: 10.120.14.169
X-Tr1d1um-Start-Time: 31 Oct 22 01:42 UTC
X-Webpa-Transaction-Id: oXE-JR3Of1S188UeAR5rIg
X-Xmidt-Span: "http://localhost:8080/api/v2/device/send","2022-11-11T08:01:52Z","683.002µs"
Date: Fri, 11 Nov 2022 08:01:52 GMT
Content-Length: 42
Content-Type: text/plain; charset=utf-8

{"code": 403, "message": "request denied"}root@home:~# 
root@home:~# 
root@home:~# 
root@home:~# 

root@home:/var/log# 
root@home:/var/log# curl -H 'Authorization:Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg==' -i 'http://10.120.14.169:8080/api/v2/devices'
HTTP/1.1 403 Forbidden
Content-Type: application/json
X-Talaria-Build: 0.1.3-1
X-Talaria-Flavor: mint
X-Talaria-Region: east
X-Talaria-Server: 10.120.14.169
X-Talaria-Start-Time: 31 Oct 22 01:42 UTC
Date: Fri, 11 Nov 2022 08:25:13 GMT
Content-Length: 42

{"code": 403, "message": "request denied"}root@home:/var/log# 
root@home:/var/log# 
root@home:/var/log# 

########cat talaria.log:

2022-11-11T08:09:36.820399381Z level=error msg="All HTTP transaction retries failed" url=http://127.0.0.1:6300/api/v3/notify error="dial tcp 127.0.0.1:6300: connect: connection refused" retries=1
ts=2022-11-11T08:09:36.820445436Z caller=workerPool.go:81 level=error msg="HTTP transaction error" error="Post http://127.0.0.1:6300/api/v3/notify: dial tcp 127.0.0.1:6300: connect: connection refused"
ts=2022-11-11T08:09:36.969463178Z serverName=talaria bindAddress=:8080 listenNetwork=tcp listenAddress=[::]:8080 level=debug msg="accepted connection" remoteAddress=10.161.2.30:60032
ts=2022-11-11T08:09:36.969888357Z caller=manager.go:140 level=debug msg="device connect" url=/api/v2/device
ts=2022-11-11T08:09:36.970101582Z caller=manager.go:178 level=info id=mac:5cfa2535cdc0 convey="unsupported value type"
ts=2022-11-11T08:09:36.970144254Z caller=manager.go:184 level=error id=mac:5cfa2535cdc0 msg="missing security information"
ts=2022-11-11T08:09:36.970500962Z caller=manager.go:193 level=debug id=mac:5cfa2535cdc0 msg="websocket upgrade complete" localAddress=10.120.14.169:8080
ts=2022-11-11T08:09:36.970743643Z caller=handlers.go:222 level=debug msg="Connected device" id=mac:5cfa2535cdc0
ts=2022-11-11T08:09:36.970817347Z caller=manager.go:353 level=debug id=mac:5cfa2535cdc0 msg="writePump starting"
ts=2022-11-11T08:09:36.971164255Z caller=manager.go:275 level=debug id=mac:5cfa2535cdc0 msg="readPump starting"
ts=2022-11-11T08:09:36.971264664Z level=error msg="All HTTP transaction retries failed" url=http://127.0.0.1:6300/api/v3/notify error="dial tcp 127.0.0.1:6300: connect: connection refused" retries=1
ts=2022-11-11T08:09:36.971308819Z caller=workerPool.go:81 level=error msg="HTTP transaction error" error="Post http://127.0.0.1:6300/api/v3/notify: dial tcp 127.0.0.1:6300: connect: connection refused"
ts=2022-11-11T08:23:54.215333498Z serverName=talaria bindAddress=:8080 listenNetwork=tcp listenAddress=[::]:8080 level=debug msg="accepted connection" remoteAddress=10.161.2.30:60034
ts=2022-11-11T08:23:54.215748476Z caller=authorizationHandler.go:127 level=error msg="request denied" validator-response=false validator-error=null sat-client-id= token="Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg==" method=GET url=/api/v2/devices user-agent=curl/7.69.1 content-length=0 remoteAddress=10.161.2.30:60034

#############cat tr1d1um.log:

{"caller":"utils.go:58","latency":"10.712224ms","level":"info","msg":"Bookkeeping response","requestAddress":"10.161.2.30:33208","requestMethod":"GET","requestURLPath":"/api/v2/device/mac:5cfa2535cdc0/config","requestURLQuery":"names=Device.DeviceInfo.ModelName","responseCode":403,"responseHeaders":{"X-Scytale-Build":["0.1.4-1"],"X-Scytale-Flavor":["mint"],"X-Scytale-Region":["east"],"X-Scytale-Server":["10.120.14.169"],"X-Scytale-Start-Time":["31 Oct 22 01:42 UTC"],"X-Talaria-Build":["0.1.3-1"],"X-Talaria-Flavor":["mint"],"X-Talaria-Region":["east"],"X-Talaria-Server":["10.120.14.169"],"X-Talaria-Start-Time":["31 Oct 22 01:42 UTC"],"X-Tr1d1um-Build":["0.1.2-1"],"X-Tr1d1um-Flavor":["mint"],"X-Tr1d1um-Region":["east"],"X-Tr1d1um-Server":["10.120.14.169"],"X-Tr1d1um-Start-Time":["31 Oct 22 01:42 UTC"],"X-Webpa-Transaction-Id":["oXE-JR3Of1S188UeAR5rIg"],"X-Xmidt-Span":["\"http://localhost:8080/api/v2/device/send\",\"2022-11-11T08:01:52Z\",\"683.002µs\""]},"satClientID":"user123","tid":"oXE-JR3Of1S188UeAR5rIg","ts":"2022-11-11T08:01:52.590123469Z"}
{"bindAddress":":9003","level":"debug","listenAddress":"[::]:9003","listenNetwork":"tcp","msg":"accepted connection","remoteAddress":"10.161.2.30:33224","serverName":"tr1d1um","ts":"2022-11-11T08:29:56.294386243Z"}
{"caller":"constructor.go:79","key":"Basic","level":"debug","method":"GET","msg":"authentication added to context","requestHeaders":{"Accept":["*/*"],"Authorization":["Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg=="],"User-Agent":["curl/7.69.1"]},"requestURL":"/api/v2/device/mac:5cfa2535cdc0/config","token":{},"ts":"2022-11-11T08:29:56.294683788Z"}
{"caller":"enforcer.go:73","level":"debug","method":"GET","msg":"authentication accepted by enforcer","requestHeaders":{"Accept":["*/*"],"Authorization":["Basic dXNlcjEyMzp3ZWJwYUAxMjM0NTY3ODkwCg=="],"User-Agent":["curl/7.69.1"]},"requestURL":"/api/v2/device/mac:5cfa2535cdc0/config","ts":"2022-11-11T08:29:56.294741183Z"}
{"caller":"utils.go:58","latency":"8.858663ms","level":"info","msg":"Bookkeeping response","requestAddress":"10.161.2.30:33224","requestMethod":"GET","requestURLPath":"/api/v2/device/mac:5cfa2535cdc0/config","requestURLQuery":"names=Device.DeviceInfo.ModelName","responseCode":403,"responseHeaders":{"X-Scytale-Build":["0.1.4-1"],"X-Scytale-Flavor":["mint"],"X-Scytale-Region":["east"],"X-Scytale-Server":["10.120.14.169"],"X-Scytale-Start-Time":["31 Oct 22 01:42 UTC"],"X-Talaria-Build":["0.1.3-1"],"X-Talaria-Flavor":["mint"],"X-Talaria-Region":["east"],"X-Talaria-Server":["10.120.14.169"],"X-Talaria-Start-Time":["31 Oct 22 01:42 UTC"],"X-Tr1d1um-Build":["0.1.2-1"],"X-Tr1d1um-Flavor":["mint"],"X-Tr1d1um-Region":["east"],"X-Tr1d1um-Server":["10.120.14.169"],"X-Tr1d1um-Start-Time":["31 Oct 22 01:42 UTC"],"X-Webpa-Transaction-Id":["EYTsASFc9QoobNtI85-mww"],"X-Xmidt-Span":["\"http://localhost:8080/api/v2/device/send\",\"2022-11-11T08:29:56Z\",\"4.403597ms\""]},"satClientID":"user123","tid":"EYTsASFc9QoobNtI85-mww","ts":"2022-11-11T08:29:56.303645531Z"}
[root@localhost tr1d1um]# 

Hi Ganesh Sahu,

When I use curl to send request to tr1d1um to get parameter of my connected device, the talaria drops the message and says "unsupported event".  Could you please help me on this?

this is my command :

curl -H 'Authorization:Basic d2VicGFAMTIzNDU2Nzg5MA==' -i http://10.8.6.166:6100/api/v2/device/mac:80787112dd5c/config?names=Device.DeviceInfo.ModelName

and through the logs of tr1d1um and scytale I see the message successfully transfered to talaria. But talaria dropped the message:

#######################################################################################################################################################

"key”:"debug”,"ts":"2025-05-13T10:04:30+08:00","message":"accepted connection","serverName":"talaria","bindAddress":":6200","litwork":"tcp,listenAddress":"[::]:6200","remoteAddress":"10.8.6.167:60440"}
Key:"debug","ts":"2025-05-13T10:04:30+08:00","caller":"/root/go/pkg/mod/github.com/xmidt-org/bascule@v0.11.6/basculehttp/enfo
cer.go:88","message":"authentication accepted by enforcer","requestHeaders”:["Accept-Encoding":["gzip"],"Authorization-Type”:["
Basic"],"Content-Length":["183"],"Content-Type":["application/msgpack"],"User-Agent":["Go-http-client/1.1"],"X-Webpa-Device-Name
"mac:80787112dd5c/config"]),"requestURL":"/api/v3/device/send","method":"PosT","requestuRI":"/api/v3/device/send","remoteAddr
:"10.8.6.167:60440","ts":"2025-05-13T02:04:30Z"}
["key":"debug","ts":"2025-05-13T10:04:30+08:00","message":"Dropped message,event not sent","scheme":"unknown","code":"message_d
ropped","reason":"unsupported event","error":"unsupported event"}
["key":"debug","ts":"2025-05-13T10:04:30+08:0o","message":"Dropped message,event not sent","scheme":"unknown","code":"message_d
ropped","reason":”unsupported event","error":"unsupported event"}

Thanks,

Brian