Plantronics IP40 User Manual
Administration Guide
For the Plantronics
IP40 headset adapter
Copyright 2009 Plantronics, Inc.
Date: March 16, 2009
Firmware: v0211
Part Number: 81911-01
5/29/2009 Plantronics IP40 Administration Guide Page 1
5/29/2009 Plantronics IP40 Administration Guide Page 2
Table of Contents
1 Introduction to the Plantronics IP40 headset adapter ........ 5
2 Product Overview ..................................................................... 7
2.1 Call Handling - Answer/End Button................................................................... 7
2.2 Volume Control Button...................................................................................... 8
2.3 Mute Button....................................................................................................... 9
2.4 Hold Function.................................................................................................... 9
2.5 Ethernet Switch................................................................................................. 9
2.6 Boot-up Light Sequence.................................................................................. 11
2.7 Factory Reset.................................................................................................. 11
3 Initial Setup ............................................................................. 12
3.1 Using Automatic Discovery .............................................................................12
3.2 Configuration File Format................................................................................ 13
3.3 Configuration Using the Embedded Web Server............................................. 14
4 Typical Minimal Configuration.............................................. 17
4.1 Configuration example .................................................................................... 17
4.1.1 Via configuration file upload..................................................................... 17
4.1.2 Via web configuration............................................................................... 18
5 Updating Firmware and Configuration ................................ 20
5.1 Automatically initiating firmware update.......................................................... 20
5.2 Manually initiating firmware update................................................................. 22
5.3 Check-sync Upgrade.......................................................................................22
6 Configuration Reference ....................................................... 23
6.1 SIP and RTP................................................................................................... 23
6.2 Voice Server Page .......................................................................................... 24
6.2.1 Voice Server ............................................................................................ 24
6.2.2 Voice Subscription ................................................................................... 26
6.2.3 Headset Option........................................................................................ 27
6.3 Call Handling Page ......................................................................................... 27
6.4 Management Settings Page............................................................................ 29
................................................................................................................................... 29
6.4.1 Management Server ................................................................................30
6.4.2 Upload of Debug Information ...................................................................31
6.4.3 Firmware Update ..................................................................................... 31
6.4.4 Configuration Update............................................................................... 32
6.4.5 Local Web Page Access (Page) .............................................................. 33
6.5 Network Settings Page.................................................................................... 34
6.5.1 Network Settings (General)...................................................................... 36
6.5.2 DHCP Options ......................................................................................... 36
6.5.3 STUN Settings .........................................................................................37
6.5.4 SIP/RTP Settings..................................................................................... 39
5/29/2009 Plantronics IP40 Administration Guide Page 3
6.6 Time Settings Page......................................................................................... 40
6.7 Debug Page.................................................................................................... 42
6.8 SIP Trace Page............................................................................................... 42
6.9 Settings Page.................................................................................................. 42
6.9.1 Config file Template................................................................................. 42
6.9.2 Fields not visible via web interface........................................................... 42
6.9.3 Default Setting file contents ..................................................................... 45
7 SIP standards support ........................................................... 47
8 Creation of configuration file using the Web Page. .......... 47
9 VLAN ........................................................................................ 48
9.1 VLAN Tagging................................................................................................. 48
9.2 VLAN Configuration ........................................................................................ 49
9.2.1.1 Static Setting ........................................................................................ 49
9.2.1.2 Dynamic Setting - VLAN Discovery...................................................... 49
10 Debugging and Troubleshooting ........................................ 51
11 Summary of LED states ......................................................... 52
5/29/2009 Plantronics IP40 Administration Guide Page 4
1 Introduction to the Plantronics IP40 headset adapter
The Plantronics IP40 is a Voice over Internet Protocol (VoIP) headset adapter targeted
for use in the contact center. Contact center agents use a PC as their telephony control
device and perform actions such as on/off-duty status, customer follow-up, and
supervisor feedback directly from the PC.
The IP40 provides a direct audio connection for the contact center headset to the
Ethernet and a subset of the audio control functionality of an IP telephone. In contrast to
an IP telephone the handset and speakerphone functionality are replaced by a
Plantronics optimized headset interface.
To an end user, an IP40 looks much like a Plantronics DM15 or AP15 audio processor,
except that it is connected directly to an IP network instead of being connected to a
telephone. For contact center agents a telephone dial pad is largely redundant. On the
IP40 only a limited number of the useful buttons are retained.
Good quality voice communication is key to a successful contact center. In
environments where the administrator of the contact center wants to guarantee the
sound quality of a conversation, an IP40 headset adapter is a compact alternative to a
soft-client that is simple to install and to use.
The IP40 headset adapter has an interface for a Plantronics H-series headset with a
quick disconnect (QD) connector, an Ethernet port to connect to the IP network, and a
second Ethernet port to allow a PC to share a single Ethernet connection from the wall
jack.
The IP40 can be powered from the Ethernet using standard 802.3af Power over
Ethernet (PoE) and enumerates as a class 1 PoE device. Alternatively it can be
powered by an external DC power adapter, which is supplied separately.
The IP40 headset adapter supports the industry standard Session Initiation Protocol
(SIP) for session signaling and the Real-time Transport Protocol (RTP) for audio media.
These standards are supported by a wide range of products. The IP40 headset adapter
is designed to work with any SIP based implementation, but the administrator should
consult the release notes to determine which products have been formally validated. A
list of systems with which interoperability has been verified can be found on the
Plantronics support site.
The product is designed to be plug and play. At startup the IP40 attempts to fetch its
configuration automatically from a web server in the customers network. Administrators
can use this facility to automatically configure new headset adapters and integrate
configuration with the rest of their contact center administration regime. Alternatively,
5/29/2009 Plantronics IP40 Administration Guide Page 5
administrators can individually configure the IP40 headset adapter using the IP40's
built-in web server.
5/29/2009 Plantronics IP40 Administration Guide Page 6
2 Product Overview
The IP40 has three buttons for agent audio control
2.1 Call Handling - Answer/End Button
The Answer/End button on the IP40 headset adapter is configurable and can be used
for different functions during normal operation: answering a call, disconnecting a call,
and placing a call to one pre-configured destination.
Volume Up
Answer/End
Volume Down
Mute
Power Light
Figure 1 IP40 Top View
In addition, the Answer/End button is also used to find out local administrative
information of individual IP40s. This information is accessed by pushing the
Answer/End button when not in a call to hear any of the following - IP address of the
adapter (described in section 3.3); - spoken error prompts (described section 10). In
conjunction with the Volume Up button the Answer/End button is used to initiate a
factory reset (described in section 2.7).
Handling Incoming Calls
The IP40 headset adapter can be configured to automatically answer incoming calls
5/29/2009 Plantronics IP40 Administration Guide Page 7
(see the discussion of the CALL_AUTO_ANSWER parameter in section 6.3). When the
IP40 headset adapter is configured to automatically answer incoming calls and an
incoming call arrives, the adapter checks if a headset is attached to adapter. If so, the
call is immediately answered and the Answer/End button is green. If a headset is not
attached to the adapter, the adapter returns a SIP 180 Ringing response to the
incoming call and flashes the Answer/End button red. If the headset is reattached while
the adapter is ringing in auto answer mode, the adapter will answer the ringing call.
When the headset is not configured to answer incoming calls and an incoming call
arrives, the adapter returns a 180 Ringing response and flashes the Answer/End
button red. The adapter then checks if a headset is attached. If so, pressing the
Answer/End button
refuse the call. If the headset was not attached when the incoming call arrives,
reattaching the headset will automatically answer the call.
briefly
will answer the call, while disconnecting the headset will
Terminating Calls
If the IP40 headset adapter is configured so that the disconnect button is enabled (see
section 6.3 discussion of the DISCONNECT_BUTTON parameter), pressing the
Answer/End button for half a second and releasing the button during an active call will
disconnect the call. The short delay requires a deliberate press. This deliberate key
press prevents calls from accidentally dropped calls. If this feature is disabled, only the
far end or PC control software will be able to end a call.
Making an Outgoing Call
If so configured, the IP40 can make an outbound call to a single configured phone
number or SIP URI (a full SIP address such as "sip:2000@example.com"). The phone
number or URI to call is stored in the AUTO_DIAL_NUMBER parameter.
Canceling an outgoing call is accomplished by holding down the Answer/End button for
half a second.
Message Waiting Indication
The Answer/End button can be used to indicate if a message is waiting for configured
voicemail account. If a message is received the Answer/End button will blink RED on
half a second and off 2.5 seconds to indicate a Voice Mail is available for this voice
mailbox subscriber. See section 6.2.2 for details
2.2 Volume Control Button
When the IP40 headset adapter boots, its receive volume is set to the middle or
reference position. During a call, the receive volume can be adjusted by pressing the
Volume Up (+) or Volume Down (-) button. Each time the volume is adjusted, a tone
plays. At the maximum and minimum loudness a distinctive tone plays. At the middle
volume position, a triple beep is played.
5/29/2009 Plantronics IP40 Administration Guide Page 8
Once adjusted, the volume setting persists across calls, unless the headset is
disconnected when the IP40 headset adapter is not in a call or the IP40 headset
adapter is rebooted. When the headset is disconnected in the idle state, the receive
volume level reverts to the default setting.
The transmit volume is calibrated at the factory and does not require adjustment.
2.3 Mute Button
During a call, pressing the mute button mutes the headset microphone on the headset
adapter. The mute button will turn red to indicate this and a mute tone is played. To
turn off the mute feature, press the button again. The mute status does not persist
across calls.
QD Connector
Figure 2 IP40 Underside View Showing Cable Routing and QD Location
2.4 Hold Function
During a call, if the headset is unplugged at the QD connector, the IP40 headset
adapter will attempt to place the other party on hold. If this was successful, the
Answer/End button will be yellow. Reconnecting the headset at the QD connector will
take the other party off hold and resume a normal call.
2.5 Ethernet Switch
The IP40 has two Ethernet ports that are switched / bridged with the internal Ethernet
5/29/2009 Plantronics IP40 Administration Guide Page 9
port used by the IP40's processor. This switch is provided purely as a convenience to
conserve physical wiring to the agents desk. These two Ethernet ports are set at the
factory to auto negotiate between 10Base-T and 100Base-TX and to auto detect full or
half-duplex.
Figure 3 IP40 Cable Connections
The two Ethernet ports on the unit are labeled with a PC (
) and a LAN ( ) icon.
The green light on each Ethernet port is lit when link integrity is detected and blinks
during network activity. The yellow light on each Ethernet port is on when 100Base-TX
is in use. The light is off when 10Base-T is in use. If your data network supports Power
over Ethernet (PoE) the unit will power up indicated by the power LED flashing green.
Green LED Yellow LED
5/29/2009 Plantronics IP40 Administration Guide Page 10
The port labeled with the network icon (right hand port) can be used to power the device
from an 802.3af provisioned network connection. The IP40 is a Class 1 PoE device
2.6 Boot-up Light Sequence
During boot-up, the Answer/End light will blink yellow until it has an IP address and has
initialized its signaling stack.
Once the yellow power light stops blinking, the adapter will either be ready to use (no
control button lights) or the adapter will be in an error state. If there is an error state, the
Answer/End button will be solid red. Briefly pressing the Answer/End button during an
error state will play the specific error message (see section 10 Debugging and
Troubleshooting for more details).
During a firmware upgrade, the mute button will blink red. Do not interrupt a firmware
upgrade.
A summary of the LED indications can be found in Section 9
2.7 Factory Reset
To restore the IP40 to factory configuration settings, hold down the Volume Up and
Answer/End buttons while powering on the IP40. The mute LED and Answer/End LED
will blink red for several seconds. When the LEDs become solid RED, release the
buttons. The IP40 will then reboot with factory configuration settings.
5/29/2009 Plantronics IP40 Administration Guide Page 11
3 Initial Setup
Overview
When the IP40 unit powers on for the first time (or after a factory reset) it searches for a
configuration server to fetch its configuration automatically. The first action as it boots
up is to try obtaining an IP address using Dynamic Host Configuration Protocol (DHCP).
Most DHCP servers also provide a default domain name in addition to the IP address
assigned to their device. If domain is indicated the IP40 will use this information and try
and follow the Auto Discovery configuration process.
If no domain name and/or configuration server is provided the IP40 can be configured
via its built in web interface
3.1 Using Automatic Discovery
If a default domain name was provided, the IP40 queries the DNS (Domain Name
System) server for the address and port number of a configuration service in that
domain. If the default domain name is 'example.com', the IP40 queries the DNS for an
SRV record named '_pltconfig._tcp.example.com'.
Sim ple C onf igur at i on
Plug and play conf igur at ion
Administ rat or creat es ‘conf ig ’ files on HTTP server
with file name based on MAC address of IP40
IP40 boots and gets netw ork infor mation via DHCP
DHCP & DNS s er v ice poin t I P 40 to HTT P s er v er
Correc t conf iguration fo r device is down l oaded
based on M A C address
IP40 reboots with new conf igurati on and regist ers
with the S IP prox y
Once authent i cat ed agent i s ready f or c al ls
MAC:00:08:7b:06:d1:5f
10.1.45.113
IP Address:
Password:
example.com
10.1.13.45
3345
*****
Domain Name:
HTTP Server IP Address:
Extension number:
DHCP S ervice DNS S ervice
IP
DN
IP Cloud
UA: 3345
PSWD: *****
OK
HTTP File Sever
Config
file
Contact Center
SIP Proxy
38Plantro nics, Inc.
Figure 4 DHCP Auto Configuration Process
5/29/2009 Plantronics IP40 Administration Guide Page 12
r
;; in the example.com. zone file
_pltconfig._tcp IN SRV 0 1 config.example.com. 8080
If this lookup is successful, the response will contain an ordinary hostname, its IP
address, and a port number. The IP40 then uses HTTP (Hyper Text Transfer Protocol)
to fetch its configuration file from the server at the address and port number in the DNS
response. The path in the request is '/Config' and the filename is the MAC address of
the IP40 (in lowercase with no separator symbols) plus the extension '.cfg'.
GET /Config/00087b06d15f.cfg HTTP/1.1
Host: config.example.com:8080
This process is also shown in the following diagram, assuming the MAC address of the
unit is 00:08:7B:06:D0:D6.
IP40 DHCP Server
DHCP Discover
DHCP Request
DNS Server HTTP Serve
DHCP Offer
DHCP ACK
(domain = example.com)
DNS Request: SRV _pltconfig._tcp.example.com
DNS Response: config.example.com port 8080
HTTP GET http://config.example.com:8080/Config/00087b06d0d6.cfg
HTTP: 200 OK (with configuration file)
Figure 5 Configuration Process
3.2 Configuration File Format
The format of the configuration file is a structured text file. An example of the file
structure for a minimal configuration is contained in section 6.9 Settings Page.
Each line contains the name of a configurable item and its value in the following format.
At the beginning of each line, before the name of the configurable item, is a percent
symbol (%). The name of the configurable item will be in uppercase letters, numerals,
and underscores. The name is followed by a percent symbol (%) and then a colon
character (:). If the type of parameter has an integer, Boolean, or enumerated value, the
5/29/2009 Plantronics IP40 Administration Guide Page 13
value will follow immediately after the colon and will be expressed as a decimal integer
(with no quotes):
%NETWORK_DHCP_CLIENT_BOOT_SERVER_OPTION%:12345 // integer value in
decimal
%NETWORK_WAN_SETTINGS_IP%:0xC0A80106 // or hexadecimal
If the parameter is a codec priority list, the value following the colon is a comma
separated list of decimal or hexadecimal integers, ending in hexadecimal 0xFF (255
decimal):
%SRV_0_SIP_UA_CODEC_PRIORITY%:0,1,3,4,0xFF
If the type of parameter has any other type of value (a string, IP address, domain name,
or URI), the value following the colon is a double-quoted string value (a value bracketed
by <"> on both sides):
%NETWORK_DHCP_CLIENT_BOOT_SERVER_OPTION%:"string value of
configurable option"
The specific configuration file entries are discussed in more detail in the following
sections under Section 6 "Configuration Reference ".
3.3 Configuration Using the Embedded Web Server
The IP40 has an embedded web server which can be used for individual configuration.
The web server also provides access to the internal logging messages and the ability to
reboot the unit. Before accessing the web server, it is necessary to determine the IP
address of the IP40.
Determine the IP address of the IP40
Since the IP40 has no display, the IP address is rendered to the administrator aurally by
playing the IP address, one digit at time, through the headset. For example, '10.1.7.155'
sounds like "one-zero-dot-one-dot-seven-dot-one-five-five".
Make sure that a headset is plugged into the IP40. Make sure that the IP40 has finished
booting. The power LED will be solid green, the mute button will be unlit, and the
answer/end button will be unlit or solid red. If the Answer/End LED is red (this is typical
if not configured), press and hold the Answer/End button for more than 5 seconds and
the IP address of the unit will be spoken
Error messages maybe accessed in the same way using a brief button press (less than
5 seconds) of the Answer/End button. If the error message played says either "IP
address not found" or "Your network cable is not connected", the administrator needs to
5/29/2009 Plantronics IP40 Administration Guide Page 14
first attach the IP40 to a network with a functioning DHCP server with available
addresses. A list of error messages can be found in section 10
If any other error message is played, the IP40 headset adapter can still be configured
over the network.
Modifying the IP40 configuration
Using a web browser connected to the same network as the headset adapter, enter the
IP address of the IP40 headset adapter into the Address Bar of the browser. For
example, if the IP address played by the IP40 headset adapter was '10.1.7.155' enter
'http://10.1.7.155' into the web browser.
Figure 6 Web Browser Access
The IP40 web browser interface will then ask you to authenticate to the headset
adapter.
Figure 7 Log authorization
Enter the username and password configured for the headset adapter. The default
username and password are listed below.
The default username is: admin
The default password is: admin
5/29/2009 Plantronics IP40 Administration Guide Page 15
The IP40 configuration is split across several web pages, each listed in the left-hand
column of any page.
Figure 8 IP40 Home Page
After any change is made on a page, the SAVE CHANGES button must be pressed
(before changing to the next page for edit). Once all the changes (possibly from more
than one page) have been made, the REBOOT button (
once all edits are complete
)
must be used before these changes will take effect. It is not necessary to reboot the
adapter after each page of changes.
A warm reboot will take approximately 15 seconds
Figure 9 IP40 Modification Actions
In a later section “Configuration Option Reference", the meaning of each configurable
item is discussed according to its internal name as used by the configuration file. The
screenshots in that section show the internal name of each configurable option shown
on the web pages. The most commonly used configurable items are discussed in the
next section 4 "Typical Minimal Configuration".
5/29/2009 Plantronics IP40 Administration Guide Page 16
Loading...