Polycom 1725-11530-200 User Manual

Administrator’s Guide

SoundPoint®/SoundStation® IP SIP

Version 2.0

August 2006

Notices

1. Specifications subject to change without notice.

Polycom, Inc.

1565 Barber Lane, Milpitas CA 95035, USA

www.polycom.com

Part Number: 1725-11530-200 Rev A1

Administrator’s Guide - SoundPoint® IP / SoundStation® IP 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....................................................................................................................... 5

2.2.1.1 DHCP or Manual TCP/IP Setup..............................................................................................5

2.2.1.2 Provisioning File Transfer ......................................................................................................6

2.2.1.3 Local User Interface Setup Menus ..........................................................................................8

2.2.1.4 Reset to Factory Defaults......................................................................................................12

2.2.2 Application Configuration................................................................................................................ 13

2.2.2.1 Centralized Configuration......................................................................................................13

2.2.2.2 Local Phone Configuration.....................................................................................................22

2.2.3 Management of File Encryption and Decryption............................................................................... 23

2.2.3.1 Changing the Key on the Phone.............................................................................................24

3 Features .......................................................... 27

3.1 Basic Features.........................................................27

3.1.1 Call Log ......................................................................................................................................... 27

3.1.2 Call Timer ...................................................................................................................................... 27

3.1.3 Call Waiting ................................................................................................................................... 28

3.1.4 Called Party Identification............................................................................................................... 28

3.1.5 Calling Party Identification.............................................................................................................. 28

3.1.6 Missed Call Notification................................................................................................................... 28

3.1.7 Configurable Feature Keys.............................................................................................................. 29

3.1.8 Connected Party Identification ........................................................................................................ 33

3.1.9 Context Sensitive Volume Control.................................................................................................... 34

3.1.10 Customizable Audio Sound Effects................................................................................................. 34

3.1.11 Message Waiting Indication .......................................................................................................... 35

3.1.12 Distinctive Incoming Call Treatment............................................................................................... 35

3.1.13 Distinctive Ringing........................................................................................................................ 35

3.1.14 Distinctive Call Waiting ................................................................................................................. 36

3.1.15 Do-Not-Disturb............................................................................................................................. 36

3.1.16 Handset, Headset, and Speakerphone........................................................................................... 37

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Table of Contents

3.1.17 Local Contact Directory................................................................................................................. 38

3.1.17.1 Local Contact Directory File Format.......................................................................................39

3.1.18 Local Digit Map............................................................................................................................ 40

3.1.19 Microphone Mute ......................................................................................................................... 41

3.1.20 Multiple Line Keys per Registration ............................................................................................... 41

3.1.21 Multiple Call Appearances............................................................................................................. 42

3.1.22 Shared Call Appearances .............................................................................................................. 43

3.1.23 Bridged Line Appearances............................................................................................................. 45

3.1.24 Busy Lamp Field........................................................................................................................... 47

3.1.25 Customizable Fonts and Indicators................................................................................................. 47

3.1.26 Soft Key-Driven User Interface...................................................................................................... 48

3.1.27 Speed Dial ................................................................................................................................... 48

3.1.28 Time and Date Display.................................................................................................................. 49

3.1.29 Idle Display Animation ................................................................................................................. 51

3.2 Call Management Features........................................51

3.2.1 Automatic Off-hook Call Placement................................................................................................. 51

3.2.2 Call Hold........................................................................................................................................ 52

3.2.3 Call Transfer .................................................................................................................................. 52

3.2.4 Three-Way Conference, Local or Centralized.................................................................................... 53

3.2.5 Call Diversion (Call Forward) .......................................................................................................... 54

3.2.6 Directed Call Pick-up ...................................................................................................................... 54

3.2.7 Group Call Pick-up.......................................................................................................................... 55

3.2.8 Call Park / Retrieve ....................................................................................................................... 55

3.2.9 Last Call Return.............................................................................................................................. 56

3.3 Audio Processing Features ........................................56

3.3.1 Low-Delay Audio Packet Transmission............................................................................................. 56

3.3.2 Jitter Buffer and Packet Error Concealment ..................................................................................... 56

3.3.3 Voice Activity Detection................................................................................................................... 57

3.3.4 DTMF Tone Generation ................................................................................................................... 58

3.3.5 DTMF Event RTP Payload ................................................................................................................ 58

3.3.6 Acoustic Echo Cancellation (AEC) ..................................................................................................... 58

3.3.7 Audio Codecs.................................................................................................................................. 59

3.3.8 Background Noise Suppression (BNS).............................................................................................. 60

3.3.9 Comfort Noise Fill........................................................................................................................... 60

3.3.10 Automatic Gain Control (AGC)....................................................................................................... 60

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Table of Contents

3.4 Presence and Instant Messaging Features ...................60

3.4.1 Presence........................................................................................................................................ 60

3.4.2 Instant Messaging .......................................................................................................................... 61

3.5 Localization Features ...............................................61

3.5.1 Multilingual User Interface ............................................................................................................. 61

3.5.2 Downloadable Fonts ....................................................................................................................... 63

3.5.3 Synthesized Call Progress Tones...................................................................................................... 63

3.6 Advanced Server Features ........................................64

3.6.1 Voice Mail Integration..................................................................................................................... 64

3.6.2 Multiple Registrations..................................................................................................................... 66

3.6.3 ACD login / logout ......................................................................................................................... 68

3.6.4 ACD agent available / unavailable.................................................................................................. 68

3.6.5 Server Redundancy ........................................................................................................................ 68

3.6.5.1 DNS SIP Server Name Resolution...........................................................................................69

3.6.6 Microsoft® Office Live Communications Server 2005 Integration .................................................... 69

3.6.6.1 Configuration File Changes....................................................................................................71

3.7 Accessory Internet Features.......................................73

3.7.1 MicroBrowser................................................................................................................................. 73

3.8 Security Features.....................................................73

3.8.1 Local User and Administrator Privilege Levels.................................................................................. 73

3.8.2 Custom Certificates......................................................................................................................... 74

3.8.3 Incoming Signaling Validation......................................................................................................... 74

3.8.4 Configuration File Encryption.......................................................................................................... 75

4 Optimization .................................................... 77

4.1 Ethernet Switch .......................................................77

4.2 Application Network Setup .......................................77

4.2.1 Real-Time Transport Protocol Ports.................................................................................................. 77

4.2.2 Working with Network Address Translation...................................................................................... 78

4.3 Updating and Rebooting...........................................79

4.4 Event Logging .........................................................80

4.5 Audio Quality Issues and VLANs ................................81

4.5.1 IP TOS ........................................................................................................................................... 81

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Table of Contents

4.5.2 IEEE 802.1p/Q............................................................................................................................... 82

4.5.3 RTCP Support ................................................................................................................................. 83

4.6 Configuration Files...................................................84

4.6.1 SIP Configuration - sip.cfg .............................................................................................................. 84

4.6.1.1 Protocol <volpProt/>...........................................................................................................85

4.6.1.2 Dial Plan <dialplan/>..........................................................................................................94

4.6.1.3 Localization <localization/> .................................................................................................95

4.6.1.4 User Preferences <user_preferences/> ..................................................................................98

4.6.1.5 Tones <tones/> .................................................................................................................99

4.6.1.6 Sampled Audio for Sound Effects <sampled_audio/> ..............................................................101

4.6.1.7 Sound Effects <sound_effects/>...........................................................................................103

4.6.1.8 Voice Settings <voice/> ......................................................................................................108

4.6.1.9 Quality of Service <QOS/> ..................................................................................................118

4.6.1.10 Basic TCP/IP <TCP_IP/>...................................................................................................121

4.6.1.11 Web Server <HTTPD/>......................................................................................................125

4.6.1.12 Call Handling Configuration <call/>.....................................................................................125

4.6.1.13 Directory <directory/>.......................................................................................................128

4.6.1.14 Presence <presence/>.......................................................................................................129

4.6.1.15 Fonts <font/>..................................................................................................................129

4.6.1.16 Keys <keys/>..................................................................................................................132

4.6.1.17 Bitmaps <bitmaps/>.........................................................................................................133

4.6.1.18 Indicators <indicators/>....................................................................................................134

4.6.1.19 Event Logging <logging/> .................................................................................................137

4.6.1.20 Security <security/> .........................................................................................................140

4.6.1.21 Provisioning <provisioning/>..............................................................................................142

4.6.1.22 RAM Disk <RAMdisk/>......................................................................................................142

4.6.1.23 Request <request/>..........................................................................................................143

4.6.1.24 Feature <feature/>...........................................................................................................144

4.6.1.25 Resource <resource/>..................................................................................................

.....145

4.6.1.26 MicroBrowser <microbrowser/>..........................................................................................146

4.6.2 Per-phone Configuration - phone1.cfg............................................................................................. 149

4.6.2.1 Registration <reg/> ............................................................................................................149

4.6.2.2 Calls <call/>......................................................................................................................153

4.6.2.3 Diversion <divert/>.............................................................................................................154

4.6.2.4 Dial Plan <dialplan/>..........................................................................................................156

4.6.2.5 Messaging <msg/> ............................................................................................................159

4.6.2.6 Network Address Translation <nat/> .....................................................................................160

4.6.2.7 Attendant <attendant/> ......................................................................................................161

4.6.2.8 Roaming Buddies <roaming_buddies/>.................................................................................161

4.6.2.9 Roaming Privacy <roaming_privacy/>...................................................................................162

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Table of Contents

5 Session Initiation Protocol (SIP)........................... 163

5.1 Basic Protocols ........................................................163

5.1.1 RFC and Internet Draft Support....................................................................................................... 163

5.1.2 Request Support............................................................................................................................. 163

5.1.3 Header Support.............................................................................................................................. 164

5.1.4 Response Support........................................................................................................................... 166

5.1.4.1 1xx Responses - Provisional ..................................................................................................166

5.1.4.2 2xx Responses - Success ......................................................................................................166

5.1.4.3 3xx Responses - Redirection..................................................................................................167

5.1.4.4 4xx Responses - Request Failure............................................................................................167

5.1.4.5 5xx Responses - Server Failure..............................................................................................168

5.1.4.6 6xx Responses - Global Failure ..............................................................................................169

5.1.5 Hold Implementation...................................................................................................................... 169

5.1.6 Reliability of Provisional Responses................................................................................................. 169

5.1.7 Transfer......................................................................................................................................... 169

5.1.8 Third Party Call Control................................................................................................................... 169

5.2 Protocol Extensions..................................................170

5.2.1 RFC and Internet Draft Support....................................................................................................... 170

5.2.2 Request Support............................................................................................................................. 171

5.2.3 SIP for Instant Messaging and Presence Leveraging Extensions ........................................................ 171

5.2.4 Shared Call Appearance Signaling................................................................................................... 171

5.2.5 Bridged Line Appearance Signaling ................................................................................................. 172

6 Appendix 1 ...................................................... 173

6.1 Trusted Certificate Authority List ................................173

6.2 Miscellaneous Administrative Tasks ...........................175

6.2.1 Adding a Background Logo............................................................................................................. 175

7 Appendix 2 ...................................................... 177

7.1 Third Party Software Attribution ................................177

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Table of Contents

Administrator’s Guide’s - SoundPoint® IP / SoundStation® IP Overview

1 Overview

This Administrator Guide is for the SIP 2.0 software release and the bootROM 3.2 release.

Note

Unless specifically described separatel y, the behavior and configuration of the SoundPoint® IP 301 is the same as the 300, the behavior and configuration of the SoundPoint

the behavior and configuration of the SoundPoint

IP 601 is the same as the 600.

SoundPoint® IP and SoundStation® IP are feature-rich, enterprise-class voice communications terminals for Ethernet TCP/IP networks. They are designed to facilitate highquality audio communications. These phones are end points in the overall network topology designed to interoperate with other compatible equipment including application servers, media servers, internetworking gateways, voice bridges, and other end points.

IP 501 is the same as the 500,

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Overview

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 another type of data from its perspective, the phone is capable of vastly more than tra-

ditional 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 provides the productivity enhancing features needed today such as multiple call appearances, full-duplex speakerphone, hold, transfer, conference, forward, voice mail compatibility, and contact directory.

Administrator’s 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 through a system of global and perphone 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.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

A boot server allows global and per-phone configuration to be managed centrally through 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. Multiple redundant boot servers can be configured to improve reliability.

The configuration served by the boot server can be augmented by changes made locally on the phone itself or through 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 advantages of a boot server are:

• Provides a centralized repository for application images and configuration files permits application updates and coordinated configuration parameters.

• Provides security as some parameters can only be modified using boot server configuration files.

• Provides consistency as the multilingual feature requires boot server-resident dictionary files and the customized sound effect wave files require a boot server.

• Provides common file uploads when permitted. The boot server is the repository for:

• boot process and application event log files - very effective when diagnosing system problems,

• local configuration changes through the <Ethernet address>-phone.cfg boot server configuration overrides file - the phone treats the boot server copy as the original when booting,

• per-phone contact directory named <Ethernet address>-directory.cfg.

• Provides a common repository for the application images and configuration files. The boot server copy can be used to “repair” a damaged phone configura tion in the same way that system repair disks work for PCs.

2.2 Installation Process

Regardless of whether or not you will be installing a centrally provisioned system, the following steps are required to get your organization’s phones up and running:

1. Basic TCP/IP Network Setup such as IP address and subnet mask. For more information, refer to 2.2.1 Basic Network Setup on page 5.

2. Application Configuration such as application specific parameters. For more information, refer to

For the detailed steps required in a boot server deployment, refer to 2.2.2.1.2 Boot Server Deployment for the Phones on page 19.

2.2.2 Application Configuration on page 13.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

T o safeguard your files for reliability and backups, you should encrypt them. For more information, refer to 2.2.3 Management of File Encryption and Decryption on page 23.

For the latest information on system requirements, fixed problems, and workarounds, refer to the Release Notes at www.polycom.com/support/voip/ .

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 Session Initiation Protocol (SIP) phone application.

Networking starts in Phase 1. The bootROM application uses the network to query the boot server for upgrades, 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. For more information, refer to 2.2.1.1 DHCP or Manual TCP/IP Setup on page 5.

The bootROM on the phone performs the provisioning functions of downloading the bootROM, the <Ethernet address>.cfg file, and the SIP application and uploading log files. For more information, refer to 2.2.1.2 Provisioning File Transfer on page 6.

Basic network settings can be changed during Phase 1 using the bootROM’s setup menu. A similar menu system is present in the application for changing the same network parameters. For more information, refer to 2.2.1.3 Local User Interface Setup Menus on page 8.

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, or downloaded from configuration files. Contact Polycom Customer Support for more information on this use of configuration files. 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 or configuration file:

Parameter DHCP Option

IP address

DHCP

12 3

•- •

Configuration File (Phase 2: application only)

 priority when more than one source exists 

Local FLASH

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Parameter DHCP Option

subnet mask

IP gateway

boot server address

SIP server address

SNTP server address

SNTP GMT offset

DNS server IP address

alternate DNS server IP

1 3

Refer to

2.2.1.3.2

DHCP Menu

on page 9

151

42 then 4

6 6

address

DNS domain

VLAN ID

Refer to

2.2.1.3.2

DHCP Menu

on page 9

DHCP

(Phase 2: application only)

•- •

Configuration File

•

•- •

Special Case: Cisco Discovery Protocol (CDP)

rides Local FLASH that overrides DHCP VLAN Dis-

covery.

Local FLASH

•

over-

a. For more information on DHCP options, go to http://www.ietf.org/rfc/rfc2132.txt?num-

ber=2132. b. This value is configurable. c. Note that the configuration file value can be configured to override the DHCP value. Refer

to tcpIpApp.sntp.address.overrideDHCP in section 4.6.1.10.2 Time Synchronization

<SNTP/> on page 121. d. Note that the configuration file value can be configured to override the DHCP value. Refer

to tcpIpApp.sntp.gmtOffset.overrideDHCP in section 4.6.1.10.2 Time Synchronization

<SNTP/> on page 121. e. This value can be obtained from a connected Ethernet switch if the switch supports CDP.

2.2.1.2 Provisioning File Transfer

The SIP application performs the provisioning functions of downloading configuration files, uploading and downloading the configuration override file and user directory, and downloading the dictionary and uploading log files.

The protocol that will be used to transfer files from the boot server depends on several factors including the phone model and whether the bootROM or SIP application stage

of provisioning is in progress. TFTP and FTP are supported by all SoundPoint SoundStation® phones. The SoundPoint® IP 301, 430, 501, 600 and 601 and SoundStation® IP 4000 bootROM also supports HTTP, while the SIP application sup-

and

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

ports only the mentioned platforms. If an unsupported protocol is specified, this may result in a defined behavior, see the table below for details of which protocol the phone will use. The “Specified Protocol” listed in the table can be selected in the Server T yp e field or the Server Address can include a transfer protocol, for example http:// usr:pwd@server (refer to 2.2.1.3.3 Server Menu on page 11). The boot server address can be an IP address, domain string name, or URL. The boot server address can also be obtained through DHCP. Configuration file names in the <Ethernet address>.cfg file can include a transfer protocol, for example https://usr:pwd@server/dir/file.cfg. If a user name and password are specified as part of the server address or file name, they will be used only if the server supports them.

Note

A URL should contain forward slashes instead of back slashes and should not contain spaces. Escape characters are not supported. If a user name and password are not specified, the Server User and Server Password will be used (refer to 2.2.1.3.3 Server Menu on page 11).

Protocol used by bootROM Protocol used by SIP Application

Specified Protocol

FTP FTP FTP FTP FTP TFTP TFTP TFTP TFTP TFTP HTTP FTP HTTP HTTP HTTP HTTPS FTP HTTP Not supported. Trans-

300, 500 301, 430, 501,

600, 601, 4000

300, 500 301, 430, 501,

600, 601, 4000

HTTPS

fers will fail.

For downloading the bootROM and application images to the phone, the secure HTTPS protocol is not available. To guarantee software integrity, the bootROM will only download cryptographically signed bootROM or application images. For HTTPS, widely recognized certificate authorities are trusted by the phone and custom certificates can be added (refer to 6.1 Trusted Certificate Authority List on page 173).

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

2.2.1.3 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

Phase 2: application The network configuration menu is accessible from the

main menu. Navigate to Menu>Settings>Advanced>Admin Settings>Network Configuration. Advanced Settings are locked by default. Enter the administrator password to unlock. Note that the factory default password is 456.

Phone network configuration parameters may be edited by means of:

• Main menu. Refer to 2.2.1.3.1 Main Menu on page 8.

• DHCP submenu. Refer to 2.2.1.3.2 DHCP Menu on page 9.

• Server submenu. Refer to 2.2.1.3.3 Server Menu on page 11.

• Ethernet submenu. Refer to 2.2.1.3.4 Ethernet Menu on page 12.

SETUP soft key to launch the main menu.

Use the soft keys, the arrow keys, the Sel/3, and the Del/X keys to make changes. Certain parameters 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.3.1 Main Menu

Configuration parameters that may be edited on the main setup menu are described in the table below:

Name Possible Values

DHCP Client Enabled, Disabled If enabled, DHCP will be used to ob tain the

DHCP Menu Refer to 2.2.1.3.2 DHCP Menu on page 9.

Description

parameters discussed in 2.2.1.1 DHCP or Manual TCP/IP Setup on page 5.

Note: Disabled when DHCP client is disabled.

Phone IP Address dotted-decimal IP

address

Subnet Mask dotted-decimal subnet

mask

Phone’s IP address. Note: Disabled when DHCP client is enabled.

Phone’s subnet mask. Note: Disabled when DHCP client is enabled.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Name Possible Values

IP Gateway dotted-decimal IP

address Server Menu Refer to 2.2.1.3.3 Server Menu on page 11. SNTP Address dotted-decimal IP

address

domain name string GMT Offset -13 through +12 Offset of the local time zone from Greenwich

DNS Server dotted-decimal IP

address DNS Alternate Server dotted-decimal IP

address DNS Domain domain name string Phone’s DNS domain. Ethernet Refer to 2.2.1.3.4 Ethernet Menu on page 12.

EM Power

Enabled, Disabled This parameter is relevant if the phone gets

Description

Phone’s default router.

Simple Network Time Protocol (SNTP) server from which the phone will obtain the current time.

Mean Time (GMT) in half hour increments. Primary server to which the phone directs

Domain Name System (DNS) queries. Secondary server to which the phone directs

Domain Name System queries.

Power over Ethernet (PoE). If enabled, the phone will set power requirements in CDP to 12W so that up to three Expansion Modules (EM) can be powered. If disabled, the phone will set power requirements in CDP to 5W which means no Expansion Modules can be powered (it will not work).

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.

b. Only available on SoundPoint

IP 601 phones.

The DHCP and Server sub-menus may be accessed from the main setup menu.

2.2.1.3.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 Name

Timeout 1 through 600 Number of seconds the phone waits for secondary

Values

Description

DHCP Offer messages before selecting an offer.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Possible Name

Values

Description

Boot Server Option 66

Custom

Static

Custom+Opt.66

Boot Server Option 128 through 254

(Cannot be the

same as VLAN

ID Option)

Option 66: The phone will look for option number 66 (string type) in the response received from the DHCP server. The DHCP server should send address information in option 66 that matches one of the formats described for Server Address in 2.2.1.3.3 Server Menu on page 11. If the DHCP server sends nothing, then the boot server address from flash will be used.

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. If the DHCP server sends nothing, then the boot server address from flash will be used.

Static: The phone will use the boot server configured through the Server Menu. For more information, refer to 2.2.1.3.3 Server Menu on page 11.

Custom+Opt.66: The phone will first use the custom option if present or use Option 66 if the custom option is not present. If the DHCP server sends nothing, then the boot server address from flash will be used.

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.

Boot Server Option Type

VLAN Discovery Disabled No VLAN discovery through DHCP.

VLAN ID Option 128 through 254

IP Address

String

Fixed Use predefined DHCP private option values of 128,

Custom Use the number specified in the VLAN ID Option field

(Cannot be the

same as Boot

Server Option)

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. The IP Address must specify the boot server. The String must match one of the formats described for Server Address in 2.2.1.3.3 Server Menu on page 11

144, 157 and 191. If this is used, the VLAN ID Option field will be ignored.

as the DHCP private option value. The DHCP private option value (when VLAN Discov-

ery is set to Custom).

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

2.2.1.3.3 Server Menu

Name Possible Values Description

Server Type FTP or Trivial FTP or

HTTP or HTTPS

Server Address dotted-decimal IP address

OR domain name string OR URL

All addresses can be followed by an optional directory and optional file name.

Server User any string The user name used when the phone logs into the

The protocol that the phone will use to obtain configuration and phone application files from the boot server. Refer to 2.2.1.2 Provisioning File Transfer on page 6.

The boot server to use if the DHCP client is disabled, the DHCP server does not send a boot server option, or the Boot Server parameter is set to Static. The phone can contact multiple IP addresses per DNS name. These redundant boot servers must all use the same protocol. If a URL is used it can include a user name and password. Refer to 2.2.1.2 Provisioning File Transfer on page 6. A directory and the master configuration file can be specified.

Note: ":", "@", or "/" can be used in the user name or password these characters if they are correctly escaped using the method specified in RFC 1738.

server (if required) for the selected Server Type. Note: If the Server Address is a URL with a user

name, this will be ignored.

Server Pass-

word

File Transmit Tries

Retry Wait 0 to 300

Provisioning Method

any string The password used when the phone logs in to the

1 to 10 Default 3

Default 1

Default or SAS-VP If SAS-VP is selected, provisioning is done (in

server if required for the selected Server Type. Note: If the Server Address is a URL with user

name and password, this will be ignored. The number of attempts to transfer a file. (An

attempt is defined as trying to download the file from all IP addresses that map to a particular domain name.)

The minimum amount of time that must elapse before retrying a file transfer, in seconds. The time is measured from the start of a transfer attempt which is defined as the set of upload/download transactions made with the IP addresses that map to a given boot server's DNS host name. If the set of transactions in an attempt is equal to or greater than the Retry Wait value, then there will be no further delay before the next attempt is started.

For more information, refer to 2.2.2.1.2 Boot Server Deployment for the Phones on page 19.

addition to the normal process).

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Name Possible Values Description

Provisioning

String

a. The server user name and password should be changed from the default values. Note that

for insecure protocols the user chosen should have very few privileges on the server.

b. Not available on SoundPoint

any string The URL used in XML post/response transac-

2.2.1.3.4 Ethernet Menu

Name Possible Values Description

CDP Enabled, Disabled If enabled, the phone will use CDP. It also reports

VLAN ID Null, 0 through 4094 Phone’s 802.1Q VLAN identifier.

LAN

Auto, 10HD, 10FD, 100HD, 100FD

tions. If empty, the configured URL is used. This field is disabled when Provision ing Method

is Default.

IP 300 and SoundPoint® IP 500 phones.

power usage to the switch.

Note: Null = no VLAN tagging The network speed over the Ethernet.

The default value is Auto.

a. Only available on SoundPoint® IP 430 and 601 phones. HD means half duplex and FD

means full duplex.

Auto, 10HD, 10FD, 100HD, 100FD

2.2.1.4 Reset to Factory Defaults

The basic network configuration referred to in the preceding sections can be reset to factory defaults.

To perform this function, do one of the following during the countdown process in the bootROM:

• On all phones except the IP 430 and 4000, simultaneously press and hold the 4, 6, 8 and * dial pad keys until the password prompt appears.

• On the IP 430, simultaneously press and hold the 1, 3, 5 and 7 dial pad keys until the password prompt appears.

• 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. Resetting to factory defaults will also reset the administrator password (factory default password is 456).

The network speed over the Ethernet. The default value is Auto.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

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 optimize your system.

The following sections discuss the available configuration options:

• Centrally provisioned configuration. Refer to 2.2.2.1 Centralized Configuration on page 13.

• Local phone-based configuration. Refer to 2.2.2.2 Local Phone Configuration on page 22.

2.2.2.1 Centralized Configuration

A boot server allows global and per-phone configuration to be managed centrally through XML-format configuration files that are downloaded by the phones at boot time. 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 cache with the boot server: bootROM image, application executable, and configuration files are all upgraded this way.

2.2.2.1.1 Configuration Files

The phone configuration files consist of master configuration file and application configuration files.

2.2.2.1.1.1 Master Configuration Files

Central provisioning requires that an XML-format master configuration file be located on the boot server.

Specified Master Configuration File

The master configuration file can be explicitly specified in the boot server address, for example, http://usr:pwd@server/dir/example1.cfg. The file name must end with “.cfg” and be at least five characters long. If this file cannot be downloaded, the phone will search for the per-phone master configuration file described below.

Per-phone Master Configuration File

If per-phone customization is required (for all applications that require per-phone customization), the file should be named <Ethernet address>.cfg, where Ethernet address is the Ethernet MAC address of the phone in question. For A-F hexadecimal digits, use upper or lower case, for example, 0004f200106c.cfg. The Ethernet address can be viewed using the ABOUT soft key during the auto-boot countdown of the bootROM or through the Menu>Status>Platform>Phone menu in the application. It is also printed

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

on a label on the back of the phone. If this file cannot be downloaded, the phone will search for the default master configuration file described below.

Default Master Configuration File

For systems in which the configuration is identical for all phones (no per-phone <Ethernet address>.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 <Ethernet address>.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 <Ethernet address>.cfg files.

The default master configuration file, 000000000000.cfg, is shown below: Example:

<?xml version=”1.0” standalone=”yes”?>    < APPLICATION APP_FILE_PATH=”sip.ld” CONFIG_FILES=”phone1.cfg, sip.cfg” MISC_FILES=”” LOG FILE DIRECTORY=”” OVERRIDES_DIRECTORY="" CONTACTS_DIRECTORY=""/>

Master configuration files contain six XML attributes:

APP_FILE_PATH The path name of the application executable. It can have a maximum

length of 255 characters. This can be a URL with its own protocol, user name and password, for example http://usr:pwd@server/dir/ sip.ld.

CONFIG_FILES A comma-separated list of configuration files. Each file name has a

maximum length of 255 characters and the list of file names has a maximum length of 2047 characters, including commas and white space. Each configuration file can be specified as a URL with its own protocol, user name and password, for example ftp://usr:pwd@server/ dir/phone2034.cfg.

MISC_FILES A comma-separated list of other required files. Dictionary resource

files listed here will be stored in the phone's flash file system. So if the phone reboots at a time when the boot server is unavailable, it will still be able to load the preferred language.

Note: On the IP 500, there is insufficient room for a language file. Specifying one will cause a reboot loop.

LOG_FILE_DIRECTORY An alternative directory to use for log files if required. A URl can also

be specified. This is blank by default.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

CONTACTS_DIRECTORYAn alternative directory to use for user directory files if required. A

URl can also be specified. This is blank by default.

OVERRIDES_DIRECTORYAn alternative directory to use for configuration overrides files if

required. A URl can also be specified. This is blank by default.

Important

Be aware of the limited permanent storage on the phone(s).

Important

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 changing the baseline configuration files for an entire system.

For more information, refer to the “Configuration File Management on SoundPoint whitepaper at www.polycom.com/support/voip/.

IP Phones”

2.2.2.1.1.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.

Site-specific settings  Refer to the “Configuration File Management on SoundPoint® IP Phones” whitepaper at

www.polycom.com/support/voip/ . Per-phone settings  phoneXXXX.cfg Application settings  sip.cfg

Category Description Example

Application Contains parameters that affect the basic operation of the phone

such as voice codecs, gains, and tones and the IP address of an application server. All phones in an installation usually share this category of files. Polycom recommends that you create another file with your organization’s modifications. If you must change any Polycom templates, back them up first.

sip.cfg

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Category Description Example

User / perphone

Contains parameters unique to a particular phone user. Typical parameters include:

• display name

• unique addresses Each phone in an installation usually has its own customized ver-

sion of user files derived from Polycom templates.

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. The configuration files which accompany a specific release of the SIP software must be used together with that software. Failure to do this may render the phone unusable.

2.2.2.1.1.3 Setting Flash Parameters from Configuration Files

Any field in the bootROM setup menu and the application SIP Configuration menu can be set through a configuration file.

phone1.cfg

A DHCP server can be configured to point the phones to a boot server that has the required configuration files. The new settings will be downloaded by the phones and used to configure them. This removes the need for manual interaction with phones to configure basic settings. This is especially useful for initial installation of multiple phones.

These device settings are detected when the application starts. If the new settings would normally cause a reboot if they were changed in the application Network Configuration menu then they will cause a reboot when the application starts.

Important

The parameters for this feature should be put in separate configuration files to simplify maintenance. Do not add them to existing configuration files (such as sip.cfg). One new configuration file will be required for parameters that should apply to all phones, and individual configuration files will be required for phone-specific parameters such as SIP registration information.

The global device.set parameter must be enabled when the initial installation is done, and then it should be disabled. This prevents subsequent reboots by individual phones triggering a reset of parameters on the phone that may have been tweaked since the initial installation.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Important

This feature is very powerful and should be used with caution. For example, an incorrect setting could set the IP Address of multiple phones to the same value.

Note that some parameters may be ignored, for example if DHCP is enabled it will still override the value set with device.net.ipAddress.

Individual parameters are checked to see whether they are in range, however, the interaction between parameters is not checked. If a parameter is out of range, an error message will appear in the log file and parameter will not be used.

Incorrect configuration could cause phones to get into a reboot loop. For example, server A has a configuration file that specifies that server B should be used, which has a configuration file that specifies that server A should be used.

Polycom recommends that you test the new configuration files on two phones before initializing all phones. This should detect any errors including IP address conflicts.

Name Possible Values Description

device.set 0 or 1

default = 0

device.xxx.yyy.set 0 or 1

default = 0

device.net.ipAddress dotted-decimal IP address Phone's IP address.

device.net.subnetMask dotted-decimal IP address Phone's subnet mask.

device.net.IPgateway dotted-decima l IP address Phone's default router / IP gateway.

If set to 0, do not use any device.xxx.yyy fields to set any parameters. Set this to 0 after the initial installation.

If set to 1, use the device.xxx.yyy fields that have device.xxx.yyy.set = 1. Set this to 1 for the initial installation only.

If set to 0, do not use the device.xxx.yyy value. If set to 1, use the device.xxx.yyy value. For example, if device.net.ipAddress.set = 1, then

set the contents of the device.net.ipAddress field.

Note: This field is not used when DHCP client is enabled.

device.net.vlanId Null, 0 to 4094 Phone’s 802.1Q VLAN identifier.

Note: Null = no VLAN tagging

device.net.cdpEnabled 0 or 1 If set to 1, the phone will attempt to determine its

VLAN ID through the CDP.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Name Possible Values Description

device.dhcp.enabled 0 or 1 For description, refer to 2.2.1.1 DHCP or Manual

TCP/IP Setup on page 5.

device.dhcp.offerTimeout 1 to 600 Number of seconds the phone waits for secondary

DHCP Offer messages before selecting an offer.

device.dhcp.bootSrvUseOpt

device.dhcp.bootSrvOpt 128 to 254 (Cannot be the

device.dhcp.bootSrvOptType

device.dhcp.dhcpVlanDiscUseOpt

device.dhcp.dhcpVlanDiscOpt

device.prov.serverName any string Fo r descri ptions, refer to 2.2.1.3.3 Server Menu device.prov.serverType 0 to 4 device.prov.user any string device.prov.password any string device.prov.appProvType 0 or 1 device.prov.app-

ProvString

0 to 3 For descriptions, refer to 2.2.1.3.2 DHCP Menu

on page 9.

same as VLAN ID Option)

0 or 1

0 to 2

128 to 254 (Cannot be the same as Boot Server Option)

on page 11

any string

device.sntp.serverName any string Can be dotted-decimal IP address or domain name

string. SNTP server from which the phone will obtain the current time

device.sntp.gmtOffset -43200 to 46800 GMT offset in seconds, corresponding to -12 to

+13 hours.

device.dns.serverAddress dotted-decimal IP address Primary server to which the phone directs Domain

Name System queries.

device.dns.altSrvAddress dotted-decimal IP address Secondary server to which the phone directs

Domain Name System queries. device.dns.domain any string The phone’s DNS domain. device.auth.localAdmin-

Password device.auth.localUser-

Password

any string The phone’s local administrator password.

any string The phone user’s local password.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Name Possible Values Description

device.auth.regUserx any string The SIP registration user name for registration x

where x = 1 to 12. device.auth.regPassword any string The SIP registration password for registration x

where x = 1 to 12. device.sec.configEncryp-

tion.key

any string Configuration encryption key that is used for

encryption of configuration files.

2.2.2.1.2 Boot Server Deployment for the Phones

The following table describes the steps required for successful deployment of one or more boot servers for SoundPoint® IP and SoundStation® IP phones (except for SoundPoint® IP 300 and 500 phones). Multiple boot servers can be configured by having the boot server DNS name map to multiple IP addresses. The default number of boot servers is one and the maximum number is eight. The following protocols are supported for redundant boot servers: HTTPS, HTTP, and FTP.

All of the boot servers must be reachable by the same protocol and the content available on them must be identical. The parameters described in section 2.2.1.3.3 Server Menu on page 11 can be used to configure the number of times each server will be tried for a file transfer and also how long to wait between each attempt. The maximum number of servers to be tried is configurable. Contact Polycom Customer Support for more information.

Note

Be aware of how logs, overrides and directories are uploaded to servers that maps to multiple IP addresses. The server that these files are uploaded to may change over time.

.If you want to use redundancy for uploads, you will have to synchronize the files between servers in the background.

You may want to disable the redundancy for uploads by specifying specific IP addresses instead of URLs for logs, overrides, and directory in the MAC.cfg.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Step: Instructions:

1. Set up boot server(s).

Note: Typically all phones are configured with the same server account, but the server 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. Copy all files from the distribution zip file to the

3. Create per-phone configuration files.

Note: This step may be omitted if per-phone configuration is not needed.

Install boot server application or locate suitable existing server(s). Use RFC-compliant servers.

Create account and home directory. phone may open multiple connections to the server.

The phone will attempt to upload log files, a configuration override file, and a directory file to the server. This requires that the phone’s account has delete, write, and read permissions. The phone will still function without these permissions but will not be able to upload files.

The files downloaded from the server by the phone should be made read-only.

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 <Ethernet address>.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.

Note that each

Edit the CONFIG_FILES attribute of the <Ethernet

address>.cfg files so that it references the appropriate phoneXXXX.cfg file. (Replace the reference to

phone1.cfg with phoneXXXX.cfg.)

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Step: Instructions:

4. Create a new configuration file (in the style of sip.cfg).

For more information on why to create another configuration file, refer to the “Configuration File Manage-

ment on SoundPoint

IP Phones” whitepaper at

www.polycom.com/support/voip/ . Refer to 4.6 Configuration Files on page 84, particu-

larly for SIP server address. Most of the default settings are typically adequate,

however, if SNTP settings are not available through 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 change its signalling port if local security policy dictates.

Change the default location settings:

• user interface language

• time and date format

5. Decide on boot server security policy. Polycom recommends allowing file uploads to the boot server where the security environment permits. This allows event log files to be uploaded and changes made by the phone user to the configuration (through 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 (refer to LOG_FILE_DIRECTORY in 2.2.2.1.1.1 Master Configuration Files on page 13).

File permissions should give the minimum access required, and the account used should have no other rights on the server.

The phone's server 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 through file server file permissions.

Administrator’s Guide - SoundPoint® IP / SoundStation® IP Installation and Operation

Step: Instructions:

6. Reboot phones after configuring their

boot server through DHCP or statically.

a. If the provisioning protocol requires an account name and password, the server account

name and password must match those configured in the phones. Defaults are: provisioning protocol: FTP, name: PlcmSpIp, password: PlcmSpIp

Refer to 2.2.1 Basic Network Setup on page 5. To reboot phones, a menu option can be selected or a

key combination can be held down. The menu option is called Restart Phone and it is in the Settings menu. For the key combination, press and hold the following keys simultaneously until a confirmation tone is heard or for about three seconds:

IP 300 & IP 301: Volume-, Volume+, Hold and Do Not Disturb

IP 430, 500 & IP 501: Volume-, Volume+, Hold, and Messages

IP 600 & IP 601: 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 cor-

rectly. Start making calls.

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 it is disabled through sip.cfg. For more information, refer to

4.6.1.11 Web Server <HTTPD/> on page 125. The phone’s local user interface also permits many application settings to be modified, such as SIP server address, ring type, or regional settings such as time/date format and language.

Local Web Server Access Point your web browser to http://<phoneIPAddress>/.

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):

• User Name: Polycom

• Password: The administrator password is used for this.

+ 158 hidden pages