Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. iBG ICM Samsung IP Phone Provisioning Configuration Guide Document Type Language Code / Total page Create / Exam / Approve / Registered Date Item Code This is official SEC document created, registered, and circulated according to the following SEC corporate-wide technical document management regulations TNA-2210. Page 1 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. Revision History Rev No. Date Author Modification Details 0.1 2010-08-30 Voice team Initial Draft 0.2 2010-08-30 Voice team Modified Prerequisite 0.3 2011-02-22 Voice team Modified Prerequisite, Extended DHCP user_option 43 0.4 2011-04-14 Voice team Phase 2 development iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 2 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. TABLE OF CONTENTS Revision History .........................................................................................................................2 TABLE OF CONTENTS ..................................................................................................................3 DEFINITIONS AND ACRONYMS.................................................................................................4 1. Introduction ..........................................................................................................................5 2. Prerequisite ...........................................................................................................................6 3. Generation of Provision Profile files ..................................................................................7 3.1. Preparation of template files .............................................................................................................7 3.2. Generation of Global Profile files......................................................................................................7 3.2.1. Configuration of sec_boot.xml ...................................................................................................7 3.2.2. Configuration of sec_service.xml ...............................................................................................8 3.2.3. Configuration of sec_phonebook.xml .......................................................................................10 3.2.4. Configuration of sec_aom_{mac}.xml .....................................................................................10 3.2.5. Creation of sec_boot.xml and sec_service.xml .........................................................................10 3.3. Generation of station profile file ..................................................................................................... 11 3.3.1. MAC profile configuration ....................................................................................................... 11 3.3.2. User profile configuration ......................................................................................................... 11 3.3.3. Line profile configuration .........................................................................................................12 4. Initialization ........................................................................................................................13 4.1. Description of phone provisioning process .....................................................................................14 4.1.1. Fetching device profiles ............................................................................................................14 4.1.2. Registration process ..................................................................................................................15 4.1.3. Log Out .....................................................................................................................................17 5. Profile Update .....................................................................................................................18 5.1.1. Application of updated profile file to the phone .......................................................................18 iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 3 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. DEFINITIONS AND ACRONYMS DEFINITIONS ACRONYMS Abbreviation Description SIP Session Initiation Protocol MSBG Multi-Service Business Gateway ICM Integrated Communication Manager AOM Add On Module iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 4 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 1. Introduction iBG systems support auto provisioning for Samsung IP phones. To this end, the following profile files exist in the iBG system’s storage and can be download through HTTP. sec_boot.xml – It contains the basic information used to start up a phone. sec_{mac}.xml – It contains user ID/password used in HTTP authentication. sec_phone.xml – It contains information such as network and soft-menu information of phones. sec_service.xml – It contains general service codes and feature codes for the supplementary service. sec_user_{station number}.xml – It contains the list of profile files and registrar server information for each station. sec_line_{station number}.xml – It contains subscriber information, e.g., phone number and name. sec_phonebook.xml – It contains system phonebook information. sec_aom_{mac}.xml – It contains programmable button configuration of an expansion module. These files are downloaded in the following order in ordinary condition when downloaded through HTTP: sec_boot.xml -> sec_{mac}.xml -> sec_phone.xml -> sec_user_{station number}.xml -> sec_line_{station number}.xml -> sec_service.xml -> sec_aom_{mac}.xml -> sec_phonebook.xml iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 5 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 2. Prerequisite In order to use auto provision from a phone, you need to configure IP address on the phone. It can be configured manually or through DHCP. IP address and boot profile server information must be set in Engineering Mode in case of manual configuration. In case of using DHCP, user option 43 field must be used, which is used to describe boot profile server information. user_option 43 string must be set to "sec,tftp://<HTTP server Address>/profiles" In case of using vlan, the vlan id should be added additionally as follows; “sec,tftp://<HTTP server Address>/profiles,vlan-id=<vlan id>,vlan-qos=<qos value>, dvlan-id=<vlan id>,dvlan-qos=<qos value>" Note) vlan-id : voice(phone) vlan id, dvlan-id : data(PC) vlan id Any other DHCP server setting needed must be executed as well. iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 6 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 3. Generation of Provision Profile files The following procedure must be executed to generate phone profile files. 3.1. Preparation of template files You must un-tar iBG_phone_provision.tar which is released with SNOS image. Then, the ‘/cf0/profiles’ directory is created automatically. It has all the necessary phone provision template files (sec_user.template, sec_service.template, sec_line.template, sec_phone.xml). Note) When a new tar file is released, remove all the Samsung phone profile files created by iBG system under ‘/cf0/profiles’ directory before un-tarring the file. 3.2. Generation of Global Profile files The following files are called global profile files: sec_boot.xml sec_service.xml sec_phone.xml sec_phonebook.xml sec_aom_{mac}.xml sec_phone.xml is included in the compact flash card or the system storage and is used to provision all Samsung IP phones. In order to configure or create each profile file, you must follow the following instructions. 3.2.1. Configuration of sec_boot.xml Information on provision server, emergency call server, and dial plan for emergency call are included in sec_boot.xml. Provision server address and profile file path provision sever address - IP address of binding interface used for voice control packet is used. Therefore, no additional configuration is needed. file path - It has each profile file’s path. Currently, file path is fixed as /cf0/profiles, and it cannot be changed. Therefore, no additional configuration is needed. Emergency call server information Emergency call server address - IP address of binding interface used for voice control packet is used. Domain name - Host domain name. Protocol - protocol used in SIP transport message. iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 7 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. Port - assigned port number of each protocol. No additional configuration is needed to set emergency call server information. Dial plan for emergency call In order to configure dial plan for emergency call, follow the following steps. DUT1/configure# dial-plan DUT1/configure/dial-plan# number-plan <list index1> DUT1/configure/dial-plan/number-plan <list index1># pattern <number plan pattern> min <length> max <length> DUT1/configure/dial-plan/number-plan <list index1># type emergency DUT1/configure/dial-plan# number-plan <list index2> DUT1/configure/dial-plan/number-plan <list index2># pattern <number plan pattern> min <length> max <length> DUT1/configure/dial-plan/number-plan <list index2># type emergency DUT1/configure/dial-plan/number-plan <list index2># save local Phone firmware information Firmware information should be configured by each phone type if you want to change the firmware image of a phone at boot up time. Phone starts to upgrade its firmware from configured server automatically when it reboots if its firmware version differs from the configured version. Note) Firmware version, which is released with new firmware, must be written in correct form as shown below. SMT-i3100 : SCME-Vxx.xx SMT-i5210 : SCME-Vxx.xx SMT-i5230 : i5230-SCME-Vxx.xx SMT-i5243 : i5243-SCME-Vx.xx DUT1/configure# voice phone-provision firmware-type secxxxx DUT1/configure/voice/phone-provision/firmware-type secxxxx# server-address <addrs> DUT1/configure/voice/phone-provision/firmware-type secxxxx# image-path <path> DUT1/configure/voice/phone-provision/firmware-type secxxxx# protocol [http|tftp] DUT1/configure/voice/phone-provision/firmware-type secxxxx# version <vers> DUT1/configure# save local 3.2.2. Configuration of sec_service.xml This file contains feature codes for supplementary services supported by phones as shown the table below. The feature codes are set in the iBG system. iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 8 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. activate-call-conference set feature code for Active-Call-Conference(UA) Service barge-in set feature code for Call Barge-In call-forward-all-cancel set feature code for Call Forward All Cancel call-forward-all-registration set feature code for Call Forward All Registration call-forward-busy-cancel set feature code for Call Forward Busy Cancel call-forward-busy-registration set feature code for Call Forward Busy Registration call-forward-no-answer-cancel set feature code for Call Forward No Answer Cancel call-forward-no-answer-registration set feature code for Call Forward No Answer Registration call-forward-unreachable-cancel set feature code for Call Forward Unreachable Cancel call-forward-unreachable- set feature code for Call Forward Unreachable Registration registration call-park set feature code for Call Park call-park-retrieve set feature code for Call Park Retrieve(unpark) callback-activation set feature code for CallBack Activation callback-deactivation set feature code for CallBack Deactivation direct-call-pickup set feature code for Direct Call Pickup Service disable-call-waiting-for-current-call set feature code for Disable Call Waiting for Current Call Service disable-call-waiting-for-next-call set feature code for Disable Call Waiting for Next Call Service do-not-disturb-activation set feature code for Do Not Disturb Activation do-not-disturb-deactivation set feature code for Do Not Disturb Deactivation follow-me-cancel set feature code for Follow Me Cancel follow-me-registration set feature code for Follow Me Registration group-call-pickup set feature code for Group Call Pickup Service intercom set feature code for Intercom last-number-redial set feature code for Last Number Redial service multi-ring-activate set feature code for Multi-Ring Activation multi-ring-deactivate set feature code for Multi-Ring Deactivation start-n-way-conference-call set feature code for N-Way_Conference (Server) Service disable-call-waiting-for-next-call set feature code for Disable Call Waiting for Next Call Service conference-on-answer set feature code for Conference On Answer disable-call-waiting-for-current-call set feature code for Disable Call Waiting for Current Call Service disable-call-waiting-for-next-call set feature code for Disable Call Waiting for Next Call Service vms-transfer Set feature code for Transfer to VMS service call-waiting-activate set feature code for Call Waiting Activation call-waiting-deactivate set feature code for Call Waiting DeactivationCancel cancel-all-features set feature code for Cancel All Services (forwarding, dnd, callback, followme etc.,) iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 9 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. multi-ring-add set feature code for findme Number add for multi-ring service multi-ring-delete set feature code for findme Number delete for multi-ring service 3.2.3. Configuration of sec_phonebook.xml ‘sec_phonebook.xml’ file includes system phonebook information. To add a new entry to the phonebook, enter the name and the phone number. If you want to delete the entry, use the no form. You can apply the updated ‘sec_phonebook.xml’ file to all Samsung IP phones immediately with the ‘sync’ command. Name and number Name – it defines the contact's name. Number – it defines the contact's number. DUT1/configure# voice system-phonebook <index> <name> <number> DUT1/configure# no voice system-phonebook <index> <name> <number> DUT1/configure# voice system-phonebook sync 3.2.4. Configuration of sec_aom_{mac}.xml You can select Add on Module(AOM) devices from AOM pool for the phone. Currently, AOM can be connected to only Samsung SMT-i5243 and SMT-i5230 phone. SMT-i5243 phone has maximum 4 AOM devices but SMT-i5230 phone has just one AOM device. AOM device also receives IP address and the boot profile server information from a DHCP server(refer to 2. Prerequisite). Note) The total number of AOM devices varies from the system type. (ex. iBG3026: 128, iBG2016: 64, iBG2006/iBG1003/iBG1004: 32) In order to generate aom profile file, you must configure MAC address and execute ‘save local’ command as shown below. DUT1/configure# voice phone-provision aom <tag> DUT1/configure/voice/phone-provision/aom <tag># mac-address <AOM MAC Address> DUT1/configure/voice/phone-provision/aom <tag># save local Up to 60 extension buttons, each of which can be set to one of BLF type and Speed dial type. If the configuration of buttons is modified, system sends ‘nodify’ message to registered phone in order to apply the change to the AOM. DUT1/configure/voice/phone-provision/aom <tag># blfext <key location> <station number> DUT1/configure/voice/phone-provision/aom <tag># speed <key location> <station number> 3.2.5. Creation of sec_boot.xml and sec_service.xml iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 10 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. You can choose one of the following two methods in order to generate sec_boot.xml and sec_service.xml. Copy the sec_service.template in /cf0/profiles, and reboot the system when the voice gateway’s operation status is UP. Copy the sec_service.template in /cf0/profiles, and change the voice gateway’s operation status from DOWN to UP as shown below. DUT1/configure/voip-gateway# shutdown DUT1/configure/voip-gateway# *Aug 28,2010,12:11:03 #SIP-notification: VoIP Gateway Stopped DUT1/configure/voip-gateway# no shutdown DUT1/configure/voip-gateway# 3.3. *Aug 28,2010,12:11:08 #SIP-notification: VoIP Gateway Started Generation of station profile file sec_{mac}.xml , sec_user_{station number}.xml, and sec_line_{station number}.xml are created for each phone station. Phone type must be set to Samsung and MAC address for the phone must be configured to generate all the station profile files. Each phone profile file is generated or updated automatically when you configure the station for provisioning. 3.3.1. MAC profile configuration In order to generate station profile files, you must configure MAC address as shown below. DUT1/configure# voice station <station number> DUT1/configure/voice/station <station number># type secxxx DUT1/configure/voice/station <station number># phone-profile DUT1/configure/voice/station <station number>/phone-profile# mac-address <phone MAC Address> 3.3.2. User profile configuration Configuration for user profile includes setting of registrar server, extension key button mapping and selecting one or more AOM devices from AOM pool. Registrar server address, domain name, protocol, and port number are as follows: Registrar sever address - IP address of binding interface used for voice control packet is used. Domain name - Host domain name. Protocol - Protocol used in SIP transport message. Port - Assigned port number of each protocol. Up to 96 extension keys are available, each of which can be set to one of BLF type and Speed dial type. DUT1/configure# voice station <station number> iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 11 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. DUT1/configure/voice/station <station number># type secxxx DUT1/configure/voice/station <station number># phone-profile DUT1/configure/voice/station <station number>/phone-profile# blfext <key location> <station number> <description> or DUT1/configure/voice/station <station number>/phone-profile# speed <key location> <station number> <description> Up to 4 AOM devices are available, each of which can be identified by AOM device ID. DUT1/configure# voice station <station number> DUT1/configure/voice/station <station number># phone-profile DUT1/configure/voice/station <station number>/phone-profile# aom-device <index> 3.3.3. Line profile configuration Parameters such as phone screen display name, user authentication ID and password may be configured in sec_line_{station number}.xml. DUT1/configure# voice station <station number> DUT1/configure/voice/station <station number># type secxxx DUT1/configure/voice/station <station number># name “subscriber name displayed on screen” DUT1/configure/voice/station <station number># authentication username <ID> password <password> iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 12 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 4. Initialization Samsung Phone Provisioning Procedure is depicted below. iBG HTTP Server DHCP 4 2 3 1 IP Phone 1. Using DHCP, phone gets information on IP address and HTTP server address for boot profile. Or these can be configured manually. 2. Phone gets boot profile from the HTTP server. It contains device configuration and HTTP server address for station profiles. 3. Phone gets station profiles from the server. 4. Phone registers with iBG ICM. [Figure 1] Samsung IP Phone Provisioning Procedure iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 13 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 4.1. Description of phone provisioning process When the phone is power on, the following procedure is executed. 4.1.1. Fetching device profiles Samsung IP phone is automatically provisioned according to the procedure as depicted in the figure below. Assumption: IP address of the phone is already assigned manually or through DHCP. HTTP Server Phone 1: Read Request (File: sec_boot.xml) 2: Data Packet (Boot Profile, Provision server Address, firmware version) 3: Read Request (File:firmware image files) 4: Data Packet (firmware image files) 5: Read Request (File: sec_{mac}.xml) 6: Data Packet (Mac Profile, HTTP auth ID/PWD) [Figure 2] Fetching Device Profile 1. IP phone requests boot profile file from HTTP server when powered on. 2. HTTP server replies to the phone with boot profile file. Boot profile includes network information, provision server location information and phone firmware information. 3. HTTP server sends boot profile in XML format in 200 OK message. 4. Phone compares its version with that written in boot profile. Phone tries to upgrade firmware from a server and protocol provisioned, if the version of the phone differs from the boot profile’s. 5. Server replies to the phone with firmware image files. 6. If phone does not need to upgrade firmware, phone sends GET message requesting for MAC profile file that is used for HTTP authentication. GET /profiles/sec_{mac}.xml HTTP/1.1 7. HTTP server replies with MAC profile file in XML format in 200 OK message. HTTP/1.1 200 OK Date: xxxx Server: xxxxxx Content-Length:xxxx Content-Type:text/xml CRLF iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 14 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. <?xml version='1.0'?> <MacProfile> <login_info id=”ID” password=”password” /> </MacProfile> CRLF 4.1.2. Registration process HTTP Server Phone ICM MAC profile (ID & PWD) 1.GET(phone profile path) 2.200 OK (Phone Profile) 3.GET(user profile path) 4.200 OK (user Profile) 5.GET(line profile path) 6.200 OK (line Profile) 7.GET(service profile path) 8.200 OK (service Profile) 9.GET(aom profile path) 10.200 OK (aom Profile) 11.GET(phonebook profile path) 12.200 OK (phonebook Profile) 13.REGISTER 14.200 OK [Figure 3] Registration Process 1. Phone sends GET message requesting for phone profile file to the HTTP server. GET /profiles/sec_phone.xml HTTP/1.1 iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 15 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 2. HTTP server replies with phone profile file in XML format in 200 OK message. HTTP/1.1 200 OK Date: xxxx Server: xxxxxx Content-Length:xxxx Content-Type:text/xml CRLF <?xml version='1.0'?> Phone profile tags formatted in XML CRLF 3. Phone sends GET message requesting for user profile file to the HTTP server. GET /profiles/sec_user_{station number}.xml HTTP/1.1 4. HTTP server replies with user profile file in 200 OK message. HTTP/1.1 200 OK Date: xxxx Server: xxxxxx Content-Length:xxxx Content-Type:text/xml CRLF <?xml version='1.0'?> User profile tags formatted in XML CRLF 5. Phone sends GET message requesting for line profile file to the HTTP server. GET /profiles/sec_line_{station number}.xml HTTP/1.1 6. HTTP server replies with line profile file in 200 OK message. HTTP/1.1 200 OK Date: xxxx Server: xxxxxx Content-Length:xxxx Content-Type:text/xml CRLF <?xml version='1.0'?> Line profile tags formatted in XML CRLF iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 16 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 7. Phone sends GET message requesting for service profile file to the HTTP server. GET /profiles/sec_service.xml HTTP/1.1 8. HTTP server replies with service profile file in 200 OK message. HTTP/1.1 200 OK Date: xxxx Server: xxxxxx Content-Length:xxxx Content-Type:text/xml CRLF <?xml version='1.0'?> Service profile tags formatted in XML CRLF 9. Phone sends GET message requesting for AOM profile file to the HTTP server, when there is an AOM device connected to the phone. GET /profiles/sec_aom_{mac}.xml HTTP/1.1 10. HTTP server replies with AOM profile file in 200 OK message. 11. Phone sends GET message requesting for phonebook profile file to the HTTP server GET /profiles/sec_phonebook.xml HTTP/1.1 12. HTTP server replies with phonebook profile file in 200 OK message. 13. Phone sends SIP registrar message to register with ICM. 14. ICM registers the station and returns 200 OK message to the phone. 4.1.3. Log Out Currently, phone supports log out functionality only in hot-desking mode . Therefore, refer to the hotdesking functional specification document. iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 17 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. 5. Profile Update All the phone profile files are updated when the ‘save local’ command is executed. But boot profile and service profile files must be created in advance (refer to 3.2). Otherwise, they are not updated even if you execute the ‘save local’ command. Especially, the following execution is applied to the profile files and the phone immediately. Adding/modifying/deleting the system feature codes for voice supplementary services. Adding/modifying/deleting the configuration of Samsung-type station. Adding/modifying/deleting the AOM button’s configuration. 5.1.1. Application of updated profile file to the phone In order to apply modified profile to the phone, you must reboot the phone. Rebooting procedure is as follows. Phone A ICM 1: NOTIFY Type=reboot 2: 200 OK Phone restart [Figure 4] Phone Profile Update Administrator may use the following command to reboot the phone by force. DUT1/configure# voice reboot station <station number | all> reboot station "<station number | all>" ? (y/n) : y 1. Notify message will be sent to the Phone A from ICM. NOTIFY sip: <phone number>@<phone IP Address> SIP/2.0 Event: scm-profile;version="SAMSUNG-SMG-iBG2016/2.11.0.0";type=reboot;modifier=scm From: sip: < phone number >@<phone IP address>;tag=xxxx To: sip: < phone number >@<phone IP address> Call-ID: ….. CSeq: xxx NOTIFY iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 18 Doc. Code : Version : Old Code : This document is property of . Use or Copy of this document without proper permission from the appropriate technical-document managing department is prohibited. Via: …. Content-Length: 0 2. Phone A returns 200 OK message. 3. Phone restarts. iBG ICM Samsung IP Phone Provisioning Configuration Guide Page 19