Snom m3/Configuration/Auto Provisioning

From Snom User Wiki

Jump to: navigation, search

Contents

Introduction

If there is more than one handset to configure it is recommended to write the settings into a configuration file and place it on a boot server (HTTP or TFTP). The filename consists of the m3's MAC address and the extension "cfg", e.g. 0004132a1179.cfg. Press the "volume up" key on the handset in idle mode to obtain the MAC address. For further information, see description.

System Requirements

When a hosted IP Centrix solution provided by an internet telephony service provider is not used, the provisioning system for the snom m3 can consist of the following servers:

  • Configuration Server: Central server holding configurations such as ITSP account information, CODEC priority setup, SMTP timeserver configuration, time zone, etc. The configuration will be retrieved by the telephone as a text file. Optionally the file can be AES encrypted. See Encrypting and decrypting Configuration Files.
  • Firmware Update (Boot) Server: HTTP or TFTP server holding binary firmware images for remote firmware upgrading of the telephones. In addition the server makes textual release description available for the end-user through the phone’s user interface.
  • Management Command Server: SIP server enabling remote management of the phones.
  • InfoBrowse Server (optional): Stores a possibly dynamic web tree of WMLc decks containing info-browse information.

The servers can be placed on the Internet or on a local area network (LAN). If separate servers are used for the configuration files and the firmware update files, they must be placed on the same IP-address /DNS, as they have the location configuration parameter in common.

Setting up the Network

By default (factory setting), snom m3 phones are configured to use HTTP as the transfer protocol for provisioning. TFTP can also be used. The boot server address can be an IP address, a fully qualified domain name (FQDN), or an URL.

Initiate the download of the configuration files from the handset by selecting Settings/System Settings/Reset Gateway/Confirm. The gateway will be reset and request the configuration file from a preset location (a network address stored in nonvolatile memory).

NOTE: When the gateway is reset, any active calls will be dropped. When the call indicator on the gateway is lit, there is at least one call in progress.

Setting up the Boot/Update Server

The following guidelines describe a combined configuration and firmware update server.

  • Install boot server application or locate suitable existing server(s).
  • Create account and home directory.
  • Create /Config subfolder.

Creating Configuration Files

You must create a configuration file for each gateway you intend to deploy. The telephone interfaces with the configuration server through a text-based configuration file for downloading as well as uploading. The file can be plain text or encrypted text, if there is an encryption key on the phone. See Encrypting and decrypting Configuration Files.

NOTE: When creating or editing configuration files, use a standard text editor like Notepad. XML editors, Microsoft Word, and other types of editors may leave hidden extended characters that may cause problems for the gateway.

The location from which configuration files and firmware upload files can be downloaded is preset. This URL can be changed through configuration (see TBA), but resetting the gateway to factory defaults will also result in this value back being set back to the preset location.

The configuration files must be placed in a subfolder named /Config and the complete path name from the root of the transport server (HTTP or TFTP root) to the phone must conform to the format <ROOT-/Config/:

  • Unencrypted text: <NETWORK_HTTP_SERVER-/Config/<MAC_ADDRESS-.cfg
  • Encrypted text: <NETWORK_HTTP_SERVER-/Config/<MAC_ADDRESS-.cry

Naming Configuration Files

The name of the configuration file for each gateway must contain the MAC address, followed by the .cfg or .cry extension for plain-text or encrypted files, respectively.

Examples:
Unencrypted:  0004132A917F.cfg
Encrypted:   0004132a1179.cry

Syntax

The configuration file has one configuration parameter per text line. Each parameter is defined by a name and a value:

%<parameter_name>% : <value> 

The <parameter_name> is a text string without spaces. The <value> can be a null-terminated string, a decimal or hex-value, or an array of hex/dec values.

The phone will replace the parameters represented in the configuration file. This means that a subset of the parameters can be included in the configuration file. If some of the parameters are unknown to the phone they will be disregarded.

Creating Configuration Files

Copy the following template into the /Config subfolder you have created. Edit as necessary. For detailed information on configuration parameters used by the snom m3, see settings.

//-----------Network Settings------------
%SIP_RPORT_ENABLE%:1 //A way around NAT
%SIP_STUN_ENABLE%:0 //0-disable, 1-enable stun services
%NETWORK_STUN_SERVER%:"stun01.STUNserver.com" // insert name of STUN Server here
%SIP_STUN_BINDTIME_GUARD%:80
%SIP_STUN_BINDTIME_DETERMINE%:0
%SIP_STUN_KEEP_ALIVE_TIME%:90

//------------Network Time---------------
%NETWORK_SNTP_SERVER%:"ptbtime1.ptb.de" // insert a local NTP Server here
%NETWORK_SNTP_SERVER_UPDATE_TIME%:255 //SNTP Update in seconds
%DAY_LIGHT_SAVING%:1
%GMT_TIME_ZONE%:1

//--------Provisioning Server------------
%MANAGEMENT_TRANSFER_PROTOCOL%:0 //0-TFTP, 1-HTTP
%NETWORK_TFTP_SERVER%:"config.yourcompany.com" // Configuration server IP or FQDN
%NETWORK_FWU_SERVER%: " provisioning.snom.com" // Firmware update server IP or FQDN
%FWU_TFTP_SERVER_PATH%:"m3/firmware/" //subdir to find Firmware updates
%VOIP_LOG_AUTO_UPLOAD%:0 //0-no uploading, 1-upload bootlog only,2-upload everything

//------------SIP Server 0---------------
%SRV_0_SIP_UA_DATA_SERVER_PORT%:5060
%SRV_0_SIP_UA_DATA_DOMAIN%:"proxy.SIPserver0.com"  // insert SIP Server here
%SRV_0_SIP_UA_DATA_PROXY_ADDR%:"proxy.SIPserver0.com"  // insert SIP Server here
%SRV_0_SIP_UA_DATA_SERVER_IS_LOCAL%:0 //0-not local, 1-local to determine NAT related settings
%SRV_0_SIP_UA_DATA_REREG_TIME%:3600
%SRV_0_SIP_URI_DOMAIN_CONFIG%:0
%SRV_0_SIP_UA_CODEC_PRIORITY%:0,1,3,4,0xFF
%SRV_0_DTMF_SIGNALLING%:2
%SRV_0_SIP_UA_DATA_SERVER_TYPE%:1 //1-SIP, 2-mgmt server, 4-infopush

// ------------- Registration 1 -------------------
%SUBSCR_0_SIP_UA_DATA_SIP_NAME%:"12345678"  // insert SIP username here
%SUBSCR_0_UA_DATA_DISP_NAME%:"Max Mustermann"  // insert your name for display
%SUBSCR_0_UA_DATA_AUTH_NAME%:"12345678"
%SUBSCR_0_UA_DATA_AUTH_PASS%:"abcdefghijklmn"  // insert SIP password here
%SUBSCR_0_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"8000" // insert Mailbox number
%SUBSCR_0_SIP_UA_DATA_SIP_NAME_ALIAS%:"12345678" //Alias name for Phone UI
%SUBSCR_0_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_0_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 2 -------------------
%SUBSCR_1_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_1_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_1_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_1_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_1_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_1_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_1_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_1_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 3 -------------------
%SUBSCR_2_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_2_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_2_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_2_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_2_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_2_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_2_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_2_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 4 -------------------
%SUBSCR_3_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_3_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_3_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_3_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_3_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_3_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_3_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_3_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 5 -------------------
%SUBSCR_4_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_4_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_4_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_4_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_4_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_4_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_4_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_4_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 6 -------------------
%SUBSCR_5_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_5_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_5_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_5_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_5_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_5_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_5_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_5_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 7 -------------------
%SUBSCR_6_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_6_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_6_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_6_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_6_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_6_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_6_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_6_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ------------- Registration 8 -------------------
%SUBSCR_7_SIP_UA_DATA_SIP_NAME%:"" //SIP address
%SUBSCR_7_SIP_UA_DATA_VOICE_MAILBOX_NUMBER%:"" //Mailbox number
%SUBSCR_7_UA_DATA_DISP_NAME%:"" //Display name for Caller ID
%SUBSCR_7_UA_DATA_AUTH_NAME%:"" //Auth User ID
%SUBSCR_7_UA_DATA_AUTH_PASS%:"" //Auth password
%SUBSCR_7_SIP_UA_DATA_SIP_NAME_ALIAS%:"" //Alias name for Phone UI
%SUBSCR_7_SIP_UA_DATA_VOICE_MAILBOX_NAME%:""
%SUBSCR_7_SIP_UA_DATA_SERVER_ID%:0 //SIP Server to use

// ----------Emergency Primary Line----------------
%EMERGENCY_PRIMARY_PORT%:1 //1-VOIP1 .. 8-VOIP8
END_OF_FILE

Encrypting and decrypting Configuration Files

Configuration files may be encrypted using a command line tool. This tool is available for Unix and win32 environments. The encryption algorithm is AES128. Encrypted files are handled similar to unencrypted files, with exception of the filename extension, which must be .cry. User instructions for endecrypt.exe can be shown by executing: "Endecryptfiles.exe h" or below:

========================================
====  Help for EnDecryptFiles.exe     ==
========================================
Short decription:
This program either encrypt or decrypt a specified
configuration file. The extension for plain config
files is .cfg and the extension for encrypted is
.cry. It is also possible to en/decrypt more files
at a time. This is done by placing the MAC addresses
in the file ConfigList.txt.
EnDecryyptFile.exe takes up to four input arguments:
Possible first arguments are:
<MAC>: The MAC address we want to en/decrypt. The
       address must be a 12 digit number.
<all>: Indicates that MAC addresses we want to en-
       /decrypt are read from ConfigList.txt.
<help>:help text
Possible second arguments are:
<e>:   Perform encryption
<d>:   Perform decryption
Note!! If only two arguments are applied the program looks
       the confifuration files in the current dir
Possible Third arguments are:
<path>:   Path to .cfg file
Possible Fourth arguments are:
<path>:   Path to .cry file
Note!! If a third argument is applied the user must also
      apply fourth argument
Examples: <EnDecryptFiles 00087B0038BB e>
         <EnDecryptFiles 00087B0038BB d>
         <EnDecryptFiles 00087B0038BB d> d:/temp/ ../
         <EnDecryptFiles all d>

Changing the Location of the Configuration File

You can change the location of the configuration file on the handset, in the snom m3 web user interface, and in the configuration file. The configuration file will override any settings changed through the web user interface.

The default setting is Custom + Option 66. The phone will look for a boot server from DHCP Custom Option 160 first. If none is found, it will try Option 66. If none is found, it will use the location typed in the configuration address field in the management settings section of the web user interface.

Through DHCP Option 66 or DHCP Custom Option 160

  1. Press the OK key on the handset. Select Settings / Network Settings. You will be prompted for the administrative password. Select DHCP / Boot Server. Select Option 66 or Custom Option. Press the OK key.
  2. Select DHCP / Boot Server Type and press the OKkey. Select string or IP address.
  3. On your DHCP server, change to Custom Option or Option 66 and set the FQDN (fully qualified domain name, for example provisioning.examplemthree.com) or IP address of the boot server, depending on whether you have selected string or IP address.
  4. Press 'Reboot for the change to take effect.

NOTE: Active calls on the snom m3, as indicated by the lit call light on the gateway, will suspend any gateway reboot requests until there are no active calls. The gateway will automatically begin to reset 15 seconds after the last call has been terminated.

Through the snom m3 web user interface

  1. Press the OK key on the handset. Select Settings / Network Settings. You will be prompted for the password. Select DHCP / Boot Server - Static. Press the OK key.
  2. Press the Volume Up key to show the local IP address of the gateway on the display.
  3. Type this IP address into the address field of your web browser on a computer connected to the same network as the gateway.
  4. Log in using the username and password. The default setting for both is “Admin”.
  5. Enter the IP address or FQDN of your boot server in the Configuration Address field of the Management Settings section.
  6. Click on Save Changes.
  7. Click on Reboot for the change to take effect.

NOTE: Active calls on the snom m3, as indicated by the lit call light on the gateway, will suspend any gateway reboot requests until there are no active calls. The gateway will automatically begin to reset 15 seconds after the last call has been terminated.

NOTE: If the %FWU_TFTP_SERVER_PATH% is specified in the configuration file, this specification will overwrite the firmware address entered in the Update section when the gateway is rebooted. </blockquote>

Through the configuration file itself

  1. Press the OK key. Select Settings / Network Settings. You will be prompted for the password.
  2. Select DHCP / Boot Server / Static. Press the OK key. This will ensure that the gateway uses the manually configured boot server address.
  3. Change NETWORK_TFTP_SERVER in the current configuration file at the current location. For more information, refer to Network TFTP Server on the Settings page. This parameter is used for both TFTP and HTTP protocols.
  4. (Optional) Encrypt the configuration file. See above.
    • Place a new configuration file at the new location.
    • To load the new configuration file, select Settings - System Settings -.
    • Reset Gateway - Yes on the handset. This will download the new configuration file from the old location.

Provisioning

From the boot server

Create a configuration file named <MAC-.cfg (unencrypted) or <MAC-.cry (encrypted) and store it on a local web server or TFTP server. See Creating Configuration Files above.

Automatic provisioning if you are not using DHCP

  1. Set the IP address, the netmask, and the DNS server of the gateway manually via the handset:
  2. From the idle display, press the OK key. Select the Settings icon and press the OK key.
  3. Select Network Settings and enter the PIN code. Select IP Mode - Static and press the OK key.
  4. Enter the IP address, the netmask, the DNS server, and the default gateway.
  5. Press the function key underneath Yes.
  6. Reset the gateway, using the handset. With the handset’s display in idle mode, press the OK key, select the Settings icon – System Settings – Reset Gateway – function key YES underneath the display.


Automatic provisioning if you are using DHCP

  1. With the display in idle mode, press the Volume Up key to show the local IP address of the gateway on the display.
  2. Enter http:// and the IP address of the gateway into the address field of a web browser connected to the same network as the snom m3.
    • Example: http://192.168.0.1. The default login name and the default password are both “admin”.
  3. Select Advanced settings in the menu on the left side of the screen.
  4. In the Management settings section, select the transfer protocol (HTTP or TFTP) to be used.
  5. Enter the IP address or hostname of the boot server as the configuration address.
  6. Reset the gateway, using the handset. With the handset’s display in idle mode, press the OK key, select the Settings icon – System Settings – Reset Gateway – function key YES underneath the display.

After the gateway has been reset, it will pick up the new configuration file from the boot server. Check the boot server or the web administrator debug log to make sure that the file is being sent.

NOTE: Active calls on the snom m3, as indicated by the lit call light on the gateway, will suspend any gateway reboot requests until there are no active calls. The gateway will automatically begin to reset 15 seconds after the last call has been terminated.

NOTE: Every time the gateway is reset, it will reload the configuration file. Any settings made on the phone or through the web user interface will be overwritten.

When the configuration file has been loaded and at least one registration successfully established, the registration indicator on the gateway will light up amber.

Personal tools
Interoperability