Actions

Configuration File Parameters for SIP Provisioning

From Zenitel Wiki

Revision as of 12:31, 23 June 2017 by Asle (talk) (→‎Call Parameters)
SIP Icon 300px.png

This article describes the parameters in the configuration file used for TFTP Provisioning. See TFTP Provisioning for how to configure the station.

TFTP Provisioning is supported by all IP Stations (Turbine and INCA stations), operating in SIP mode.


Remote Provisioning using TFTP

An IP station may be set up to automatically poll configuration from a TFTP server. The IP address of this TFTP server can be obtained using DHCP procedures or be manually configured.

The IP station will first try to download the global configuration file: 

ipst_config.cfg

Then the IP station will download a device specific configuration file: 

ipst_config_01_02_03_04_05_06.cfg

where 01_02_03_04_05_06 is the MAC address of the IP station.

If the same parameter is found in several files, then the precedence is as following:

  1. .MAC address file
  2. IP address file
  3. Global file

General Parameters

auto_update_interval

  • Required: No. If this parameter's not set in the file, the function will be disabled
  • Description: This parameter enables the station to automatically look for software updates on the TFTP server
  • Values: Number of minutes to wait between each server request. Value must be between 1 and 999

auto_update_image_type

  • Required: If auto_update_interval is set
  • Description: The name of the software image file to be uploaded
  • Values: Text giving the name of the software image file. The full name of the file, including extension, is required. This parameter must be set if the auto update function is enabled

auto_update_image_crc

  • Required: If auto_update_interval is set
  • Description: The CRC checksum calculated for the software image file specified by the auto_update_image_type parameter. This is used to check the integrity of the software file before updating the station
  • Values: Hexadecimal value

turbine_frontboard

  • Description: Configures the turbine frontboard type
  • Values: 
  • 0 = KIT
  • 1 = TKIE-1, TCIS-1, TCIS-2, TCIS-3
  • 2 = TCIS-6
  • 3 = TCIS4, TCIS-5
  • 4 = TFIE-1, TFIX-1
  • 5 = TFIE-2, TFIX-2
  • 6 = TFIX-3
  • 7 = ECPIR-P
  • 8 = EAPII-1, EAPFX-1
  • 9 = EAPII-6, EAPFX-6
  • 10 = ECPIR-3P
  • 11 = EAPIR-8
  • 51 = TCIV-2, TCIV-3
  • 52 = TCIV-6
  • 53 = MINI

SIP Parameters

nick_name

  • Required: No. Defaults to sip_id
  • Description: The nick name for the station can be used to assign a logical name to the station. E.g. a station belonging to James may be assigned the nick name "James", or "James' station"
  • Values: Text string. Max length is 64 characters.

sip_id

  • Required: Yes
  • Description: This is the identification of the station in the SIP domain, i.e. the phone number for the station
  • Values: Integer value. Max length is 64 characters.

sip_domain

  • Required: Yes
  • Description: SIP domain is a server that uses SIP (Session Initiation Protocol) to manage real-time communication among SIP clients. The sip_domain parameter specifies the primary domain for the station, as opposed to sip_domain2 which specifies the secondary (or fall back) domain. The IP address for the SIP domain server (e.g. Asterisk or Cisco Call Manager) should be defined in this section
  • Values: IP address given in regular dot notation, e.g. 10.5.2.100

sip_domain2

  • Required: No
  • Description: This is the secondary (or fall-back) domain. If the station loses connection to the primary SIP domain, it will switch over to the secondary.
  • Values: IP address given in regular dot notation, e.g. 10.5.2.100

auth_user

  • Required: Only if the SIP server requires authentication
  • Description: The authentication user name used to register the station to the SIP server.
  • Values: Text string.

auth_pwd

  • Required: Only if the SIP server requires authentication
  • Description: The authentication user password used to register the station to the SIP server.
  • Values: Text string.

sip_outbound_proxy

  • Required: Optional
  • Description: Configures an outbound-proxy server that receives all initiating request (INVITE and SUBSCRIBE) messages.
  • Values: IP address given in regular dot notation, e.g. 10.5.2.100

sip_outbound_proxy_port

  • Required: If proxy server is defined. Default 5060.
  • Description: The UDP port used for SIP on the proxy server.
  • Values: Integer.

register_interval

  • Required: No. Defaults to 600 seconds
  • Description: This parameter specifies how often the station will register, and reregister, in the SIP domain. This parameter will affect the time it takes to discover that a connection to a SIP domain is lost
  • Values: Number of seconds. 60 ≤ register_interval ≤ 999999

playback_gain (RS amplifier only)

  • Required: No. 
  • Description: This parameter specifies the gain on a output channel
  • Values: dB.  -40 ≤ playback_gain ≤ 0

recorder_gain (RS amplifier only)

  • Required: No. 
  • Description: This parameter specifies the gain on a input channel
  • Values: dB.  0 ≤ recorder_gain ≤ 40

Call Parameters

Relay Parameters

relay1_dtmf_activate

  • Description: Dtmf value to send for activating the relay
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_deactivate

  • Description: Dtmf value to send for deactivating the relay
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_flashing_slow

  • Description: Dtmf value to send for setting the relay to flashing slow
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_flashing_fast

  • Description: Dtmf value to send for setting the relay to flashing fast
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_toggle

  • Description: Dtmf value to send for toggling the relay
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_timed_relay

  • Description: Dtmf value to send for activating the relay for X seconds
  • Values: Valid values is 0-9, * and #. The character - means off.

relay1_dtmf_timed_relay_duration

  • Description: Duration to activate relay
  • Values: Integer. 0 means activate relay forever.

relay1_event_out_ringing

  • Description: When the station is ringing in an outgoing call, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

relay1_event_inc_ringing

  • Description: When the station is ringing in an incoming call, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

relay1_event_inc_call

  • Description: When the station is in an incoming call, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

relay1_event_out_call

  • Description: When the station is in an outgoing call, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

relay1_event_idle

  • Description: When the station is idle, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

relay1_event_error

  • Description: When the station is error, turn the relay to state: activated, deactivated, flashing slow, flashing fast, do nothing
  • Values: Integer. 0 = do nothing, 1 = activate, 2 = deactivate, 3 = flash slow, 4 = flash fast

Tone Parameters

enabled

  • Description: Enables tone test
  • Values: Integer Value. 0 = disabled, 1 = enabled

time_between_tonetest

  • Description: Time between tonetests
  • Values: Integer Value.

sound_pressure_level

  • Description: Time between tonetests
  • Values: Integer Value. Only odd values. 53 ≤ sound_pressure_level ≤ 97

volume

  • Description: Volume of the tone test
  • Values: Integer Value. 0 ≤ volume ≤ 7

SNMP Parameters

trap_receiver
  • Required: No.
  • Description: The IP address of the server receiving SNMP traps.
  • Values: IP address given in regular dot notation, e.g. 10.5.2.100


network
  • Required: No.
  • Description: Used, together with the network mask, to determine the allowed network for reading the MIB on the IP station.
  • Values: IP address given in regular dot notation, e.g. 10.5.2.100. For example, with an allowed network of 10.5.2.0 and a network mask of 24, anyone with IP address 10.5.2.0 to 10.5.2.255 can access the MIB.


network_mask
  • Required: No.
  • Description: The mask used to determine the allowed network for reading the MIB.
  • Values: Integer. 0 ≤ network_mask ≤ 32. For example, with an allowed network of 10.5.2.0 and a network mask of 24, anyone with IP address 10.5.2.0 to 10.5.2.255 can access the MIB.


community
  • Required: No.
  • Description: A text string used as a password for authentication.
  • Values: String.


enable_v1
  • Required: No.
  • Description: Enables reading of MIB using SNMP version 1.
  • Values: Integer. 1 = enabled, 0 = disabled.


enable_v2c
  • Required: No.
  • Description: Enables reading of MIB using SNMP version 2c.
  • Values: Integer. 1 = enabled, 0 = disabled.


enable_ipsStarted
  • Required: No. Defaults to 1.
  • Description: If enabled, the station will send an SNMP trap when the station application is started.
  • Values: 0 = disabled, 1 = enabled.
enable_sipRegistered
  • Required: No. Defaults to 1.
  • Description: If enabled, the station will send an SNMP trap when successfully registered in the SIP domain.
  • Values: 0 = disabled, 1 = enabled.


enable_sipRegisterFailed
  • Required: No. Defaults to 1.
  • Description: If enabled, the station will send an SNMP trap if registration to the SIP domain failed.
  • Values: 0 = disabled, 1 = enabled.


enable_callConnect
  • Required: No. Defaults to 1
  • Description: If enabled, the station will send an SNMP trap when a call is connected.
  • Values: 0 = disabled, 1 = enabled.


enable_callConnectFailed
  • Required: No. Defaults to 1.
  • Description: If enabled, the station will send an SNMP trap if an incoming call to the station fails to connect for any reason (busy etc.).
  • Values: 0 = disabled, 1 = enabled.


enable_callDisconnect
  • Required: No. Defaults to 1.
  • Description: If enabled, the station will send an SNMP trap when a call is disconnected.
  • Values: 0 = disabled, 1 = enabled.


enable_buttonHanging
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a button is hanging (pressed for more than 10 seconds).
  • Values: 0 = disabled, 1 = enabled


enable_soundTestSuccess
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a sound test has been successfull
  • Values: 0 = disabled, 1 = enabled


enable_soundTestFailed
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a sound test has failed
  • Values: 0 = disabled, 1 = enabled


enable_buttonPressed
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a button has been pressed
  • Values: 0 = disabled, 1 = enabled
enable_buttonReleased
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a button has been released
  • Values: 0 = disabled, 1 = enabled


enable_relayActivated
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a relay has been activated
  • Values: 0 = disabled, 1 = enabled


enable_relayDeactivated
  • Required: No.
  • Description: If enabled, the station will send an SNMP trap when a relay has been deactivated
  • Values: 0 = disabled, 1 = enabled

Example Configuration File

[general]
auto_update_interval=10
auto_update_image_type=tsi-3.0.1.50
Only for Turbine (8121)
auto_update_image_type=A100G80200.01_10_1_2.bin
Only for 8020-8024
auto_update_image_crc=C1466499
Only for 8020-8024
[sip]
nick_name=Testname
sip_id=1003
sip_domain=10.5.2.209
sip_domain2=10.5.2.138
auth_user=1003
auth_pwd=1003pass
sip_outbound_proxy=10.5.2.138
sip_outbound_proxy_port=5060
register_interval=600
Value: 60 < seconds < 999999
[call]
dak1_value=1008
dak1_option=1
dak2_value=1009
input1_value=1010
input2_value=1011
ringlist1_value1=1000
ringlist1_value2=1004@169.254.1.100
ringlist1_value3=
ringlist1_value4=
ringlist1_value5=
ringlist1_value6=
ringlist1_value7=
ringlist1_value8=
ringlist1_value9=
ringlist2_value1=1002
ringlist2_value2=1003@169.254.1.101
ringlist3_value1=1005
ringlist3_value2=1006@169.254.1.102
ringlist_max_ring_time=60
ringlist_loop=1
ringlist_max_ring_time=30
speaker_volume=4
Value: 0 < level < 7.
mic_sensitivity=5
Value: 0 < level < 7.
rtp_timeout=60
Value: 0 < seconds < 9999. 0 = RTP timeout disabled.
remote_controlled_volume_override_mode=1
Accepted values 0 or 1.
auto_answer_mode=1
Accepted values 0 or 1.
auto_answer_delay=10
Value: 0 < seconds < 30
[relays]
relay1_dtmf_timed_relay=5
relay1_dtmf_timed_relay_duration=10
relay1_event_inc_ringing=1
relay1_event_inc_call=2
relay1_event_idle=1
[snmp]
trap_receiver=10.5.2.219
network=10.5.2.0
network_mask=24
community=public
enable_v1=1
Accepted values 0 or 1.
enable_v2c=1
Accepted values 0 or 1.
enable_ipsStarted=1
Accepted values 0 or 1.
enable_sipRegistered=1
Accepted values 0 or 1.
enable_sipRegisterFailed=1
Accepted values 0 or 1.
enable_callConnect=1
Accepted values 0 or 1.
enable_callConnectFailed=1
Accepted values 0 or 1
enable_callDisconnect=1
Accepted values 0 or 1
Retrieved from "https://wiki.zenitel.com/w/index.php?title=Configuration_File_Parameters_for_SIP_Provisioning&oldid=148933"