Provisioning Custom Settings

In this Admin Guide you can find the list of custom parameters which can help you to change provisioning settings of Wildix devices.

Updated: March 2024

Permalink: https://wildix.atlassian.net/wiki/x/XB3OAQ

When provisioning Wildix devices, you can set custom parameters to change different settings in the provisioning file.

All the changes must be done in the file /rw2/etc/provision.conf (ini syntax - http://en.wikipedia.org/wiki/INI_file).

Access the file via SSH as root using the command:

nano-tiny /rw2/etc/provision.conf


The parameters can be set for a specified device by adding them to one of these sections: 

  • [wildixp] - old WP models
  • [wildixp2] - WP4X0R2, WP4X0R3, START (ex WP410), WelcomeConsole, WorkForce
  • [wildixfxo] - W04FXO
  • [wildixfxo3] - W04FXO 2020 (R3)
  • [wildixfxs2] - FXS 
  • [wildixgw] - Media Gateways
  • [wildixair] - W-AIR 

Otherwise, you can apply the parameters to all the registered devices by adding them to [general] section.

Limitations:

  • You have to add empty section for loading parameters from [general] section. For example, you added parameter HTTPForceUse = yes to [general] section. You have to add empty section [wildixp2] if you want to apply this parameter for WPR2 devices.
  • After the parameters "POWER_LED" and "PowerLEDBlinkTime" are applied to WP2015, devices must be rebooted

List of supported parameters:

ParametersValuesDescription
AuthLockTimeout
=>=0

only for [general] section. The parameter allows setting the desired timeout for storing PIN for Voicemail menu on WP phone (example: AuthLockTimeout=300). By default, the value is 30 seconds. Once the timeout is reached, a user needs to re-enter the PIN code.

Notethe parameter is available starting from WMS 5.03.

BaseMaxSIPReg
=4-30

only for [wildixair] section. Prior to 5.04, the default value is 20 accounts per 1 base. Starting from 5.04, the distribution is as follows:

  • in W-AIR Network with 2 and more bases, the default number is 8 per 1 base
  • in W-AIR Network with 1 base, the default number is 30 accounts

Edit it in case you need to change the number of SIP accounts before distributed load per base station (min. value = 4, max. value = 30).

BLFNotifyType
=ActiveCall|ActiveAndIncomingCall
only for [wildixp2] section. The default value is "ActiveCall". Set "ActiveAndIncomingCall" value to make BLF keys blink when a monitored user has active call+incoming call.
BLFTransType
=attended|blind
only for [wildixp] section. Set BLF transfer type. Supported only by WP480, WP490, WorkForce, WelcomeConsole.
DelayAfterOffhook
=1-255

only for [wildixfxo3] section. The parameter allows controlling the duration of the delay before answering an outbound call on W04FXO r3.

Note: the parameter is available starting from WMS 5.04.

DisableCodecG729
=yes|no 

only for [wildixair] section. Disable g729 codecs ("yes" - disable, "no" - enable). The parameter is applied only to W-AIR Small Business Bases.

Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system.

DisableShowUsername
=yes|no 
only for [wildixp2] section. The parameter is disabled by default (yes - enable, no - disable). Enable it in case you need to show only internal numbers (extensions) (old behavior).
EnableMWISubscribe
=yes|no 
only for [wildixfxs2] section. Enable subscription for MWI (Message Waiting Indicator, shows voicemail LED notifications). The parameter is disabled by default. Supported only by W24FXS 2015.
EnableReasonCause
=yes|no
only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is enabled by default (yes - enable, no - disable). It disables/ enables displaying detailed hangup reasons.
FailoverPbxIp
=<IP address> 
only for [wildixp2] section. Force the switch from Main PBX to Failover PBX (SIP Server 2). Use only IP address.
g711only
=yes|no

only for [wildixair] section. Set only g711 codecs ("yes" - enable, "no" - disable). The parameter is applied only to W-AIR Bases.

Note: Starting from WMS 6.02.20230306.1, the parameter is no longer available and removed from the system.

HIDE_DTMF
=yes|no
hide/ show DTMF dialpad on the phones' displays ("no" - show, "yes" - hide).
HTTPForceUse
=yes|no 
disable/ enable force HTTP protocol instead HTTPS for all requests from the device, like provision, phonebook, features, etc. After the parameter is applied, a device should be re-provisioned (the parameter is not applicable to GSM media gateways of old generation)
LLDP
=yes|no

only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The parameter is disabled by default (yes - enable, no - disable). It allows Wildix devices to advertise information to their directly connected peers when enabled through nano-tiny /rw2/etc/provision.conf.

Note: the parameter is available starting from WMS 5.03.

LLDPInterval
=10-3600

only for [wildixp2] section and only for WP480/ 490 r3, WorkForce, WelcomeConsole. The default interval is 30. It allows setting LLDP interval.

Notethe parameter is available starting from WMS 5.03.

LossPktRateMax 
=0-100
set the parameter to control Packet Loss. "1-99" - Critical Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned.
LossPktRateMin
=0-100
set the parameter to control Packet Loss. "1-99" - Network Problem Threshold, "100" - disable. Supported only by WP4x0, WelcomeConsole. After the parameter is applied, the device should be re-provisioned.
MelodyBLF
=yes|no
only for [wildixp2] section. Supported by Start, WP480/ 490 r3, WorkForce, WelcomeConsole. The parameter is disabled by default ("yes" - enable, "no" - disable). It enables a ringtone to be played instead of a beep for WP BLFs if audio notification is enabled.
OffHookDialOut 
=yes|no
only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is enabled by default ("yes" - enable, "no" - disable). It disables/ enables auto call generation on a handset pickup when pressing “History”, “Phonebook”, “Redial” keys.
POWER_LED
=yes|no 
only for [wildixp2] section. This parameter allows disabling the missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole (this setting is normally applied in Hotels). Enable/ disable WP 2015 Power LED ("no" - disable, "yes" - enable); you can also change the behavior of the power LED by using the parameter PowerLEDBlinkTime (described below).
PowerLEDBlinkTime
=0-14400
only for [wildixp2] section. This parameter allows changing the behavior of missed call LED on WP4X0 2015 phones, WorkForce, WelcomeConsole. Set the time in seconds during which the LED of a missed event (call or voice mail) will blink. Value "0" means blink always, "1" - blink only once. 
RawScan
=enable|disable
only for [general] section. Disable/ enable raw scanning method in case of automatic provision of devices (the parameter is useful for PBXs inside chroot environment).
ResetHandset
=yes|no
only for [wildixair] section. The parameter is disabled by default ("yes" - enable, "no" - disable). Enable it in case you need to delete a Handset IPEI from W-AIR SB and allow to reuse the slot. When it is done, you need to disable it.
RXgain
=-10-10

only for [wildixfxs2] section. The parameter allows modifying the RX gain level on FXS r3 media gateways. The default value is -2 dB.

Note: the support starts from WMS 6.01.

SidetoneHandset
=0-7
only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is disabled by default. It enables handset sidetone feature (sidetone is the sound of your own voice that you hear from handset or headset when making a call) (disabled = 0, min. level = 1, max. level = 7).
SidetoneHeadset
=0-7
only for [wildixp2] section and WP480/ 490 r3 phones (2017), WorkForce, WelcomeConsole. The parameter is disabled by default. It enables headset sidetone feature (disabled = 0, min. level = 1, max. level = 7).
SIPServerPort
=0-65535 
set SIP Server Port of the device registered to the account.
SIPServerPortRemote
=0-65535
set SIP Server Port of the device behind NAT registered to the account.
SIPTransport
=UDP|TCP|TLS 

set SIP transport protocol of the device registered to the account.

SIPTransportRemote
=UDP|TCP|TLS
set SIP transport protocol of the registered account in the device, located behind NAT.
SNMP
{"enabled":"yes|no", port:"<1024-65535>",
"trusted_ip":"<IPv4 address>"}

only for [wildixp2] section and WP480R3, WorkForce, WelcomeConsole. The parameter is disabled by default. It enables SNMP monitoring. Examples of a valid SNMP parameter: SNMP={"enabled":"yes", "port":"4444", "trusted_ip":"192.168.0.100"} or SNMP={"enabled":"yes"}.

Notes

  • the parameter is available starting from WMS Beta 6.06.20240319.1 and requires corresponding firmwares: WelcomeConsole v. 68.145.2.79, WorkForce v. 65.145.6.53, WP480GR3 v. 63.145.10.44 
  • you can leave the "port" and "trusted_ip" values empty or skip them. If SNMP is enabled, the default values are used: "port"="161" and "trusted_ip"="" (which means phones accept SNMP requests from any IP)
  • valid values for the "port" are: 161, or any value between 1024 and 65535 (excluding the range 11800-14000, commonly used by RTP)
  • If SNMP was previously manually enabled, the manual configuration has priority over SNMP set through provisioning. To use the provisioning parameter, you can either reset  phones to factory defaults or disable the parameter by setting "SNMP"="no", sync phones, then set "SNMP"="yes" and other values if required, and sync phones again
SpeakerDisable
=yes|no|<list of extensions>

only for [wildixp2] section. The parameter allows disabling speaker mode on WorkForce. By default, the speaker mode is on ("yes" - disable the speaker mode for all WorkForce devices, "no" - enable it,<list of extensions> (e.g. SpeakerDisable=380,240,220) - disable the speaker mode for the mentioned extensions only).

Note: the parameter is available starting from WMS 5.04.

SRTPForceUse 
=yes|no
only for [wildixgw], [wildixfxo3] and [wildixfxs2] sections. The parameter is enabled by default for [wildixgw] starting from WMS version 5.01 and for [wildixfxo3] and [wildixfxs2] sections - starting from WMS version 5.03 ("no" - disable, "yes" - enable). It enables Direct SDES-SRTP support between BRI/ PRI media gateways (EOL).
ToneDetectByPeer
=yes|no

only for [wildixfxs2] section. When enabled, the parameter fixes an issue of slow fax reception speed which sometimes occurs in US/ Canada on FXSR3 devices. By default, the parameter is disabled.

Note: the support starts from WMS 5.04.

TrustLocalDevice
=yes|no
only for [general] section. Enable/ disable an automatic adding of local devices to the provisioning database (for 2 hours) (Note: for W-AIR you have create network manually via WMS interface).
TXgain
=-10-10

only for [wildixfxs2] section. The parameter allows modifying the TX gain level on FXS r3 media gateways. The default value is 0 dB.

Note: the support starts from WMS 6.01.

WairMulticastSync 
=yes|no

only for [wildixair] section on a HW/ VM PBX. When enabled and Primary Base IP parameter is not set in WMS -> Devices -> W-AIR Networks, Multicast data sync is used instead of Peer to Peer (the setting on a base station's web interface).

Note: the support starts from WMS 6.04.20230815.1.

w-air-sb-pin
=0000-9999
only for [wildixair] section. The parameter allows changing the default PIN code for W-AIR SB.
WairSilentcharging 
=on|off|deactivated

only for [wildixair] section. The parameter allows controlling silent charging setting for x-hoppers headsets. Value "on" implies that only LED indication is used while charging; "off" suggests normal mode with LED indication and audio while charging; "deactivated" means headset is disconnected and can’t receive calls while charging. 

Note: the support starts from WMS 6.01.20221122.1. 

WebLoginActive=yes|no

only for [wildixp2] section. The parameter allows to disable Web GUI on WorkForce and WelcomeConsole phones after provisioning. By default, Web GUI is enabled. 

Note: the support starts from WMS Beta 6.04.20231012.1, WorkForce firmware v. 65.145.6.43, WelcomeConsole firmware v. 68.145.2.72.

WideNarrowbandUse
=yes|no

only for [general] section. The parameter allows managing wideband codecs usage. By default, the parameter is disabled and wideband codecs are forced for all devices. When the parameter is enabled (WideNarrowbandUse=yes), the previous behaviour remains: all devices use wideband codec priority or narrowband codec priority and remote codecs priority or local codecs.

Notes: In case of WideNarrowbandUse=yes, you need to add relevant lines to etc/callweaver/sip-wideband.conf to set the parameters (see more in Custom config parameters List - Manage wideband codecs usage)  

Note: the parameter is available starting from WM5.04.