This article lists the commands for configuring, checking and troubleshooting the WebRTC gateway. It also describes some of the features available with these commands.
Overview
You must first log on to the WebRTC gateway virtual machine from a management console.
From the prompt, commands must be entered using following syntax:
mp<feature name> <options>
Example:
To activate the SSH feature on WebRTC gateway, enter: mpssh on.
To help you:
- mphelp lists all the commands and their options.
- show extension displays the current configuration of a command (e.g. mpconfig show).
Command list
The following table lists the commands available for WebRTC gateway configuration.
| Command | Options | Meaning | See: |
| mpcheck | To verify that WebRTC gateway is running and connected to Rainbow Cloud | WebRTC Gateway Dashboard | |
| mpcleanreg | all | To clean up the SIP registrar on WebRTC gateway (i.e. all Rainbow applications are restarted, meaning all communications are cleared) | |
| mpcollect | log|mtr|sar|all | To collect information on WebRTC gateway | WebRTC Gateway Troubleshooting Guide |
| mpconfig |
PBX_DOMAIN| PBXID |
To connect a PBX to WebRTC gateway | WebRTC Gateway Troubleshooting Guide |
| mpjcodec | pcm|g722|opus|all | To manage codecs on WebRTC gateway | Configuring OPUS codec |
| mplog | debug|verbose | To change the logging level before reproducing an issue and collecting logs | WebRTC Gateway Troubleshooting Guide |
| mpndump | on|off|clean | To make SIP traces | WebRTC Gateway Troubleshooting Guide |
| mpnetwork |
IP|NETMASK| GATEWAY|DNS| PROXY|NTP| HOSTNAME |
To configure the WebRTC gateway network settings | WebRTC Gateway Installation Guide |
| mpqos | on|off | To enable/disable Quality of Service (QoS) on WebRTC gateway | Configuring Quality of Service (QoS) |
|
mpreboot mphalt |
To reboot or stop the WebRTC gateway virtual machine | ||
| mpshow | To view the WebRTC gateway current configuration | WebRTC Gateway Dashboard | |
| mpsnmp |
on|off mode check |
To enable/disable:configure SNMP on WebRTC gateway | WebRTC gateway manage SNMP |
| mpssh | on|off | To enable/disable SSH on WebRTC gateway | |
| mpstatus | To check the status of WebRTC gateway services | WebRTC Gateway Dashboard | |
|
mpstart mpstop mprestart |
To start, stop or restart the WebRTC gateway | ||
| mpsystem | To check the WebRTC gateway status | WebRTC Gateway Dashboard | |
| mptrace |
duration in hours |
Increase the log level to verbose during a given time (0 to 120 hours) without application restart | E.g. mptrace 2 will increase log level to verbose during 2 hours |
| mpupgrade | now|delay|yes|abort | To upgrade the WebRTC gateway | WebRTC Gateway Upgrade Guide |
Configuring Quality of Service (QoS)
As of WebRTC gateway version 3.1, the command mpqos on|off allows to enable or disable QoS on WebRTC gateway.
Once enabled on WebRTC gateway (i.e. mpqos on), you must also manage QoS for Rainbow clients.
In Microsoft Windows environment, you can manage QoS for web and desktop Rainbow clients using local or domain group policies.
QoS policy configuration consists in:
- Setting the DSCP value (46)
- Selecting the applications to which the policy must apply
-
Specifying the source and destination IP addresses
Notes:
- If the destination IP address is not accepted, manage it with network /32.
- If traffic is controlled by a proxy, the destination must be the proxy IP address.
- Selecting the protocol (UDP) and port numbers (from any source and destination ports)
After configuration, you can verify that DSCP has been changed, for example, using Wireshark. DSCP value must be set to 46 as below.
Example:
Configuring OPUS codec
As of WebRTC gateway version 3.1.1, the command mpjcodec opus < value of dynamic payload type> allows to:
- Enable OPUS on WebRTC gateway
- Set the dynamic payload type value for OPUS in SDP offers (the default value is 111)
Example:
To enable OPUS with a dynamic payload type value of 100, enter: mpjcodec opus 100.
You can check the OPUS configuration (status and payload type value) with mpshow command.