RDK Broadband - WebPA Support in Turris Omnia - User Manual - 2020 - M3

Introduction

Briefly describe in general terms the system/application and the purpose for which it is intended, written in non-technical terminology. Consider including a high-level architecture diagram for the system. The description should include, but is not limited to, the following:

• Key features or major functions/use cases performed by the system/application
• Architecture of the system in non-technical terms (e.g., client server, Web-based, etc.)
• System environment or special conditions

Environment Setup

• Set-up Considerations

On webPA server-side, ensure the following services.

1. Talaria: This service maintains the secure websocket connections from the device and passes the messages from or to the device.

2. Scytale: This accepts the inbound requests and delivers the messages to the Talaria machines that could be hosting the device connection.

3. Tr1d1um: The Webpa micro-service that encode TR-181 requests.

On client-side

4. Parodus: Parodus is the light weight client that reaches out to the xmidt cloud to establish the connection from CPE devices.

Optional:

5. Petasos : Petasos helps reduce the load on the Talaria machines by calculating which specific Talaria a device should connect to & redirecting the incoming request.

6. Caduceus: Caduceus provides the pub-sub message delivery (notification) mechanism for xmidt

• User Access Considerations

1. The mentioned sevices need to be actively running with the basic key authorization.

2. Auth token: The auth token will be used when configuring different webPA components as well while performing GET/SET requests to the CPE from a 3rd party application.

• Accessing the System

Once the Turris-Omnia set-up is active with client services, communication between turris and WebPA server can be established.

• System Work Flow

The following are the major components/services involved in the fetching the data,

• Exiting the System

       The validation artifacts that are essential to ensure the functionality,

  • Authorization Key
  • WebPA Server details(IP, Port number)

  • CPE Device mac address

  • Data Parameters(Specific details that need to be retrieved)

Executing System

The data from the client device can be fetched through the curl commands,

Curl command to retrieve the data(get parameter):

curl -H 'Authorization:Basic dXNlcjp3ZWJwYQo=' -i 'http://192.168.2.75:9003/api/v2/device/mac:d858d700a5d6/config?names=Device.Users.User.3.X_CISCO_COM_Password'

Response message:

{"parameters":[{"name":"Device.Users.User.3.X_CISCO_COM_Password","value":"b1be9cacbfaf0d9d1b633915e8ed0259753057a0a10853a414947d6c27d074c1","dataType":0,"parameterCount":1,"message":"Success"}],"statusCode":200}

Curl command for the set operation:

curl -X PATCH http://192.168.2.75:9003/api/v2/device/mac:d858d700a5d6/config -d '{"parameters": [{"dataType": 0,"name":"Device.Users.User.1.X_CISCO_COM_Password","value":"Testing123"}]}' -H 'Authorization:Basic dXNlcjp3ZWJwYQo='

Respnse message:

{"parameters":[{"name":"Device.Users.User.1.X_CISCO_COM_Password","message":"Success"}],"statusCode":200}

Attaches the screenshot for the reference:

Troubleshooting

• Error Messages

<Identify the error messages that a user may receive and the likely cause(s) and/or possible corrective actions for the error>

• Special Considerations

<If applicable, describe any special circumstances, actions, exceptions, etc., that should be considered for troubleshooting.>

Support