tr369_websocket_uri

Web User Interface

N/A

Phone User Interface

N/A

Initial Firmware Version

10.1.182.0

XML Configuration

<tr369_websocket_uri idx="INDEX" perm="PERMISSIONFLAG">VALIDVALUE</tr369_websocket_uri>

Description

It sets the WebSocket URI to reach the corresponding USP Controller. This setting is used to filled the content of the Device.LocalAgent.Controller.{i}.MTP.1.WebSocket. parameter table properly.

For security purpose, the listening socket related to the Device.LocalAgent.MTP.{i}.WebSocket. parameter table is not enabled.

The syntax is the following: <scheme>://<host>:<port>/<path>

Syntax elementsValid valuesDescriptionReference links

<scheme>

(optional)

  • "ws"
  • "wss"

Related to WebSocket.EnableEncryption parameter.

When not provided, but the port is 443, encryption is enabled. Otherwise, it is disabled.

Device:2 WebSocket.EnableEncryption

<host>

(mandatory)

  • IP address (10.0.0.3)
  • FQDN (some.host.domain)

Related to WebSocket.Host parameter.

IP address or FQDN to be resolved by the USP Agent

Device:2 WebSocket.Host

<port>

(optional)

  • 80
  • 443
  • any numeric value from 1 to 65535

Related to WebSocket.Port parameter.

Must be set to the listening port configured on the server.

When not provided, but the scheme is, the default port of the given scheme is used (e.g. 80 for "ws" and 443 for "wss"). Otherwise, it is 80.

Device:2 WebSocket.Port

<path>

(optional)

  • text string starting with "/"

Related to WebSocket.Path parameter.

The path in order to exchange USP messages with the WebSocket server.

The {mac} keyword can be used when the uppercase MAC address is wanted.

Device:2 WebSocket.Path

RFC 6455 Section 3 (WebSocker URIs)

RFC 3986 Section 3.3 (URI Generic Syntax)

While the <host> element is mandatory, the others are optional and will be substituted accordingly to RFC 6455 Section 3 (WebSocket URIs).

This setting ignores the query component (starting with "?"). Accordingly to the USP specification, the USP Agent is required to be configured only with the path component and will send a key-pair value with its Device.LocalAgent.EndpointID.

Note: the index=1 is reserved for SRAPS while index=2 is available to a custom controller.

Refer to TR-369 - Full Endpoint Management for more details.

Valid Values

Any URI valid according to both RFC 6455 Section 3 (WebSocket URIs) and RFC 3986 Section 3 (URI Generic Syntax). 

Examples:

Default Value

empty