Plantronics IP40 Administration Manual Download

Page: 1 / 52

5/29/2009

Plantronics IP40 Administration Guide

Page 1

Administration Guide

For the Plantronics

IP40 headset adapter

Summary of Contents for IP40

Page 1: ...5 29 2009 Plantronics IP40 Administration Guide Page 1 Administration Guide For the Plantronics IP40 headset adapter Copyright 2009 Plantronics Inc Date March 16 2009 Firmware v0211 Part Number 81911 01 ...

Page 2: ...5 29 2009 Plantronics IP40 Administration Guide Page 2 ...

Page 3: ...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...

Page 4: ...mplate 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 11Summary of LED states 52 ...

Page 5: ... 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 Po...

Page 6: ...5 29 2009 Plantronics IP40 Administration Guide Page 6 administrators can individually configure the IP40 headset adapter using the IP40 s built in web server ...

Page 7: ... 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 initi...

Page 8: ... 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 conf...

Page 9: ...phone 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 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 ot...

Page 10: ... 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 Eth...

Page 11: ...or 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 ...

Page 12: ...he 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 38 Plantronics Inc Simple Configuration Plug and play configuration Administrator creates config files on HTTP server with file name based on MAC address of ...

Page 13: ...0 DHCP Server DHCP Discover DHCP Request DHCP Offer DHCP ACK domain example com DNS Server HTTP Server 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...

Page 14: ...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 ...

Page 15: ... 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 th...

Page 16: ...dits 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 screensh...

Page 17: ... the user portion contains the name of the resource or user at the domain or server name in the right hand side In other words sip bill bigcompany com is a different resource than sip bill smallcompany com This value is called the SIP user name on the Voice Subscription page SUBSCR_0_UA_DATA_SIP_NAME This value is also mandatory In some cases the domain name hostname or IP address provided for the...

Page 18: ...2009 Plantronics IP40 Administration Guide Page 18 4 1 2 Via web configuration The following screen shots show the same configuration described above Figure 10 Minimal Configuration via Voice Server Web Page ...

Page 19: ...5 29 2009 Plantronics IP40 Administration Guide Page 19 Figure 11 Time Setting Web Page ...

Page 20: ...OLLING_PERIOD 28800 8 hours 28800 secs CFG_POLLING_TIME_HH 2 CFG_POLLING_TIME_MM 30 02 30am FWU_POLLING_ENABLE 1 FWU_POLLING_MODE 0 absolute FWU_POLLING_PERIOD 28800 8 hours 28800 secs FWU_POLLING_TIME_HH 2 FWU_POLLING_TIME_MM 30 02 30am The IP40 headset adapter can use either HTTP or TFTP to fetch its configuration and firmware HTTP is strongly recommended In addition the path name used for firmw...

Page 21: ...5 29 2009 Plantronics IP40 Administration Guide Page 21 Figure 12 Management Server Web Page ...

Page 22: ...the version stored on the server If the versions are different the adapter immediately starts a firmware update The NOTIFY request is an unsolicited NOTIFY for the check sync event It has a unique Call ID The Request URI has the MAC address of the adapter in capital hexadecimal digits in the user part and the IP address of the adapter and port number if a non default source port number is used in ...

Page 23: ...ched in an appendix to this administration guide When the IP40 makes or receives a call it will try to negotiate a common speech codec and then it will exchange media using RTP While the IP40 does not have buttons to enable it to initiate call transfer call forwarding call park or many other traditional PBX features autonomously the IP40 is a good citizen and can be the passive participant in any ...

Page 24: ...cs IP40 Administration Guide Page 24 6 2 Voice Server Page Figure 13 IP40 Voice Server Web Page 6 2 1 Voice Server Web Page Voice Settings Label on web page Server is local Parameter name SRV_0_SIP_UA_DATA_SERVER_IS_LOCAL ...

Page 25: ... 60 chars Web Page Voice Settings Label on web page Server port Parameter name SRV_0_SIP_UA_DATA_SERVER_PORT Type integer 0 to 65535 Default Value 5060 Notes Port number used when an explicit address is provided in SRV_0_SIP_UA_DATA_PROXY_ADDR above Web Page Voice Settings Label on web page Re registration time Parameter name SRV_0_SIP_UA_DATA_REREG_TIME Type integer 0 to 65535 Default Value 3600 ...

Page 26: ...n other words we will support a codec list of 3 0xFF 0xFF 0xFF 0xFF but no other codec lists are supported which contain iLBC 30ms 3 The IP40 will not prevent the administrator from setting an unsupported configuration but undesirable behavior such as phantom ringing one way audio or no audio may occur if these recommendations are ignored iLBC 20ms can be used safely in combination with any other ...

Page 27: ... sip alice vmail example com During normal operation the Answer End button will blink RED on half a second off 2 5 seconds to indicate a Voice Mail is available for this Voice Mailbox subscriber 6 2 3 Headset Option Web Page Voice Settings Label on web page EncorePro receive gain enhancement Parameter name ENABLE_EXTRA_RX_GAIN Type enumerated type Default Value 0 No Notes If 1 Yes will enable an e...

Page 28: ...be added Web Page Call Handling Label on web page Automatically Answer Parameter name CALL_AUTO_ANSWER Type Boolean Default Value 0 Disable Notes Determines if IP40 headset adapter will answer respond with 200 OK or ring respond with 180 Ringing to incoming call Web Page Call Handling Label on web page Disconnect Button Parameter name DISCONNECT_BUTTON Type Boolean Default Value 1 Enable Notes Det...

Page 29: ...5 29 2009 Plantronics IP40 Administration Guide Page 29 6 4 Management Settings Page Figure 15 Management Settings Web Page ...

Page 30: ...Parameter name FWU_TFTP_SERVER_PATH Type string Default Value media downloads ip40poe Notes This directory in which the IP40 headset adapter will look for new software on the HTTP or TFTP management server Web Page Management Settings Label on web page Management Password Parameter name MANAGEMENT_PASSWORD Type string up to 25 chars Default Value VoipLan Web Page Management Settings Label on web p...

Page 31: ...l on web page Upload Server Parameter name NETWORK_UPLOAD_SERVER Type string Default Value Notes Server to upload debug information Web Page Management Server Label on web page Upload of Debug Log Parameter name VOIP_LOG_AUTO_UPLOAD Type Boolean Default Value 0 Notes Setting to upload debug information 0 Disable 1 Boot Log only All information Web Page Management Server Label on web page Upload of...

Page 32: ...eb page Hour for searching for new software Parameter name FWU_POLLING_TIME_HH Type integer 0 to 23 Default Value 3 03 xx am Notes Defines the hour when a check for new firmware would occur in Absolute mode Web Page Management Settings Label on web page Minute for searching for new software Parameter name FWU_POLLING_TIME_MM Type integer 0 to 59 Default Value 0 xx 00 Notes Defines the minute when ...

Page 33: ...3 xx am Notes Defines the hour when a check for new configuration would occur in Absolute mode Web Page Management Settings Label on web page Minute for searching for new configuration Parameter name CFG_POLLING_TIME_MM Type integer 0 to 59 Default Value 0 xx 00 Notes Defines the minute when a check for new configuration would occur in Absolute mode 6 4 5 Local Web Page Access Page Web Page Manage...

Page 34: ...Settings Page By default the IP40 uses DHCP to fetch an IP address Once it obtains an initial address it can be reconfigured with a static IP address This is not recommended but may be useful in some very specialized environments such as in a network testing laboratory Note that if these parameters are incorrectly configured the IP40 can be restored to its factory settings see the section on Facto...

Page 35: ...5 29 2009 Plantronics IP40 Administration Guide Page 35 Figure 16 Network Settings Web Page ...

Page 36: ...DNS2 For example setting the IP address 192 168 1 6 is done like this NETWORK_WAN_SETTINGS_IP 0xC0A80106 Note Well IP Addresses must be entered as a single hexadecimal number In the IP40 configuration file IP addresses in dotted quad format will be rejected by the headset adapter The amount of time that the IP40 headset adapter will wait for DHCP responses is configurable from the configuration fi...

Page 37: ...are accessed via the public Internet some NAT traversal technique will need to be used to make sure that IP addresses and port numbers needed for RTP media are useful to the receiver they need to be translated by the IP40 headset adapter or an intermediary that the addresses and ports used for SIP traffic are useful to at least the adapter s proxy server and that the NAT binding between the adapte...

Page 38: ...address of the IP40 headset adapter if STUN is enabled Web Page Network Settings Web Page Network Settings Label on web page STUN bindtime guard Parameter name SIP_STUN_BINDTIME_GUARD Type integer 0 to 65535 Default Value 80 seconds Notes This is an initial value used to test NAT bindings if SIP_STUN_BINDTIME_DETERMINE is enabled This is a starting guess of the binding time Note that the SRV_0_SIP...

Page 39: ...ve this on unless you have a very very good reason to turn it off Label on web page Enable STUN Parameter name SIP_STUN_ENABLE Type Boolean Default Value 0 disabled Notes Turns on STUN discovery 6 5 4 SIP RTP Settings Web Page Network Settings Label on web page SIP RTP port range Parameter name SIP_RTP_PORT_RANGE Type integer 3 to 20 Default Value 20 Notes Number of RTP ports that can be open star...

Page 40: ...ck for new configuration and firmware files if these use Absolute times The IP40 headset adapter includes a Simple Network Time Protocol client to fetch the current time The correct time zone should always be configured when an SNTP server is used Figure 17 Time Settings Web Page Web Page Time Settings Label on web page Time server Parameter name NETWORK_SNTP_SERVER Type IP address or domain name ...

Page 41: ... return the time zone offset back to the original value at the end of that daylight savings time The configuration file value for the daylight savings time offset may not be the standard time value plus one For example in Moscow the standard time offset UTC 3 is represented by 16 in the configuration file while the daylight savings time offset UTC 4 is represented by 18 The value used in the confi...

Page 42: ...sages will be displayed in SIP Trace Web page They also stored into log files and depending on Management Settings IP40 will attempt to upload these files to the TFTP Server for record keeping See section 6 4 2 for settings 6 9 Settings Page The settings page contains all the parameters that have been set to configure the IP40 6 9 1 Config file Template As very few settings change across IP40s in ...

Page 43: ... string up to 35 characters Default Value Notes IP40 Web page password Parameter name DELAYED_MEDIA_BEHAVIOUR Type Boolean Default Value 0 Notes This parameter defines how the device generates its offer in a Delayed Media scenario i e when receiving an INVITE without SDP Allowed values are 0 The phone will respond with an offer SDP indicating its own local state That is If Hold has not been activa...

Page 44: ...s Specifies the type of server Allowed values are bitfield 1 Voice server bin 00000001 2 EMS bin 00000010 Not Used in Tarpon 4 Infopush server bin 00000100 Not Used in Tarpon The server can be configured for more types at once E g if used for both EMS and InfoPush the value must be 6 Parameter name SRV_0_DTMF_SIGNALLING Type Boolean Default Value 0 Notes Parameter specifying how to transmit DTMF s...

Page 45: ...update of configuration file Factory default sets CONFIGURATION_FILE_FLAG to 1 in order to avoid download of configuration file during production test only 6 9 3 Default Setting file contents PLAY_INBAND_DTMF 1 FWU_POLLING_ENABLE 1 FWU_POLLING_MODE 0 FWU_POLLING_PERIOD 86400 FWU_POLLING_TIME_HH 3 FWU_POLLING_TIME_MM 0 GMT_TIME_ZONE 15 AUTO_DIAL_NUMBER CFG_POLLING_ENABLE 1 CFG_POLLING_MODE 0 CFG_PO...

Page 46: ...V_0_SIP_UA_CODEC_PRIORITY 1 0 2 4 255 SUBSCR_0_SIP_UA_DATA_SIP_NAME SUBSCR_0_UA_DATA_DISP_NAME SUBSCR_0_SIP_UA_DATA_SIP_NAME_ALIAS SIP1 SUBSCR_0_SIP_UA_DATA_SERVER_ID 0 SUBSCR_0_SIP_UA_DATA_VOICE_MAILBOX_NAME SUBSCR_0_SIP_UA_DATA_VOICE_MAILBOX_NUMBER SUBSCR_0_UA_DATA_AUTH_NAME SUBSCR_0_UA_DATA_AUTH_PASS NETWORK_UPLOAD_SERVER VOIP_SIP_AUTO_UPLOAD 0 VOIP_LOG_AUTO_UPLOAD 0 TRACE_MODE 1 CONFIGURATION_...

Page 47: ...TINGS_GATEWAY 0 0 0 0 NETWORK_WAN_SETTINGS_DNS1 0 0 0 0 NETWORK_WAN_SETTINGS_DNS2 0 0 0 0 NETWORK_WAN_SETTINGS_DHCP 1 7 Protocols standards support The IP40 headset adapter supports SIP as defined in RFC 3261 and related specifications with a few exceptions The following SIP extensions are also supported SIP digest authentication RFC2617 SIP usage of DNS SRV and NAPTR lookups RFC 3263 SIP hold RFC...

Page 48: ...witched transparently without modification VLAN Tagging is set via configuration file upload It can not be set via the Web server The IP40 contains three ports that can be configured internal network and PC Tagging of the three ports can be managed with the following lines in the configuration file Parameter name VLAN_SW_P1_TAGGING_CTRL Type integer value ranges from 0 to 2 Default Value 0 Notes V...

Page 49: ...aditionally means that traffic is untagged 9 2 1 2 Dynamic Setting VLAN Discovery If the administrator configures that VLAN configuration to be dynamic then the IP40 unit will attempt to discover the correct VLAN automatically using a specific configurable DHCP option set by LAN network engineer Note that this means that the voice gateway portion of the device needs to issue an untagged DHCP DISCO...

Page 50: ... or 1 ASCII format Parameter name VLAN_DHCP_LENGTH Type Integer Default Value 0 Notes To specify the length of data should be collected to the VLAN ID for example 4 Below is a typical VLAN Discovery settings The VLAN_DHCP_STRING is a string to search for Fx VLAN_DHCP_STRING iemen will find a match if the DHCP option string contains Siemens since the VLAN_DHCP_STRING is contained in the option stri...

Page 51: ...ORK_TFTP_SERVER parameter did not provide a configuration file The IP40 headset adapter does not attempt to discover a configuration server if CFG_POLLING_ENABLE has been disabled In this case the adapter checks if SRV_0_SIP_UA_DATA_DOMAIN and SUBSCR_0_UA_DATA_SIP_NAME have been configured Registration server not found the device did not get a response from the configured registration server Regis...

Page 52: ...l operation blinking red blinking red Factory reset warning solid red solid red Factory reset in progress unlit blinking red Firmware update in progress solid green unlit In a call or attempted outgoing call unmuted solid green solid red In a call or attempted outgoing call muted solid yellow unlit In a call far end on hold unmuted solid yellow solid red In a call far end on hold muted blinking re...

Search results

Summary of Contents for IP40

Reviews:

Related manuals for IP40

Brands by name

Popular brands

Plantronics IP40, Administration Manual

Search results

Summary of Contents for IP40

Reviews:

Related manuals for IP40

Brands by name

Popular brands