User manual POLYCOM SOUNDPOINT IP500

Administrator Guide SoundPoint®/SoundStation® IP SIP Version 1.4.x 17 November 2004 Copyright © 2004 Polycom, Inc. All rights reserved. Notices 1. Specifications subject to change without notice. Polycom, Inc. 1565 Barber Lane, Milpitas CA 95035, USA www.polycom.com Part Number: 1725-11518-140 Rev A Copyright © 2004 Polycom, Inc. All rights reserved. Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents Table of Contents 1 Overview ......................................................... 1 2 Installation and Operation ................................. 3 2.1 Installation Models ..................................................3 2.2 Installation Process..................................................4 2.2.1 Basic Network Setup....................................................................................................................... 4 2.2.1.1 DHCP or Manual TCP/IP Setup..............................................................................................5 2.2.1.2 Local User Interface Setup Menus ..........................................................................................6 2.2.1.3 Reset to Factory Defaults......................................................................................................9 2.2.2 Application Configuration................................................................................................................ 9 2.2.2.1 Centralized Configuration......................................................................................................10 2.2.2.2 Local Phone Configuration.....................................................................................................15 3 Features .......................................................... 17 3.1 Basic Features .........................................................17 3.1.1 Call Log ......................................................................................................................................... 17 3.1.2 Call Timer ...................................................................................................................................... 17 3.1.3 Call Waiting ................................................................................................................................... 18 3.1.4 Called Party Identification............................................................................................................... 18 3.1.5 Calling Party Identification.............................................................................................................. 18 3.1.6 Missed Call Notification................................................................................................................... 18 3.1.7 Configurable Feature Keys.............................................................................................................. 19 3.1.8 Connected Party Identification ........................................................................................................ 23 3.1.9 Context Sensitive Volume Control.................................................................................................... 23 3.1.10 Customizable Audio Sound Effects ................................................................................................. 23 3.1.11 Message Waiting Indication .......................................................................................................... 24 3.1.12 Distinctive Incoming Call Treatment............................................................................................... 24 3.1.13 Distinctive Ringing........................................................................................................................ 25 3.1.13 Distinctive Call Waiting ................................................................................................................. 25 3.1.14 Do-Not-Disturb............................................................................................................................. 26 3.1.15 Handset, Headset, and Speakerphone ........................................................................................... 26 3.1.16 Local Contact Directory ................................................................................................................. 27 3.1.16.1 Local Contact Directory File Format.......................................................................................28 3.1.17 Local Digit Map ............................................................................................................................ 30 Copyright © 2004 Polycom, Inc. i Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 3.1.18 Microphone Mute ......................................................................................................................... 30 3.1.19 Multiple Call Appearances............................................................................................................. 30 3.1.20 Shared Call Appearances .............................................................................................................. 31 3.1.21 Bridged Line Appearances............................................................................................................. 32 3.1.22 Customizable Fonts and Indicators................................................................................................. 33 3.1.23 Soft Key-Driven User Interface...................................................................................................... 34 3.1.24 Speed Dial ................................................................................................................................... 34 3.1.25 Time and Date Display.................................................................................................................. 35 3.1.26 Idle Display Animation ................................................................................................................. 36 3.2 Call Management Features........................................37 3.2.1 Automatic Off-hook Call Placement ................................................................................................. 37 3.2.2 Call Hold........................................................................................................................................ 37 3.2.3 Call Transfer .................................................................................................................................. 38 3.2.4 Three-Way Conference, Local or Centralized .................................................................................... 38 3.2.5 Call Diversion (Call Forward) .......................................................................................................... 38 3.2.6 Directed Call Pick-up ...................................................................................................................... 39 3.2.7 Group Call Pick-up.......................................................................................................................... 40 3.2.8 Call Park / Retrieve ....................................................................................................................... 40 3.2.9 Last Call Return.............................................................................................................................. 41 3.3 Audio Processing Features ........................................41 3.3.1 Low-Delay Audio Packet Transmission ............................................................................................. 41 3.3.2 Jitter Buffer and Packet Error Concealment ..................................................................................... 41 3.3.3 Local Conference Mixing................................................................................................................. 42 3.3.4 Voice Activity Detection (VAD)......................................................................................................... 42 3.3.5 DTMF Tone Generation ................................................................................................................... 43 3.3.6 DTMF Event RTP Payload ................................................................................................................ 43 3.3.7 Acoustic Echo Cancellation (AEC) ..................................................................................................... 44 3.3.8 Audio Codecs.................................................................................................................................. 44 3.3.9 Background Noise Suppression (BNS).............................................................................................. 45 3.3.10 Comfort Noise Fill......................................................................................................................... 45 3.3.11 Automatic Gain Control (AGC)....................................................................................................... 45 3.4 Presence and Instant Messaging Features ...................45 3.4.1 Presence ........................................................................................................................................ 45 3.4.2 Instant Messaging .......................................................................................................................... 46 3.5 Localization Features ...............................................46 3.5.1 Multilingual User Interface ............................................................................................................. 46 ii Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 3.5.2 Downloadable Fonts ....................................................................................................................... 48 3.5.3 Synthesized Call Progress Tones...................................................................................................... 48 3.6 Advanced Server Features ........................................49 3.6.1 Voicemail Integration ..................................................................................................................... 49 3.6.2 Multiple Registrations..................................................................................................................... 50 3.6.3 ACD login / logout ......................................................................................................................... 52 3.6.4 ACD agent available / unavailable.................................................................................................. 53 3.6.5 Server Redundancy ........................................................................................................................ 53 3.6.5.1 DNS SIP Server Name Resolution...........................................................................................54 3.7 Accessory Internet Features.......................................54 3.7.1 MicroBrowser ................................................................................................................................. 54 3.8 Security Features .....................................................54 3.8.1 Local User and Administrator Privilege Levels.................................................................................. 54 3.8.2 Incoming Signaling Validation......................................................................................................... 55 4 Optimization .................................................... 57 4.1 Ethernet Switch .......................................................57 4.2 Application Network Setup .......................................57 4.2.1 RTP Ports ....................................................................................................................................... 57 4.2.2 Working with Network Address Translation (NAT) ............................................................................ 58 4.3 Updating and Rebooting...........................................59 4.4 Event Logging .........................................................60 4.5 Audio Quality Issues and VLANs ................................61 4.5.1 IP TOS ........................................................................................................................................... 62 4.5.2 IEEE 802.1p/Q............................................................................................................................... 62 4.5.3 RTCP Support ................................................................................................................................. 63 4.6 Configuration Files...................................................65 4.6.1 Core Configuration - ipmid.cfg ........................................................................................................ 65 4.6.1.1 Localization .................................................................................................65 4.6.1.2 User Preferences ..................................................................................69 4.6.1.3 Tones .................................................................................................................70 4.6.1.4 Sampled Audio for Sound Effects ..............................................................72 4.6.1.5 Sound Effects ...........................................................................................73 4.6.1.6 Voice Settings ......................................................................................................78 4.6.1.7 Quality of Service ..................................................................................................86 Copyright © 2004 Polycom, Inc. iii Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 4.6.1.8 Basic TCP/IP .....................................................................................................88 4.6.1.9 Web Server ........................................................................................................91 4.6.1.10 Call Handling Configuration .....................................................................................92 4.6.1.11 Directory .......................................................................................................93 4.6.1.12 Fonts ..................................................................................................................94 4.6.1.13 Keys ..................................................................................................................96 4.6.1.14 Bitmaps .........................................................................................................100 4.6.1.15 Indicators .....................................................................................................100 4.6.1.16 Event Logging .................................................................................................103 4.6.1.17 Security .........................................................................................................106 4.6.1.18 Provisioning ..............................................................................................107 4.6.1.19 RAM Disk ......................................................................................................107 4.6.1.20 Request ..........................................................................................................108 4.6.1.21 Feature ...........................................................................................................109 4.6.1.22 Resource .......................................................................................................110 4.6.1.23 MicroBrowser ..........................................................................................111 4.6.2 SIP Configuration - sip.cfg .............................................................................................................. 113 4.6.2.1 Protocol ...........................................................................................................113 4.6.3 Per-phone Configuration - phone1.cfg............................................................................................. 121 4.6.3.1 Registration ............................................................................................................121 4.6.3.2 Calls ......................................................................................................................123 4.6.3.3 Diversion .............................................................................................................124 4.6.3.4 Dial Plan ..........................................................................................................126 4.6.3.5 Messaging ............................................................................................................128 4.6.3.6 Network Address Translation .....................................................................................129 5 Session Initiation Protocol (SIP)........................... 131 5.1 Basic Protocols ........................................................131 5.1.1 RFC and Internet Draft Support....................................................................................................... 131 5.1.2 Request Support............................................................................................................................. 131 5.1.3 Header Support.............................................................................................................................. 132 5.1.4 Response Support........................................................................................................................... 134 5.1.4.1 1xx Responses - Provisional ..................................................................................................134 5.1.4.2 2xx Responses - Success ......................................................................................................134 5.1.4.3 3xx Responses - Redirection..................................................................................................135 5.1.4.4 4xx Responses - Request Failure............................................................................................135 5.1.4.5 5xx Responses - Server Failure ..............................................................................................136 5.1.4.6 6xx Responses - Global Failure ..............................................................................................136 5.1.5 Hold Implementation...................................................................................................................... 137 5.1.6 Reliability of Provisional Responses................................................................................................. 137 5.1.7 Transfer......................................................................................................................................... 137 5.1.8 Third Party Call Control................................................................................................................... 137 iv Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents 5.2 Protocol Extensions..................................................138 5.2.1 RFC and Internet Draft Support....................................................................................................... 138 5.2.2 Request Support............................................................................................................................. 138 5.2.3 SIP for Instant Messaging and Presence Leveraging Extensions (SIMPLE).......................................... 139 5.2.4 Shared Call Appearance Signaling ................................................................................................... 139 5.2.5 Bridged Line Appearance Signaling ................................................................................................. 139 Copyright © 2004 Polycom, Inc. v Administrator Guide - SoundPoint® IP / SoundStation® IP Table of Contents vi Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Overview 1 Overview This Administrator Guide is for the SIP 1.4.0 software release, and the bootROM 2.6.0 release. SoundPoint® IP and SoundStation® IP are feature-rich, enterprise-class voice communications terminals for Ethernet TCP/IP networks. They are designed to facilitate high-quality audio and text message communications. These phones are endpoints in the overall network topology designed to interoperate with other compatible equipment including application servers, media servers, internetworking gateways, voice bridges, and other endpoints. Remote Boot Server PSTN IDC Internet Remote Application Server Router / Firewall Modem Bank PSTN Gateway 7x E thernet C 7 8 9 1011 12 A 12 34 56 1x 8x 9x 10x 11x 12x 7x 8x 9x 10x 11x 12x 2x 3x A 4x 5x 6x 1x 2x 3x B 4x 5x 6x 7x E thernet C 7 8 9 1011 12 A 12 34 56 1x 8x 9x 10x 11x 12x 7x 8x 9x 10x 11x 12x Ethernet Switches 2x 3x A 4x 5x 6x 1x 2x 3x B 4x 5x 6x 10/100 Ethernet Switch 7x E thernet C 7 8 9 1011 12 A 12 34 5 6 1x 8x 9x 10x 11x 12x 7x 8x 9x 10x 11x 12x 2x 3x A 4x 5x 6x 1x 2x 3x B 4x 5x 6x Voice Bridge Polycom SoundPoint IP 500/600s PC PC IDC 7x E thernet C 7 8 9 1011 12 A 12 34 5 6 1x 8x 9x 10x 11x 12x 7x 8x 9x 10x 11x 12x 2x 3x A 4x 5x 6x 1x 2x 3x B 4x 5x 6x 10/100 Ethernet Hub Local Application Server Local Boot Server PC PC The phones connect physically to a standard office twisted-pair (IEEE 802.3) 10/100 megabytes per second Ethernet LAN and send and receive all data using the same packet-based technology. Since the phone is a data terminal, digitized audio being just Copyright © 2004 Polycom, Inc. 1 Administrator Guide - SoundPoint® IP / SoundStation® IP Overview another type of data from its perspective, the phone is capable of vastly more than traditional business phones. As SoundPoint® IP and SoundStation® IP run the same protocols as your office personal computer, many innovative applications can be developed without resorting to specialized technology. Regardless of the diverse application potential, it is fundamentally a good office phone, providing the productivity enhancing features needed today such as multiple call appearances, full-duplex speakerphone, hold, transfer, conference, forward, voice mail compatibility, and contact directory. 2 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2 Installation and Operation This section describes the basic steps that are needed to make your phone operational. 2.1 Installation Models There are diverse installation models scaling from stand-alone phones to large, centrally provisioned systems with thousands of phones. For any size system, the phones can be centrally provisioned from a boot server via a system of global and per-phone configuration files. To augment the central provisioning model, or as the sole method in smaller systems, configuration can be done using user interfaces driven from the phones themselves: both a local setup user interface and a web server-based user interface are available to make configuration changes. Boot Server config overrides directory master config file application binary config files dictionary files user interface resource files 0004f2002999.cfg sip.ld ipmid.cfg sip.cfg phone2999.cfg SoundPointIP-dictionary.xml 0004f2002999-phone.cfg 0004f2002999-directory.cfg 0004f2002999-boot.log 0004f2002999-app.log event log files SoundPoint IP Local User Interface MAC 00:04:f2:00:29:99 Local Web Server A boot server allows global and per-phone configuration to be managed centrally via text XML-format configuration files that are downloaded by the phones at boot time. The boot server also facilitates automated application upgrades, diagnostics, and a measure of fault tolerance. Copyright © 2004 Polycom, Inc. 3 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation The configuration served by the boot server can be augmented by changes made locally on the phone itself or via the phone's built-in web server. If file uploads are permitted, the boot server allows these local changes to be backed up automatically. Polycom recommends the boot server central provisioning model for installations involving more than a few phones. The investment required is minimal in terms of time and equipment, and the benefits are significant. The phones also support dynamic host configuration protocol (DHCP). When set up, DHCP permits plug-and-play TCP/IP network setup. 2.2 Installation Process Regardless of whether or not you will be installing a centrally provisioned system, there are two steps required to get your phones up and running. 1. Basic TCP/IP Network Setup such as IP address and subnet mask. For more information, see 2.2.1 Basic Network Setup on page 4. 2. Application Configuration such as application specific parameters. For more information, see 2.2.2 Application Configuration on page 9. 2.2.1 Basic Network Setup The phones boot up in two phases: · Phase 1: bootROM - a generic program designed to load the application. · Phase 2: application - the SIP phone application. Networking starts in Phase 1. The bootROM application uses the network to query the boot server for upgrades or configuration changes, which is an optional process that will happen automatically when properly deployed. The boot server can be on the local LAN or anywhere on the Internet. The bootROM then loads the configured application. The application will restart networking using most of the parameters established by the bootROM (a DHCP query will be performed by the application). Basic network settings can be changed during Phase 1 using the bootROM's setup menu. A similar, but more sophisticated menu system is present in the application for changing the same network parameters. For more information, see 2.2.1.2 Local User Interface Setup Menus on page 6. 4 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.1.1 DHCP or Manual TCP/IP Setup Basic network settings can be derived from DHCP or entered manually using the phone's LCD-based user interface. Polycom recommends using DHCP where possible to eliminate repetitive manual data entry. The following table shows the manually entered networking parameters that may be overridden by parameters obtained from a DHCP server: Configuration File (Phase 2: application only) priority when more than one source exists Parameter DHCP Option DHCP Local FLASH 1 2 3 IP address subnet mask IP gateway boot server address 1 1 3 See 2.2.1.2.2 DHCP Menu on page 7 42 then 4 2 6 6 15 See 2.2.1.2.2 DHCP Menu on page 7 · · · · - · · · · SNTP server address SNTP GMT offset DNS server IP address alternate DNS server IP address DNS domain VLAN ID · · · · · · · - · · · · · Special Case: Cisco Discovery Protocol (CDP)a overrides Local FLASH which overrides DHCP VLAN Discovery. a. Can be obtained from a connected Ethernet switch if the switch supports CDP. Copyright © 2004 Polycom, Inc. 5 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.1.2 Local User Interface Setup Menus Access to Network Configuration Menu: Phase 1: bootROM The network configuration menu is accessible during the auto-boot countdown of the bootROM phase of operation. Press the Setup soft key to launch the main menu. The network configuration menu is accessible from the main menu. Navigate to Menu>Settings>Network Configuration. This menu is locked by default. Enter the administrator password to unlock. (Factory default password: 456) Phase 2: application Phone network configuration parameters may be edited by means of a main menu and two sub-menus: DHCP Menu and Server Menu. Use the soft keys, the arrow keys, the Sel/ , and the Del/X keys to make changes. Parameters that cannot be changed are read-only due to the value of other parameters. For example, if the DHCP Client parameter is enabled, the Phone IP Addr and Subnet Mask parameters are dimmed or not visible since these are guaranteed to be supplied by the DHCP server (mandatory DHCP parameters) and the statically assigned IP address and subnet mask will never be used in this configuration. 2.2.1.2.1 Main Menu Configuration parameters that may be edited on the main setup menu are described in the table below: Name DHCP Client Possible Valuesa Enabled, Disabled Description If enabled, DHCP will be used to obtain the parameters discussed in 2.2.1.1 DHCP or Manual TCP/IP Setup on page 5. Phone's IP address. Note: Disabled when DHCP client is enabled. Phone's subnet mask. Note: Disabled when DHCP client is enabled. Phone's default router. SNTP server from which the phone will obtain the current time. Phone IP Address dotted-decimal IP address dotted-decimal subnet mask dotted-decimal IP address dotted-decimal IP address OR domain name string Subnet Mask IP Gateway SNTP Address 6 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Name GMT Offset DNS Server DNS Alternate Server DNS Domain CDP VLAN ID Possible Valuesa -12 through +13 dotted-decimal IP address dotted-decimal IP address domain name string Enabled, Disabled Null, 0 through 4095 Description Offset of the local time zone from Greenwich Mean Time in half hour increments. Primary server to which the phone directs Domain Name System queries. Secondary server to which the phone directs Domain Name System queries. Phone's DNS domain. If enabled, the phone will attempt to determine its VLAN ID via the CDP. Phone's 802.1Q VLAN identifier. Note: 4095 = no VLAN tagging a. A parameter value of "???" indicates that the parameter has not yet been set and saved in the phone's configuration. Any such parameter should have its value set before continuing. The DHCP and Server sub-menus may be accessed from the main setup menu. 2.2.1.2.2 DHCP Menu The DHCP menu is accessible only when the DHCP client is enabled. DHCP configuration parameters are described in the following table: Possible Values 1 through 600 Option 66 Name Timeout Boot Server Description Number of seconds the phone waits for secondary DHCP Offer messages before selecting an offer. Option 66: The phone will look for option number 66 (string type) in the response received from the DHCP server. The DHCP server must be configured to send the boot server address in option 66. Custom: The phone will look for the option number specified by the "Boot Server Option" parameter (below), and the type specified by the "Boot Server Option Type" parameter (below) in the response received from the DHCP server. Static: The phone will use the boot server configured via the Server Menu. For more information, see 2.2.1.2.3 Server Menu on page 8. Custom+Opt.66: The phone will first use the custom option if present or use Option 66 if the custom option is not present. Custom Static Custom+Opt.66 Copyright © 2004 Polycom, Inc. 7 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Name Boot Server Option Possible Values 128 through 254 (Cannot be the same as VLAN ID Option) IP Address, String Description When the boot server parameter is set to Custom, this parameter specifies the DHCP option number in which the phone will look for its boot server. When the Boot Server parameter is set to Custom, this parameter specifies the type of the DHCP option in which the phone will look for its boot server. No VLAN discovery via DHCP. Use predefined DHCP private option values of 128, 144, 157 and 191. If this is used, the VLAN ID Option field will be ignored. Use the number specified in the VLAN ID Option field as the DHCP private option value. The DHCP private option value (when VLAN Discovery is set to Custom). Default is 129. Boot Server Option Type VLAN Discovery Disabled Fixed Custom VLAN ID Option 128 through 254 (Cannot be the same as Boot Server Option) 2.2.1.2.3 Server Menu Name Server Type Possible Values FTP, Trivial FTPa Description When set to FTP, the phone will use the File Transfer Protocol (FTP) to obtain configuration and phone application files from the boot server. When set to Trivial FTP, the phone will use the Trivial File Transfer Protocol (TFTP) to obtain configuration and phone application files from the boot server. Server Address dotted-decimal IP address OR domain name string The boot server to use if the DHCP client is disabled, or the DHCP server does not send a boot server option, or the Boot Server parameter is set to Static. When the Server Type parameter is set to FTP, this is the user name used when the phone logs into the FTP server. When the Server Type parameter is set to FTP, this is the password used when the phone logs in to the FTP server. FTP Userb any string FTP Passwordb any string a. Using TFTP will make management of the phone more difficult. For more information, see 2.2.2.1.1 FTP vs. TFTP on page 10. 8 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation b. The FTP server user name and FTP password should be changed from the default values. Note that FTP is an insecure protocol and the user chosen should have very few privileges on the server. 2.2.1.3 Reset to Factory Defaults The basic network configuration referred to in the preceding sections can be reset to factory defaults. To perform this function on the IP 300, 500 and 600, simultaneously press and hold the 4, 6, 8 and * dial pad keys until the password prompt appears. To perform this function on the IP 4000, simultaneously press and hold the 6, 8 and * dial pad keys until the password prompt appears. Enter the administrator password to initiate the reset. This will reset the administrator password as well. 2.2.2 Application Configuration While it is possible to make calls with the phone using its default configuration, most installations will require some basic configuration changes to get things running optimally. These changes can be made using the central boot server model, if a boot server has been set up, or some, but not all changes can be made using the phone's internal configuration web server. Advantages of using a boot server: 1. The centralized repository for application images and configuration files permits application updates and coordinated configuration parameters. 2. Some parameters can only be modified using boot server configuration files. 3. The multilingual feature requires boot server-resident dictionary files. 4. The customized sound effect wave files require a boot server. 5. When file uploads are permitted, the boot server is the repository for: · boot process and application event log files - very effective when diagnosing system problems · local configuration changes via the -phone.cfg boot server configuration overrides file - the phone treats the boot server copy as the original when booting · per-phone contact directory named -directory.cfg 6. The boot server copy of the application images and configuration files can be used to "repair" a damaged phone configuration in the same way that system repair disks work for PCs. The following sections discuss the available configuration options. Copyright © 2004 Polycom, Inc. 9 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation 2.2.2.1 Centralized Configuration The phone application consists of an executable image file (sip.ld) and one or more XML-format configuration files. In the centrally provisioned model, these files are stored on a boot server and cached in the phone. If the boot server is available at boot time, the phone will automatically synchronize its configuration cache with the boot server: bootROM image, application executable, and configuration files are all upgraded this way. The phone requires that a SNTP server be properly configured for this feature to work optimally. 2.2.2.1.1 FTP vs. TFTP Note If the phone has bootROM version 2.6.0 or greater, the following restrictions do not apply. If using a trivial FTP (TFTP) protocol boot server, synchronization with the boot server will be based on file names, not file timestamps, as is the case with FTP. Executable upgrades and changes made to configuration files will not be recognized by the phone unless their names are changed. Example: file.ld ipmid.cfg file01.ld (an upgrade to SIP 1.0.1) ipmid01.cfg The master configuration file, which references the other files and is always downloaded and parsed by the phone, will need to change to reflect these name changes. Polycom does not recommend TFTP boot servers for actively managed systems. File name management is the responsibility of the System Administrator. 2.2.2.1.2 Configuration Files The phone configuration files consist of master configuration files and application configuration files. 2.2.2.1.2.1 Master Configuration Files Central provisioning requires that an XML-format master configuration file be located in the home directory on the boot server. Per-phone Master Configuration File If per-phone customization is required (for all applications that require per-phone customization), the file should be named .cfg, where Ethernet address 10 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation is the Ethernet MAC address of the phone in question. For A-F hexadecimal digits, use lower case only, for example, 0004f200106c.cfg. The Ethernet address can be viewed using the About soft key during the auto-boot countdown of the bootROM or via the Menu>System Status>General menu in the application. It is also printed on a label on the back of the phone. Default Master Configuration File For systems in which the configuration is identical for all phones (no per-phone .cfg files), the default master configuration file may be used to set the configuration for all phones. The file named 000000000000.cfg (<12 zeros>.cfg) is the default master configuration file and it is recommended that one be present on the boot server. If a phone does not find its own .cfg file, it will use this one, and establish a baseline configuration. This file is part of the standard Polycom distribution of configuration files. It should be used as the template for the .cfg files. The default SIP master configuration file, 000000000000.cfg, is shown below: Example: < ? x m l v e r s io n = " 1 .0 " s t a n d a lo n e = " y e s " ? > < ! - - D e fa u lt M a s te r S IP C o n fig u ra tio n F ile - - > < ! - - E d it a n d re n a m e th is file to < E th e rn e t-a d d re s s > .c fg p h o n e .- - > < ! - - $ R e v is io n : 1 .2 4 $ $ D a te : M a r 2 6 2 0 0 3 1 1 :5 9 :0 2 < A P P L IC A T IO N A P P _ F IL E _ P A T H = " s ip .ld " C O N F IG _ F I L E S = " p h o n e 1 .c f g , s ip .c f g , ip m id .c f g " M IS C _ F IL E S = " " L O G _ F IL E _ D IR E C T O R Y = " " / > fo r e a c h $ --> Master configuration files contain four XML attributes: APP_FILE_PATH CONFIG_FILES MISC_FILES LOG_FILE_DIRECTORY The path name of the application executable. Has a maximum length of 127 characters. A comma-separated list of configuration files. Has a maximum length of 511 characters, including commas and white space. A comma-separated list of other required files.a An alternative directory to use for log files if required. This is left blank by default. a. MISC_FILES is not used for the SIP application, but is used for the MGCP application. Copyright © 2004 Polycom, Inc. 11 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Note The order of the configuration files listed in CONFIG_FILES is significant. · The files are processed in the order listed (left to right). · The same parameters may be included in more than one file. · The parameter found first in the list of files will be the one that is effective. This provides a convenient means of overriding the behavior of one or more phones without altering the baseline configuration files for an entire system. 2.2.2.1.2.2 Application Configuration Files Typically, the files are arranged in the following manner although parameters may be moved around within the files and the file names themselves can be changed as needed. Per-phone settings Application settings Core settings phoneXXXX.cfg sip.cfg ipmid.cfg Category Core Description Contain parameters that affect the basic operation of the phone such as voice codecs, gains, and tones. All phones in an installation usually share this category of files. Contain parameters that dictate performance of a particular phone application. Typical parameters include the IP address of an application server. All phones in an installation usually share application-specific files. This file would normally be modified from Polycom templates. Example ipmid.cfg Applicationspecific sip.cfg, mgcp.cfg User Contain parameters unique to a particular phone user. Typical parameters include: · · display name unique addresses phone1.cfg Each phone in an installation usually has its own customized version of user files derived from Polycom templates. 12 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation These application configuration files dictate the behavior of the phone once it is running the executable specified in the master configuration file. Important Configuration files should only be modified by a knowledgeable System Administrator. Applying incorrect parameters may render the phone unusable. 2.2.2.1.3 Deploying a Boot Server for the Phones The following table describes the steps required for successful deployment of a boot server for SoundPoint® IP and SoundStation® IP phones. These instructions assume Copyright © 2004 Polycom, Inc. 13 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation an FTP protocol boot server. For more information on TFTP boot servers, see 2.2.2.1.1 FTP vs. TFTP on page 10. Step: 1. Set-up FTP Server: Instructions: Install FTP server application or locate suitable existing server. Use RFC-compliant FTP servers. The following FTP servers have been tested with SoundPoint® IP and SoundStation® IP and are known to work acceptably: · Linux: ProFTPd 1.2.2 through 1.2.9 rc2p, ftpdbsd-0.3.3 (Linux port), we-ftpd 2.6.0 Note: Typically all phones are configured with the same FTP account, but the FTP account provides a means of conveniently partitioning the configuration. Give each account an unique home directory on the server and change the configuration on an account-by-account basis. 2. Copy all files: · Windows 2000 Server: IIS 5.0, WFTPD 2.03 Create account and home directory.a Copy all files from the distribution.zip file to the phone home directory. Maintain the same folder hierarchy. Obtain a list of phone Ethernet addresses (barcoded label on underside of phone). Create per-phone phoneXXXX.cfg and .cfg files by using the 00000000000.cfg and phone1.cfg files from the distribution as templates. Edit contents of phoneXXXX.cfg as appropriate. For example, edit the registration parameters. Edit the CONFIG_FILES attribute of the .cfg files so that it references the appropriate phoneXXXX.cfg file. (Replace the reference to phone1.cfg with phoneXXXX.cfg.) 3. Create per-phone configuration filesb: 4. 5. Edit .cfg: Edit ipmid.cfg: See 4.6.2 SIP Configuration - sip.cfg on page 113, particularly for SIP server address. See 4.6.1 Core Configuration - ipmid.cfg on page 65. Most of the default settings are typically adequate, however, if overriding SNTP settings are not available via DHCP, the SNTP GMT offset and (possibly) the SNTP server address will need to be edited for the correct local conditions. Changing the default daylight savings parameters will likely be necessary outside of North American locations. (Optional) Disable the local web (HTTP) server or alter its signalling port if local security policy dictates. Change the default location settings: · · user interface language time and date format 14 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation Step: 6. Decide on FTP server security policy: Instructions: Polycom recommends allowing file uploads to the FTP server where the security environment permits. This allows event log files to be uploaded and changes made by the phone user to the configuration (via the web server and local user interface) and changes made to the directory to be backed up. For organizational purposes, configuring a separate log file directory is recommended, but not required (see LOG_FILE_DIRECTORY in 2.2.2.1.2.1 Master Configuration Files on page 10). File permissions should give the minimum access required, and the account used should have no other rights on the server. The phone's FTP account needs to be able to add files to which it can write in the log file directory and the root directory. It must also be able to list files in all directories mentioned in the [mac].cfg file. All other files that the phone needs to read, such as the application executable and the standard configuration files, should be made read-only via file server file permissions. See 2.2.1 Basic Network Setup on page 4. To reboot phones manually, press and hold the following keys simultaneously until a confirmation tone is heard or for about three seconds: IP 300: Volume-, Volume+, Hold and Redial IP 500: Volume-, Volume+, Hold, and Messages IP 600: Volume-, Volume+, Mute, and Messages IP 4000: *, #, Volume+, and Select Monitor the boot server event log and the uploaded event log files (if permitted): Ensure that the configuration process completed correctly. Start making calls! 7. Reboot phones after configuring their boot server via DHCP or statically: a. The FTP account name and password must match those configured in the phones themselves. Defaults are: name: PlcmSpIp, password: PlcmSpIp b. This step may be omitted if per-phone configuration is not needed. 2.2.2.2 Local Phone Configuration As the only method of modifying phone configuration or as a distributed method of augmenting a centralized provisioning model, a local phone-based configuration web server is available, unless disabled via ipmid.cfg. For more information, see 4.6.1.9 Web Server on page 91. The phone's local user interface also permits Copyright © 2004 Polycom, Inc. 15 Administrator Guide - SoundPoint® IP / SoundStation® IP Installation and Operation many application settings to be modified, such as SIP server address or ring type or regional settings such as time/date format and language. Local Web Server Access Point your web browser to http:///. Configuration pages are accessible from the menu along the top banner. The web server will issue an authentication challenge to all pages except for the home page. Credentials are (case sensitive): · · Local Settings Menu Access User Name: Polycom Password: The administrator password is used for this. Some items in the Settings menu are locked to prevent accidental changes. To unlock these menus, enter the user or administrator passwords. The administrator password can be used anywhere that the user password is used. Factory default passwords are: · · User password: 123 Administrator password: 456 Passwords: Network Configuration Authentication Reset User Settings Requires administrator password. Requires user password. Requires user password. Changes made via the web server or local user interface are stored internally as overrides. These overrides take precedence over settings contained in the configuration obtained from the boot server that existed previously within the phone. If the boot server permits uploads, these override setting will be saved in a file called -phone.cfg on the boot server. Important Local configuration changes will continue to override the boot server-derived configuration until deleted via the Reset User Settings menu selection. 16 Copyright © 2004 Polycom, Inc. Administrator Guide - SoundPoint® IP / SoundStation® IP Features 3 Features This section describes the many features and corresponding administration points of SoundPoint® IP and SoundStation® IP. References are made frequently to 4.6 Configuration Files on page 65. 3.1 Basic Features 3.1.1 Call Log The phone maintains a call log. The log: · contains call information such as remote party identification, time and date, and call duration, · allows for convenient redialing of previous outgoing calls and for returning incoming calls, · can be used to save contact information from call log entries to the contact directory. The call log is stored in volatile memory and is maintained automatically by the phone in three separate lists; Missed Calls, Received Calls and Placed Calls. The call lists can be cleared manually by the user and will be erased on reboot. Central (boot server) Configuration File: ipmid.cfg Enable or disable all call lists or individual call lists. · For more information, see 4.6.1.21 Feature on page 109. Local Web Server (if enabled) Local Telephone User Interface None. None. 3.1.2 Call Timer A call timer is provided on the display. A separate call timer is maintained for each distinct call in progress. Copyright © 2004 Polycom, Inc. 17 Administrator Guide - SoundPoint® IP / SoundStation® IP Features 3.1.3 Call Waiting When an incoming call arrives while the user is active on another call, the incoming call is presented to the user visually on the LCD display. A configurable sound effect such as the familiar call-waiting beep will be mixed with the active call audio as well. 3.1.4 Called Party Identification The phone displays and logs the identity of the remote party specified for outgoing calls. This is the party that the user intends to connect with. 3.1.5 Calling Party Identification The phone displays the caller identity, derived from the network signalling, when an incoming call is presented. For calls from parties for which a directory entry exists, the local name assigned to the directory entry may optionally be substituted. Central (boot server) Configuration File: ipmid.cfg Specify whether or not to use directory name substitution. · For more information, see 4.6.1.2 User Preferences on page 69. Web Server (if enabled) Specify whether or not to use directory name substitution. Navigate to: http:///coreConf.htm#us Changes are saved to local flash and backed up to -phone.cfg on the boot server. Changes will permanently override global settings unless deleted via the Reset User Settings menu selection. Local Local Telephone User Interface