Plantronics IP40 Administration Manual

Plantronics IP40 Administration Manual

Headset adapter
Hide thumbs Also See for IP40:

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading

Summary of Contents for Plantronics IP40

  • Page 1 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...
  • Page 2 5/29/2009 Plantronics IP40 Administration Guide Page 2...
  • Page 3: Table Of Contents

    Table of Contents 1 Introduction to the Plantronics IP40 headset adapter ..5 2 Product Overview ..............7 Call Handling - Answer/End Button..............7 Volume Control Button ..................8 Mute Button....................... 9 Hold Function....................9 Ethernet Switch....................9 Boot-up Light Sequence.................. 11 Factory Reset....................
  • Page 4 9 VLAN ..................48 VLAN Tagging....................48 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...
  • Page 5: Introduction To The Plantronics Ip40 Headset Adapter

    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 customer s network. Administrators can use this facility to automatically configure new headset adapters and integrate configuration with the rest of their contact center administration regime.
  • Page 6 IP40 headset adapter using the IP40's built-in web server. 5/29/2009 Plantronics IP40 Administration Guide Page 6...
  • Page 7: 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.
  • Page 8: Volume Control Button

    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.
  • Page 9: Mute Button

    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.
  • Page 10 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.
  • Page 11: Boot-Up Light Sequence

    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.
  • Page 12: Initial Setup

    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).
  • Page 13: Configuration File Format

    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.
  • Page 14: Configuration Using The Embedded Web Server

    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.
  • Page 15 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.
  • Page 16 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.
  • Page 17: Typical Minimal Configuration

    In some cases the domain name, hostname, or IP address provided for the registrar is not the hostname or IP address where the IP40 should send its SIP requests. If this is the case, the “Proxy Address” on the Voice Server page (SRV_0_SIP_UA_DATA_PROXY_ADDR) should be set to the address where requests need to be sent.
  • Page 18: Via Web Configuration

    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 5/29/2009 Plantronics IP40 Administration Guide Page 18...
  • Page 19 Figure 11 Time Setting Web Page 5/29/2009 Plantronics IP40 Administration Guide Page 19...
  • Page 20: Updating Firmware And Configuration

    %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 firmware downloads is configurable. (The path name used for configuration download is always "/Config".) Also, the username and password of the administrator account on the built-...
  • Page 21 Figure 12 Management Server Web Page 5/29/2009 Plantronics IP40 Administration Guide Page 21...
  • Page 22: Manually Initiating Firmware Update

    Plantronics public web site and changing the polling setting to Relative with the desired time interval. Before upgrade the IP40 will check that it is not in an active call. If it is it will defer upgrade to after the call is terminated.
  • Page 23: Configuration Reference

    SIP operation and terminology. A very short summary of the SIP methods supported is attached 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.
  • Page 24: Voice Server Page

    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 5/29/2009 Plantronics IP40 Administration Guide Page 24...
  • Page 25 Parameter name: SRV_0_SIP_UA_DATA_REREG_TIME Type: integer (0 to 65535) Default Value: 3600 Notes: How long in seconds the IP40 headset adapter asks its registration to be valid (in the Expires: header) Web Page: Voice Settings Label on web page: Domain config...
  • Page 26: Voice Subscription

    4 = G.729ab. Note that it is not possible to choose both option 2(iLBC 20 ms) and 3(iLBC 30 ms) in the same priority list. Warning: The default packetization time used by the IP40 is 20ms. Because the IP40 software makes several assumptions about packetization time, we do not support configurations with iLBC 30ms and another codec in the codec list.
  • Page 27: Headset Option

    Parameter name: ENABLE_EXTRA_RX_GAIN Type: enumerated type Default Value: 0 (No) Notes: If 1 (Yes) will enable an extra 6 db gain on RX to be used with Plantronics EncorePro headsets 6.3 Call Handling Page The behavior of the Answer/End button is described in the section 2.1 Call Handling Answer/End Button.
  • Page 28 Type: Boolean Default Value: 1 (Enable) Notes: Determine if the IP40 headset adapter will be able to send BYE and CANCEL requests. If this feature is disabled, the user will only be able to disconnect a call using third party software on a PC for example.
  • Page 29: Management Settings Page

    6.4 Management Settings Page Figure 15 Management Settings Web Page 5/29/2009 Plantronics IP40 Administration Guide Page 29...
  • Page 30: Management Server

    DHCP provided management server can use a two-stage configuration process. The IP40 is turned on first on a private network where it use DNS SRV to find a configuration server, and downloads a very minimal configuration file that enables DHCP-based configuration.
  • Page 31: Upload Of Debug Information

    Notes: Setting to upload debug information, 0=Disable, All information 6.4.3 Firmware Update Web Page: Management Settings Label on web page: Firmware Update Parameter name: FWU_POLLING_ENABLE Type: Boolean Default Value: 1 (Enabled) Notes: Turns on overall polling process for new firmware 5/29/2009 Plantronics IP40 Administration Guide Page 31...
  • Page 32: Configuration Update

    Parameter name: CFG_POLLING_ENABLE Type: Boolean Default Value: 1 (Enabled) Notes: Turns on overall polling process for new configuration Web Page: Management Settings Label on web page: Polling Method Parameter name: CFG_POLLING_MODE Type: enumeration 5/29/2009 Plantronics IP40 Administration Guide Page 32...
  • Page 33: Local Web Page Access (Page)

    Web Page: Management Settings Label on web page: HTTP Server Password Parameter name: LOCAL_HTTP_SERVER_AUTH_PASS Type: string (up to 36 chars) Default Value: "admin" Notes: The password used to login to the headset adapter 5/29/2009 Plantronics IP40 Administration Guide Page 33...
  • Page 34: Network Settings Page

    6.5 Network 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.
  • Page 35 Figure 16 Network Settings Web Page 5/29/2009 Plantronics IP40 Administration Guide Page 35...
  • Page 36: Network Settings (General)

    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 file as an integer number between 1 and 600 seconds via the NETWORK_DHCP_CLIENT_TIMEOUT parameter.
  • Page 37: Stun Settings

    6.5.3 STUN Settings NAT Traversal If the IP40 headset adapter is used on a private network while the SIP registrar, proxy server, and other endpoints (for example gateways) are accessed via the public Internet, some NAT traversal technique will need to be used to make sure that IP...
  • Page 38 Notes: If enabled, the IP40 headset adapter tries to dynamically determine the timeout values of any NATs between the IP40 headset adapter and the configured STUN server. Once a binding time is guessed, the IP40 headset adapter will send STUN binding requests at a frequency half of the discovered binding time.
  • Page 39: Sip/Rtp Settings

    Web Page: Network Settings Label on web page: Local SIP port Parameter name: SIP_SIP_PORT Type: integer (0 to 65535) Default Value: 5060 Notes: The port number that the headset adapters will listen on for SIP traffic. 5/29/2009 Plantronics IP40 Administration Guide Page 39...
  • Page 40: Time Settings Page

    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.
  • Page 41 Parameter name: NETWORK_SNTP_SERVER_UPDATE_TIME Type: integer (0 to 255) Default Value: 15 (seconds) Notes: How often (in seconds) the IP40 headset adapter polls the SNTP server to refresh the time. Web Page: Time Settings Label on web page: Timezone Parameter name: GMT_TIME_ZONE...
  • Page 42: Debug Page

    IP40 and then cut and past the Setting page contents to a text editor for creation of additional configuration files. Each file should be saved with a name from the MAC address of the IP40 it is to configure with the extension .cfg 6.9.2 Fields not visible via web interface...
  • Page 43 Notes: Change Mic TX level Parameter name: NETWORK_DHCP_CLIENT_TIMEOUT Type: integer (1- 600) Default Value: 3 Notes Number of seconds the IP40 waits for secondary DHCP Offer messages before selecting an offer. Parameter name: LOCAL_HTTP_SERVER_AUTH_PASS Type: string up to 35 characters Default Value: "**********"...
  • Page 44 Name for this subscription when presented to user in handset Parameter name: SUBSCR_0_SIP_UA_DATA_VOICE_MAILBOX_NUMBER Type: Integer Default Value: 0 Notes: Voice Mailbox number Sip address/ phone number used when listening to messages Parameter name: TRACE_MODE 5/29/2009 Plantronics IP40 Administration Guide Page 44...
  • Page 45: Default Setting File Contents

    0: UART internal 1: Ethernet Parameter name: LOCAL_HTTP_SERVER_TEMPLATE_TITLE Type: string Default Value: "IP40 configurator" Notes: String that appears on the top of the IP40 web interface to describe the unit being viewed Parameter name: CONFIGURATION_FILE_FLAG Type: Boolean Default Value: 0...
  • Page 46 %SRV_0_SIP_UA_DATA_REREG_TIME%:3600 %SRV_0_SIP_UA_DATA_PROXY_ADDR%:"" %SRV_0_DTMF_SIGNALLING%:0 %SRV_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_FILE_FLAG%:0 %MANAGEMENT_TRANSFER_PROTOCOL%:1 %MANAGEMENT_PASSWORD%:"VoipLan" %MANAGEMENT_UPLOAD_SCRIPT%:"/CfgUpload" %ENABLE_SIP_MESSAGE_ENCRYPTION%:1 %NETWORK_TFTP_SERVER%:"" %NETWORK_FWU_SERVER%:"firmware.plantronics.com" %FWU_TFTP_SERVER_PATH%:"/media/downloads/ip40poe/" %NETWORK_SNTP_SERVER%:"" %NETWORK_SNTP_SERVER_UPDATE_TIME%:15 %VLAN_SW_P1_TAGGING_CTRL%:0 %VLAN_SW_P2_TAGGING_CTRL%:0 %VLAN_SW_P3_TAGGING_CTRL%:0 5/29/2009 Plantronics IP40 Administration Guide Page 46...
  • Page 47: Sip Standards Support

    %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 3264 •...
  • Page 48: Vlan

    Setting page contents to a text editor for creation of additional configuration files. Each file should be saved with a name from the MAC address of the IP40 it is to configure with the extension .cfg. For default file settings see 6.9.3 9 VLAN 9.1 VLAN Tagging...
  • Page 49: Vlan Configuration

    IDs and issue a new DHCP DISCOVER tagged on the voice VLAN. Below is the sequence for VLAN Discovery: 1. IP40 sends out DHCP Discover message to find out if there is a DHCP server available. 2. If the DHCP Server sends a DHCP Offer back with the Option 43 Vendor Specific...
  • Page 50 // to specify a offset to where to start reading the VLAN ID VLAN_DHCP_TYPE=0 // to specify whether the VLAN ID is in 0=HEX or 1=ASCII format. VLAN_DHCP_LENGTH=4 // to specify the length of data should be collected to the VLAN ID 5/29/2009 Plantronics IP40 Administration Guide Page 50...
  • Page 51: Debugging And Troubleshooting

    Registration refused — the device tried to register but received some other type of SIP error response. The Plantronics Technical Assistance Center is ready to assist you. You can ask a question using e-mail, receive service over the Internet, or speak directly with a representative.
  • Page 52: Summary Of Led States

    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 red unlit Incoming call received, ringing 5/29/2009 Plantronics IP40 Administration Guide Page 52...

Table of Contents