Page History

...

Environment Setup

• Set-up Considerations

<Briefly describe and graphically depict as appropriate the equipment, communications, and network configuration of the system in a way that a non-technical user can understand>

• User Access Considerations

<Briefly describe and graphically depict as appropriate the equipment, communications, and network configuration of the system in a way that a non-technical user can understand>

• Accessing the System

<Provide detailed information and describe the procedures necessary to access the system. If applicable, include how to get a user ID and log on to the system, as well as the actions a user must take to change and/or reset a password.>

• System Work Flow

<Describe how system flow is happening mentioning checkpoints which can be verified during flow to ensure system is working as expected>

• Exiting the System

...

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:

Image Added

...

Executing System

Describe the specific system function or feature in detail and depict graphically by including screen prints and descriptive narrative as appropriate. Ensure each screen print is captioned and has an associated tag providing appropriate alternative text

...

Troubleshooting

• Error Messages

...