Programming Manual for Virtual SIP CO Line Card
Table of contents
- Overview…………………………………………………………………………… 3
- Preparations for PC Programming…………………………………. 10
- Programming the V-SIPGW16 Card………………………………… 16
- Programming the V-SIPGW16 Card—Port Property………………………… 17
- Main…………………………………………………………………………………………… 18
- Account………………………………………………………………………………………. 20
- Register………………………………………………………………………………………. 22
- NAT……………………………………………………………………………………………. 24
- Option………………………………………………………………………………………… 25
- Calling Party………………………………………………………………………………… 27
- Called Party………………………………………………………………………………… 30
- Voice/FAX…………………………………………………………………………………… 31
- RTP/RTCP………………………………………………………………………………….. 34
- Programming the V-SIPGW16 Card—Port Property………………………… 17
3.1.10 T.38……………………………………………………………………………………………. 37
- 38 Option…………………………………………………………………………………. 39
- DSP……………………………………………………………………………………………. 40
- Supplementary Service…………………………………………………………………. 42
- Programming the V-SIPGW16 Card—Card Property……………………….. 45
- Programming the V-SIPGW16 Card—Shelf Property………………………. 48
- Maintenance…………………………………………………………………… 53
Index……………………………………………………………………………………. 58
1 Overview
This section provides an overview of the V-SIPGW16 card.
1.1 Information about IP Telephony Service
The Virtual 16-Channel SIP CO Line Card (V-SIPGW16) is a virtual CO line card which is designed to be easily integrated into an Internet Telephony Service provided by an ITSP (Internet Telephony Service Provider).
As a major SIP Provider, an ITSP provides its telephony service partly through the conventional telephone network (e.g., ISDN and Mobile), which is fee-based. An ISP (Internet Service Provider), another major SIP Provider, does not provide telephone connection itself. However, providing its users with Internet access, an ISP provides voice communication on the Internet for free. In this way, with VoIP technology based on the SIP protocol, the cost of voice communication can be much cheaper than conventional telephone networks.
The maximum of two V-SIPGW16 cards can be installed to the virtual CO line slots of the PBX. Therefore, the channel capacity of the card allows users to connect to up to 32 each different ISP/ITSPs.
V- SIPGW16 Connection Outline
The following diagram illustrates a simple VoIP network connecting the V-SIPGW16 card to the Internet.
Requirements for Internet Telephony Service
- You need to subscribe with an ISP for Internet
- You need to subscribe with an ITSP for telephone The ISP and ITSP may be part of the same company.
Note
- VoIP communication using the V-SIPGW16 card may deteriorate depending on the ITSP being
- VoIP communication using the V-SIPGW16 card may deteriorate depending on the network
DNS (Domain Name System)
A DNS server normally provides the name resolution service for your computer. As domain names are alphabetic, they are easier to remember. The Internet, however, is based on IP addresses. Therefore, every time a domain name is used, a DNS server must translate the name into the corresponding IP address, and vice versa. For example, the domain name www.example.com may be translated to 192.0.34.166. If one DNS server does not know how to translate a particular domain name, it asks another one, and so on, until the correct IP address is returned.
NAT (Network Address Translation) Traversal
When NAT/NAPT (Network Address Port Translation) is enabled, the router translates a local IP address from the PBX into a global IP address. However, the router with NAT enabled does not translate local IP addresses stored in SIP messages into global IP addresses.
Therefore, the address which the SIP Server recognizes as the destination IP address to reply to is actually the local IP address of the PBX, not the global IP address of the router. Therefore, if the SIP server receives a SIP message from the PBX and sends a message back to the PBX using the address stored in the SIP message, the packet information will not reach the PBX.
STUN Servers function to solve the global IP address problem under certain NAT conditions, for example, in case of full duplex communication. A STUN Server, used alongside the SIP Server, finds out the global IP address of the router with NAT enabled. With the STUN feature enabled, the packet information sent by the SIP Server is able to “traverse” NAT and reach the PBX.
The settings can be configured to specify whether to enable the NAT Traversal feature for each ISP/ITSP. In addition, the NAT Traversal method can be selected from “STUN” and “Fixed IP Address” (refer to
The V-SIPGW16 card may require the NAT Traversal feature to be enabled to connect to the WAN via a router. The following diagram illustrates how VoIP communication is enabled between the V-SIPGW16 card and the SIP Server (SIP Receiver) via a router with NAT enabled.
Note
- If an ISP/ITSP uses a device such as SBC (Session Border Controller), you may not have to enable the NAT Traversal
- A STUN Server is supplied by an ISP/ITSP, and not included with the
1.2 Important Notice for Subscription and Installation
1.2.1 Port Requirements
Required Ports for Each Channel
When configuring a router with NAT enabled, you need to secure a certain number of ports for each SIP and RTP/RTCP channel. For RTP/RTCP, the number of required ports is double the number of activated SIP CO lines (Ch). For SIP signaling, the number of required ports is always one regardless of the number of activated SIP CO lines (Ch).
<Example>
If 4 SIP CO line channels are activated, you need the following number of ports:
| Protocol Type | Required Port |
| RTP | 4 |
| RTCP | 4 |
| SIP | 1 |
| Total | 9 |
1.2.2 Firewall Requirements
If the VoIP network contains a firewall, you must configure the firewall to allow VoIP packets to pass through certain ports of the ports listed below without being blocked by filtering. The ports for which you need to configure the firewall may vary depending on the network conditions.
For more information, consult your network administrator.
[IP Packets to V-SIPGW16 Card]
| Port | TCP/UDP | Default Port No. |
| SIP Client Port | UDP | 35060 |
| STUN Client Port | UDP | 33478 |
| NAT Voice (RTP) UDP Port | UDP | 16000 to N |
| DNS (Client) Port | UDP | 30053 |
[IP Packets from V-SIPGW16 Card]
| Port | TCP/UDP | Default Port No. |
| SIP Server Port | UDP | 5060 |
| Registrar Server Port | UDP | 5060 |
| STUN Server Port | UDP | 3478 |
| Manual DNS Server Port | UDP | 53 |
Router Requirements
- Port Forwarding:
It may be necessary to set the NAT router so that it forwards the incoming packets to the IP address of the V-SIPGW16 card if all of the following conditions are met:
- the PBX uses a STUN server;
- a V-SIPGW16 card is located under a NAT router;
- incoming packets are routed to a SIP Client port or NAT Voice (RTP) UDP port indicated in the [IP Packets to V-SIPGW16 Card] table
- SIP-NAT Feature:
When a V-SIPGW16 card is located under a NAT router that supports the SIP-NAT feature*1, it is recommended to disable this feature.
*1 When NAT is enabled, the router translates the IP address stored in the IP header and the port number stored in the UDP header.
When SIP-NAT is enabled, the router also translates the IP address and port number stored in SIP messages.
1.2.3 Bandwidth Requirements
When using the V-SIPGW16 card, you must ensure that the WAN has enough bandwidth to support VoIP communications. Refer to the table below and ensure that the sum of the required bandwidth for each channel is smaller than the amount the WAN (e.g., ADSL network) can provide.
Note that the amount in the table is only a guide. Subscribe to a network that has enough bandwidth. If the amount of bandwidth required for VoIP communications is larger than what the network can accommodate, speech quality will be compromised.
Required Bandwidth for Each Channel
The required bandwidth depends on what combination of codecs and packet sending interval is used. Keep in mind the following points about the type of codec and packet sending interval, in terms of the speech quality:
- The speech quality of the codecs varies as follows: G.711 (High), G.729A (Low)
- The shorter the packet sending interval, the higher the speech
- The higher the speech quality the V-SIPGW16 card provides, the more bandwidth the WAN
|
Codec |
Packet Sending Interval | |||||
| 10 ms | 20 ms | 30 ms | 40 ms | 50 ms | 60 ms | |
| G.711 | 110.4 kbps | 87.2 kbps | 79.5 kbps | 75.6 kbps | 73.3 kbps | 71.7 kbps |
| G.729A | 54.4 kbps 31.2 kbps | 23.5 kbps | 19.6 kbps 17.3 kbps | 15.7 kbps | ||
1.3 Specifications
For details about the RFCs and protocols for the V-SIPGW16 card, refer to the following specifications.
| Items | Specification |
| SIP RFCs | RFC3261 (UDP only) |
| RFC3262 (PRACK) | |
| RFC3264 (Offer/Answer) | |
| RFC3311 (UPDATE) | |
| RFC3581 (Symmetric Response Routing/rport) | |
| RFC4028 (Session Timer) | |
| Codecs | G.711 (a-law and µ-law) |
| G.729A | |
| Voice Options | Echo Cancellation (48 ms) |
| Jitter Buffer (200 ms) | |
| VAD (Voice Activity Detection) | |
| PLC (Packet Loss Concealment) | |
| DTMF Relay | Inband/Outband (RFC2833)/Outband (SIP INFO) |
| Fax Relay | G.711 Inband/T.38 |
| Protocol/Function | RTP |
| RTCP | |
| DNS (A/SRV) | |
| NAT Traversal (STUN) | |
| QoS (ToS field setting in IP header of RTP/RTCP) |
2 Preparations for PC Programming
This section serves as reference operating instructions when using the Maintenance Console software to program the V-SIPGW16 card.
2.1 Maintenance Console Operating Instructions
2.1.1 Installing and Starting the Maintenance Console
System programming, diagnosis and administration for the V-SIPGW16 card can be performed with a PC using the Maintenance Console. This section describes how to install and start the Maintenance Console.
System Requirements
Required Operating System
- Microsoft® Windows® XP or Windows Vista® Business operating system
Minimum Hardware Requirements
- HDD: 100 MB of available hard disk space
Recommended Display Settings
- Screen resolution: XGA (1024 ´ 768)
- DPI setting: Normal size (96 DPI)
Hardware Requirements
- Make sure that the PBX, IPCMPR (for KX-TDE100/KX-TDE200)/IPCEMPR (for KX-TDE600) card, and DSP card are
- Make sure that the PBX is fully connected to your
Note
For details about installation, refer to “3 Installation” in the Installation Manual.
Trademarks
- Microsoft, Windows and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other
- All other trademarks identified herein are the property of their respective
- Microsoft product screen shot(s) reprinted with permission from Microsoft
Copyright for MD5
This software uses the Source Code of RSA Data Security, Inc. described in the RFC1321 (MD5Message-Digest Algorithm).
Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.
License to copy and use this software is granted provided that it is identified as the “RSA Data Security, Inc. MD5 Message-Digest Algorithm” in all material mentioning or referencing this software or this function.
License is also granted to make and use derivative works provided that such works are identified as “derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm” in all material mentioning or referencing the derived work.
RSA Data Security, Inc. makes no representations concerning either the merchantability of this software or the suitability of this software for any particular purpose. It is provided “as is” without express or implied warranty of any kind.
These notices must be retained in any copies of any part of this documentation and/or software.
Installing the Maintenance Console
Note
- Make sure to install and use the latest version of the Maintenance
- To install or uninstall the software on a PC running Windows XP Professional, you must be logged in as a user in either the “Administrators” or “Power Users”
- To install or uninstall the software on a PC running Windows Vista Business, you must be logged in as a user in the “Administrators”
- Product specifications, including text displayed by the software, are subject to change without
- Copy the setup file of the Maintenance Console to your
- Double-click the setup file to run the
- Follow the on-screen instructions provided by the installation
Starting the Maintenance Console and Assigning the Basic Items (Quick Setup)
When you start the Maintenance Console with the Installer Level Programmer Code and connect to the PBX for the first time after initialization (with the factory default setting), Quick Setup will launch automatically. During Quick Setup, you will set up the basic items. For details about the basic items, refer to “14.1.2 Quick Setup” in the Feature Manual.
- Connect the PC to the PBX with an Ethernet straight cable or RS-232C cross
- Start the Maintenance Console from the Start
- “Information before programming”
- Carefully read this important additional information, which includes updates to this and other manuals.
- Click OK to close this
- Enter the Installer Level Programmer Code (default: INSTALLER).
- Click OK.
- Click Connect.
- Select KX-TDE600 from PBX Model.
- Select the LAN or RS-232C tab, depending on the type of PC connection with the
- Specify the settings as
Note
When connecting to the PBX for the first time selecting LAN, the IP Address and Port Number must be set to 192.168.0.101 and 35300 respectively.
- Enter the system password for installer (default: 1234).
- Click Connect.
- Follow the instructions of the Quick Setup wizard for the basic items in Quick
- On the IP addressing information screen, the information for the IPCMPR/IPCEMPR card can be assigned automatically through a DHCP server or entered
Note
If you change any information on this screen and click Apply, the PBX will need to be reset.
When using a DHCP server:
- Select Enable for the DHCP Client
- Click Apply.
Note
The boxes will turn grey and the IP addresses will be assigned automatically after the PBX is reset.
When not using a DHCP server:
- Select Disable for the DHCP Client
- For KX-TDE100/KX-TDE200, type the IP address of the IPCMPR card in the IP Address for IPCMPR Card For KX-TDE600, type the IP address of the IPCEMPR card in the IP Address for IPCEMPR Card box.*1
- In the IP Address for VoIP-DSP box, type the IP address of the DSP16 or DSP64 *2
- In the Subnet Mask box, type the subnet mask address of the *3
- In the Default Gateway box, type the IP address of the default *4
- Click Apply.
When using a DHCP server to obtain a DNS server IP address automatically:
- Select DHCP for the DNS Server Address Method
- Click Apply.
Note
The boxes will turn grey and the IP addresses will be assigned automatically after the PBX is reset.
When not using a DHCP server to obtain a DNS server IP address automatically:
- Select Manual for the DNS Server Address Method
- In the Manual Preferred DNS Server IP Address box, type the IP address of the preferred DNS server.
- In the Manual Alternate DNS Server IP Address box, type the IP address of the alternate DNS server.
- Click Apply.
- Follow the instructions of the Quick Setup wizard in Quick
The system menu appears. You may now begin programming the PBX.
Notice
- Do not change the IP addresses of the IPCMPR/IPCEMPR and DSP cards once IP telephones are registered to the PBX using these IP
The IP telephones will not operate properly if these IP addresses are changed.
- A DHCP server must be able to use a “client identifier” option specified by RFC
- The PBX will not start properly if the IP addresses cannot be assigned automatically by the DHCP server when DHCP Client is set to Enable. In this case, you need to consult your network administrator because the DHCP server on your network may not be running or a network failure may have occurred. If the DHCP server cannot be available, change the DHCP Client setting to Disable and set fixed IP addresses, then restart the
To change the DHCP Client setting, connect the PC with an RS-232C cross cable or Ethernet straight cable. When connecting the PC with an Ethernet straight cable, make sure the PBX is disconnected from the LAN and then connect the PC with an Ethernet straight cable using 192.168.0.101 for the IP address of the IPCMPR/IPCEMPR card.
*1 Valid IP address range: “1.0.0.0” to “223.255.255.255”
*2 Valid IP address range: “1.0.0.0” to “223.255.255.255”
*3 Valid subnet mask address range: “0–255.0–255.0–255.0–255” (except 0.0.0.0 and 255.255.255.255)
*4 Valid IP address range: “1.0.0.0” to “223.255.255.255”
2.2 Installing the V-SIPGW16 Card to the PBX
- Under Configuration, click Slot.
- Move the mouse pointer over the white PBX image at the bottom of the screen for the virtual slots.
- Click Select Shelf.
- Click on the name of the V-SIPGW16 card. An image of the card will be displayed.
- Drag the image of the card to a Trunk slot and release it. The card will move into the slot space.
- Click Yes to
3 Programming the V-SIPGW16 Card
This section serves as reference operating instructions when using the Maintenance Console software to program the V-SIPGW16 card.
3.1 Programming the V-SIPGW16 Card—Port Property
Various settings can be programmed for each virtual SIP gateway port. To change the status of virtual SIP gateway ports, click Command.
Accessing Port Properties
- Under Configuration, click Slot.
- Move the mouse pointer over the white PBX image at the bottom of the screen for the virtual
- Click Select Shelf.
- Move the mouse pointer over the V-SIPGW16
- Click Port Property.
Programming Port Property
Some of the parameters can be automatically programmed by selecting the desired SIP provider for each virtual SIP gateway port.
Icon Description
In this section, the following icons show the different parameter type.
| Icon | Description for Parameter Type |
| Programmed automatically by selecting the desired SIP provider in Select Provider. | |
| Manual programming is compulsory. | |
| Manual programming is compulsory under certain conditions. | |
| Not marked | Manual programming is optional. |
Automatic Programming
Some of the parameters on this screen can be automatically programmed by selecting the desired SIP provider for each virtual SIP gateway port. A maximum of 32 SIP providers can be programmed, and a different SIP provider can be assigned to each virtual SIP gateway port.
Follow the steps below to configure a SIP provider.
- Click Select Provider.
A dialog box will appear. Available virtual SIP gateway port numbers are displayed in the list.
- From the Provider menu, select the desired SIP
- Highlight the desired port numbers or click Select All to select all the virtual SIP gateway port numbers to be assigned to the SIP provider selected in step 2.
- Click Execute.
- Click OK.
- Click Apply.
Appropriate setting values designated by the SIP provider will be set in the parameters for the virtual SIP gateway ports.
Manual Programming
Follow the steps below to program the parameters which are not automatically programmed by selecting a provider.
- Click a desired
- Enter information or select from the list for each
Adding Settings to Provider Profiles
Follow the steps below to add the settings to provider profiles.
- Click Add Provider.
A dialog box will appear. Available virtual SIP gateway port numbers are displayed in the list.
- Highlight the desired port numbers or click Select All to select all the virtual SIP gateway port numbers to add the settings to provider
- Click Execute.
3.1.1 Main
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Channel Attribute
Specifies the channel property of each port to enable several sessions to be performed for one subscription with the SIP provider.
Default
Not Used
Value Range
Basic channel: The subscriber channel that is assigned the SIP registration information.
Additional channel for ChN (N=1–16): The subordinative channel that uses the same registration information as a Basic channel for SIP sessions. Select the Basic channel number to which the Additional channel belongs. Not Used: The channel is not in use.
Provider Name
Specifies the name of the SIP provider.
Default
Not stored.
Value Range
Max. 20 characters
SIP Server Location—Name
Specifies the domain name of the SIP proxy server.
Note
Specifies the domain name of the SIP proxy server.
Default
Not stored.
Value Range
Max. 100 characters
SIP Server Location—IP Address
Specifies the IP address of the SIP proxy server. This setting is compulsory when not using the DNS server.
Note
Specify the IP address of the outbound proxy server, if provided by the SIP provider.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
SIP Server Port Number
Specifies the port number of the SIP proxy server.
Default
5060
Value Range
1–65535
SIP Service Domain
Specifies the domain name provided by the SIP provider.
Default
Not stored.
Value Range
Max. 100 characters
Subscriber Number
Specifies the number used as the CLIP number.
Default
Not stored.
Value Range
Max. 16 digits (consisting of 0–9, *, and #)
3.1.2 Account
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
User Name
Specifies the user name (SIP Account) provided by the SIP provider.
Default
Not stored.
Value Range
Max. 64 characters
Authentication ID
Specifies the authentication ID required for registration with the SIP server.
Default
Not stored.
Value Range
Max. 64 characters
Authentication Password
Specifies the authentication password used for registration with the SIP provider.
Default
Not stored.
Value Range
Max. 32 characters
3.1.3 Register
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Register Ability
Specifies whether to send the REGISTER message to the SIP server.
Default
Enable
Value Range
Disable, Enable
Register Sending Interval
Specifies the maximum length of interval time after which the PBX sends the REGISTER message.
Default
3600 s
Value Range
10–86400 s
Un-Register Ability when port INS
Specifies whether to unregister the previous registration and send the REGISTER message to the SIP server when the port status is set back to INS.
Default
Enable
Value Range
Disable, Enable
Registrar Server—Name
Specifies the domain name of the SIP registrar server.
Default
Not stored.
Value Range
Max. 100 characters
Registrar Server—IP Address
Specifies the IP address of the SIP registrar server. This setting is compulsory when a register IP address is provided.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
Registrar Server Port Number
Specifies the port number of the SIP registrar server.
Default
5060
Value Range
1–65535
3.1.4 NAT
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
STUN Server—Name
Specifies the domain name of a STUN server.
Default
Not stored.
Value Range
Max. 100 characters
STUN Server—IP Address
Specifies the IP address of the STUN server. This setting is compulsory when the STUN method is selected and a DNS server is not used.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
STUN Server Port Number
Specifies the port number of the STUN server.
Default
3478
Value Range
1–65535
3.1.5 Option
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Session Refresh (Session Timer)—Session Timer Ability
Enables the PBX to periodically refresh SIP sessions by sending repeated requests.
Default
Enable (Passive)
Value Range
Disable: This feature is not activated.
Enable (Active): Activates this feature only if the other device supports the feature. Enable (Passive): Activates this feature only when requested by the other device.
Session Refresh (Session Timer)—Session Expire Timer
Specifies the length of time that the PBX waits before terminating SIP sessions when no reply to the repeated requests is received.
Default
180 s
Value Range
90–3600 s
Session Refresh (Session Timer)—Refresh Method
Specifies the type of request that the PBX sends to periodically refresh SIP sessions.
Default
re-INVITE
Value Range
UPDATE, re-INVITE
Proxy-Require Option
Specifies option tags in a Proxy-Require header field so that the SIP server is notified that the client is behind a router with NAT enabled and firewall.
Default
Not stored.
Value Range
Max. 100 characters
3.1.6 Calling Party
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Header Type
Specifies the header of the SIP message in which the caller information is stored.
Default
From Header
Value Range
From Header, P-Preferred-Identity Header
From Header—User Part
Specifies the value to be stored in the username part of the SIP-URI of the From header.
Default
User Name
Value Range
User Name, Authentication ID, PBX-CLIP
From Header—SIP-URI
Specifies the complete SIP-URI address of the From header. The configuration in From Header—User Part
will be invalid if this parameter is set.
Default
Not stored.
Value Range
Max. 100 characters
P-Preferred-Identity Header—User Part
Specifies the value to be stored in the username part of the SIP-URI of the P-Preferred-Identity header.
Default
User Name
Value Range
User Name, Authentication ID, PBX-CLIP
P-Preferred-Identity Header—SIP-URI
Specifies the complete SIP-URI address of the P-Preferred-Identity header. The configuration in
P-Preferred-Identity Header—User Part will be invalid if this parameter is set.
Default
Not stored.
Value Range
Max. 100 characters
Number Format
Selects the format of the CLIP number to be sent to the called party.
Default
National
Value Range
International, +International, National
Remove Digit
Specifies the number of leading digits of the CLIP number to be removed. This setting is compulsory when
PBX-CLIP is selected in From Header—User Part or P-Preferred-Identity Header—User Part.
Default
0
Value Range
0–32
Additional Dial
Specifies the number to be added to the CLIP number in the place of the removed digits. This setting is compulsory when PBX-CLIP is selected in From Header—User Part or P-Preferred-Identity Header—User Part.
Default
Not stored.
Value Range
Max. 20 digits (containing of 0–9, *, and #)
Anonymous format in “From” header
Specifies the format of the “From” header when not sending caller ID.
Default
Display name and SIP-URI
Value Range
Display name and SIP-URI, Display name only
Note
If “Display name and SIP-URI” is selected, the display name part and the SIP-URI of the “From” header will be displayed as “Anonymous“.
[Example]
From: Anonymous <sip:anonymous@anonymous.invalid>
If “Display name only” is selected, only the display name part of the “From” header will be displayed as “Anonymous“.
[Example]
From: Anonymous <sip:1234@example.com>
3.1.7 Called Party
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Number Format
Specifies the format of an incoming call number.
Default
National
Value Range
International, +International, National
Type
Specifies the header of the incoming SIP message in which the dialed number is stored.
Default
To header
Value Range
Request-URI, To header
3.1.8 Voice/FAX
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
IP Codec Priority—1st, 2nd, 3rd
Specifies the priority of the codecs to be used. None is only available for 2nd and 3rd priorities.
Default
1st: G.711A 2nd: G.711µ 3rd: G.729A
Value Range
G.711A, G.711µ, G.729A, None
Packet Sampling Time (G.711A)
Specifies the time interval between measurements (samples) of sound data during a conversation. The smaller this number, the higher the quality of the transmitted sound.
Default
20 ms
Value Range
10 ms, 20 ms, 30 ms, 40 ms, 50 ms, 60 ms
Packet Sampling Time (G.711µ)
Specifies the time interval between measurements (samples) of sound data during a conversation. The smaller this number, the higher the quality of the transmitted sound.
Default
20 ms
Value Range
10 ms, 20 ms, 30 ms, 40 ms, 50 ms, 60 ms
Packet Sampling Time (G.729A)
Specifies the time interval between measurements (samples) of sound data during a conversation. The smaller this number, the higher the quality of the transmitted sound.
Default
20 ms
Value Range
10 ms, 20 ms, 30 ms, 40 ms, 50 ms, 60 ms
Voice Activity Detection for G.711
Enables the use of the Voice Activity Detection feature for the G.711 codec. This feature conserves bandwidth by detecting silent periods during a call and suppressing the packets of silence from being sent to the network.
Default
Disable
Value Range
Disable, Enable
FAX Sending Method
Specifies the method of transporting the fax signal.
Default
G.711 Inband
Value Range
G.711 Inband, T.38
Maximum Bit Rate
Specifies the maximum bit rate of the fax signal.
Default
No Speed Limit
Value Range
No Speed Limit, 2400 bps, 4800 bps, 7200 bps, 9600 bps, 12000 bps, 14400 bps
FAX Detection Ability
Enables the use of the FAX Detection Ability feature. This feature enables end-to-end fax signal relay when the other party prefers a codec other than G.711. This feature functions only if the other party supports G.711.
Default
Enable
Value Range
Disable, Enable
DTMF
Specifies the method to transport DTMF tones.
Default
Outband (RFC2833)
Value Range
Inband, Outband (RFC2833), Outband (SIP INFO)
Payload Type
Specifies the payload type of RFC2833 for DTMF tones.
Note
Manual programming is required if DTMF is set to Outband (RFC2833).
Default
101
Value Range
96–127
3.1.9 RTP/RTCP
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current slot number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
RTP QoS Ability
Specifies the type of value to be stored in the ToS field in the IP header.
Default
ToS
Value Range
ToS, DSCP, HEX
RTP QoS-ToS Priority
Specifies the priority level in the ToS field.
Default
0
Value Range
0–7
RTP QoS-ToS Type
Specifies the ToS type in the ToS field.
Default
Normal
Value Range
Normal, Monetary Cost, Reliability, Throughput, Delay
RTP QoS-DSCP
Specifies the value in the ToS field by a DSCP for DiffServ.
Default
Not stored.
Value Range
0–63
RTP QoS-HEX
Specifies the value in the ToS field by a hexadecimal number.
Default
Not stored.
Value Range
00–FF
RTCP Packet Sending Ability
Specifies whether to enable each port to send RTCP packets.
Default
Enable
Value Range
Disable, Enable
RTCP Packet Interval
Specifies the interval time until the next RTCP packet is sent.
Default
5 s
Value Range
5–60 s
3.1.10 T.38
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
T38 FAX Max Datagram
Specifies the maximum datagram size when using the T.38 protocol.
Default
512
Value Range
272–512
T38 FAX UDPTL Error Correction – Redundancy
Specifies whether to enable the redundancy feature when using the T.38 protocol.
Default
Enable
Value Range
Disable, Enable
T38 FAX UDPTL Redundancy count for T.30 messages
Specifies the redundancy count for T.30 messages when using the T.38 protocol.
Default
3
Value Range
0–7
T38 FAX UDPTL Redundancy count for data
Specifies the redundancy count for data when using the T.38 protocol.
Default
0
Value Range
0–3
T38 FAX Rate Management Method
Specifies the rate management method when using the T.38 protocol.
Default
Transferred TCF
Value Range
Transferred TCF, Local TCF
3.1.11 T.38 Option
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
T38 FAX QoS Available
Specifies the type of value to be stored in the ToS field in the IP header when using the T.38 protocol.
Default
ToS
Value Range
ToS, DSCP, HEX
T38 FAX QoS-ToS Priority
Specifies the priority level in the ToS field when using the T.38 protocol.
Default
0
Value Range
0–7
T38 FAX QoS-ToS Type
Specifies the ToS type in the ToS field when using the T.38 protocol.
Default
Normal
Value Range
Normal, Monetary Cost, Reliability, Throughput, Delay
T38 FAX QoS-DSCP
Specifies the value in the ToS field by a DSCP for DiffServ when using the T.38 protocol. This setting is compulsory when DSCP is selected in T38 FAX QoS Available.
Default
Not stored.
Value Range
0–63
T38 FAX QoS-HEX
Specifies the value in the ToS field by a hexadecimal number when using the T.38 protocol. This setting is compulsory when HEX is selected in T38 FAX QoS Available.
Default
Not stored.
Value Range
00–FF
3.1.12 DSP
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
Echo Canceller Ability
Specifies the echo canceller ability time.
Default
48 ms
Value Range
OFF, 48 ms, 128 ms
DSP Digital Gain (Down)
Specifies the DSP Digital Gain for the down voice path.
Default
0 dB
Value Range
-14–6 dB
DSP Digital Gain (Up)
Specifies the DSP Digital Gain for the up voice path.
Default
0 dB
Value Range
-14–6 dB
EC Gain
Specifies the Echo Canceller Gain.
Default
0 dB
Value Range
-14–6 dB
NLP Setting
Specifies the NLP (Non-Linear Processor) setting to control echo sound quality.
Default
Weak
Value Range
Disable, Weak, Normal, Strong
3.1.13 Supplementary Service
Shelf
Indicates the shelf position (reference only).
Default
Current shelf type
Value Range
Shelf type
Slot
Indicates the slot position (reference only).
Default
Current slot number
Value Range
Slot number
Port
Indicates the port number (reference only).
Default
Current port number
Value Range
Port number
Connection
Indicates the port status.
This column offers two ways to open the screen to select the port command:
- Click the desired cell in the
- Select the desired cell in the column, and then click Command.
Default
Current status
Value Range
INS: The port is in service. OUS: The port is out of service.
Fault: The port is not communicating with the network.
CLIR
Specifies whether to allow restriction of the display of the CLIP number on the called party’s telephone when making a SIP CO line call.
Default
Yes
Value Range
Yes, No
CNIP (Send)
Specifies whether to send the caller’s name to be displayed on the called party’s telephone when making a SIP CO line call.
Default
Yes
Value Range
Yes, No
CNIP (Receive)
Specifies whether to receive the caller’s name to be displayed on the called party’s telephone when receiving a SIP CO line call.
Default
No
Value Range
Yes, No
3.2 Programming the V-SIPGW16 Card—Card Property
3.2.1 Card Property
The properties of the V-SIPGW card can be specified. To program the parameters, click Common Settings, and set the desired value.
Accessing Card Properties
- Under Configuration, click Slot.
- Move the mouse pointer over the white PBX image at the bottom of the screen for the virtual
- Click Select Shelf.
- Move the mouse pointer over the V-SIPGW16
- Click Card Property.
Programming Card Property
Icon Description
In this section, the following icons show the different parameter type.
| Icon | Description for Parameter Type |
| Manual programming is compulsory under certain conditions. | |
| Not marked | Manual programming is optional. |
DNS Server IP Address Method
Specifies the method of IP address assignment for a DNS server. When selecting DHCP, the DNS server IP address can be assigned automatically by a DHCP server. When selecting Manual, the DNS server IP address must be assigned manually.
Default
Manual
Value Range
DHCP, Manual
DHCP Preferred DNS Server IP Address
Indicates the IP address of the preferred DNS server assigned automatically by the DHCP server (reference only).
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
DHCP Alternate DNS Server IP Address
Indicates the IP address of the alternate DNS server assigned automatically by the DHCP server (reference only).
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
Manual Preferred DNS Server IP Address
Specifies the IP address of the preferred DNS server manually. This setting is compulsory if a DNS server IP address is not assigned automatically.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
Manual Alternate DNS Server IP Address
Specifies the IP address of the alternate DNS server manually.
Note
If Manual Preferred DNS Server IP Address is programmed, this setting is optional. However, if possible, it is recommended to specify Manual Alternate DNS Server IP Address as well.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
Manual DNS Server Port Number
Specifies the port number of the DNS server.
Default
53
Value Range
1–65535
DNS Port Number
Specifies the port number of the PBX used for communication with the DNS server.
Default
30053
Value Range
1–65535
DNS Retry Interval Timer
Specifies the length of time until a query is retried when no response is received from the DNS server.
Default
3
Value Range
1–10 s
DNS Retry Counter
Specifies the number of times that a query is retried when no response is received from the DNS server.
Default
2
Value Range
1–10
DNS SRV Record Resolve Ability
Specifies whether to request that the DNS server translates domain names into IP addresses using the DNS SRV record.
Default
Enable
Value Range
Disable, Enable
3.3 Programming the V-SIPGW16 Card—Shelf Property
Common settings for all of the V-SIPGW cards installed in the IPCMPR (for KX-TDE100/KX-TDE200)/ IPCEMPR (for KX-TDE600) Virtual Shelf can be programmed.
Accessing Shelf Properties
- Under Configuration, click Slot.
- Move the mouse pointer over the white PBX image at the bottom of the screen for the virtual
- Click Select Shelf.
- Move the mouse pointer over the V-SIPGW16
- Click Shelf Property.
Programming Shelf Property
Icon Description
In this section, the following icons show the different parameter type.
| Icon | Description for Parameter Type |
| Manual programming is compulsory under certain conditions. | |
| Not marked | Manual programming is optional. |
3.3.1 Main
SIP Client Port Number
Specifies the port number of the PBX used for communications with the SIP server.
Default
35060
Value Range
1–65535
NAT Traversal
Specifies the NAT traversal method.
- STUN: A STUN Server, used alongside the SIP Server, finds out the global IP address of the router with NAT
- Fixed IP Address: The global IP address of the router with NAT enabled is
Note
Manual programming is optional except when programming is required depending on the network conditions.
Default
Off
Value Range
Off, Fixed IP Addr., STUN
NAT – Voice (RTP) UDP Port No.
Specifies the starting port number of the dynamic ports used for NAT Traversal.
Default
16000
Value Range
2–65000 (even number only)
NAT – Keep Alive Packet Sending Ability
Specifies whether to send Keep Alive packets in order to maintain the NAT binding information. This setting may be compulsory depending on the network conditions.
Default
Disable
Value Range
Disable, Enable
NAT – Keep Alive Packet Type
Specifies the type of Keep Alive packets to be sent out.
Default
Blank UDP
Value Range
Blank UDP, None
NAT – Keep Alive Packet Sending Interval
Specifies the interval time until the next Keep Alive packet is sent.
Note
It is required to set this interval shorter than the NAT binding time of the router. The default value is appropriate in most cases.
Default
20 s
Value Range
1–60 s
NAT – Fixed Global IP Address
Specifies the global IP address of the router with NAT enabled. This setting is compulsory if Fixed IP Addr.
is selected in NAT Traversal.
Default
Not stored.
Value Range
1.0.0.0–223.255.255.255
STUN Ability
Specifies whether to open a protocol port of the STUN server to enable STUN feature.
Default
Disable
Value Range
Disable, Enable
STUN Client Port Number
Specifies the port number of the PBX used for communications with the STUN server.
Default
33478
Value Range
1–65535
STUN External Address Detection Retry Counter
Specifies the number of times that a query is retried when no response is received from the STUN server.
Default
1
Value Range
0–8
STUN Resending Interval
Specifies the length of time until a query is retried when no response is received from the STUN server.
Default
500 ms
Value Range
0–1600 ms
SIP Called Party Number Check Ability
Specifies whether to receive a SIP CO line call when receiving the INVITE message with an incorrect target SIP-URI. The setting specified here is also applied when the request header is blank or contains characters that can not be modified to a receivable number.
Default
Disable (High->Low)
Value Range
Disable (High->Low), Disable (Low->High), Enable
Symmetric Response Routing Ability
Enables this feature to request that the SIP server sends the response back to the source IP address and port from which the request originated.
Default
Enable
Value Range
Disable, Enable
100rel Ability
Specifies whether to add the option tag 100rel to the header field of the INVITE message.
Default
Enable (Passive)
Value Range
Disable: This feature is not activated.
Enable (Active): Activates this feature only if the other device supports the feature. Enable (Passive): Activates this feature only when requested by the other device.
Ringback Tone to Outside Caller
Enables the PBX to send a ringback tone to an outside caller when the network cannot send the tone.
Default
Disable
Value Range
Disable, Enable
3.3.2 Timer
SIP T1
Specifies the retransmission interval time for INVITE requests and responses.
Default
5 x 100 ms
Value Range
5–255 ´ 100 ms
SIP T2
Specifies the retransmission interval time for INVITE responses and non-INVITE requests.
Default
40 x 100 ms
Value Range
40–255 ´ 100 ms
4 Maintenance
This section serves as reference operating instructions for data management of the
V-SIPGW16 card using the Maintenance Console software.
4.1 Configuration Management
4.1.1 Importing/Exporting V-SIPGW16 Configuration Data and Provider Profiles
The configuration data (V-SIPGW16 card—Port Property) or provider profiles (if updated provider profiles are available) for the V-SIPGW16 card can be exported or imported using the Import/Export tool.
Follow the steps below to import or export the configuration data or provider profiles:
Note
To access the following menu options, you must be logged in to the Maintenance Console in Batch or Interactive mode at Installer level. For details about the software mode and access level, refer
to “2.1.1 Starting Maintenance Console and Software Modes” and “2.1.2 Access Levels” in the PC Programming Manual.
[Provider Profiles]
To import provider profiles
- From the Tool menu, point to Import, and then click V-SIPGW16 Provider to
- Navigate to the folder containing the provider profiles you want to
- Select the file.
- Click Open to open the
- Click OK.
To export provider profiles
- From the Tool menu, point to Export, and then click V-SIPGW16 Provider to
- Navigate to the folder in which you want to save the
- Enter a file
- Click Save.
- Click OK.
[Configuration Data (V-SIPGW16 card—Port Property)]
To import configuration data
- From the Tool menu, point to Import, and then click V-SIPGW16 Settings to
- Navigate to the folder containing the provider profiles you want to
- Select the file.
- Click Open to open the
- Click OK.
To export configuration data
- From the Tool menu, point to Export, and then click V-SIPGW16 Settings to
- Navigate to the folder in which you want to save the
- Enter a file
- Click Save.
- Click OK.
Note
You cannot select which fields are imported or exported. The configuration data for all fields will be automatically imported or exported.
4.1.2 V-SIPGW16 Protocol Trace
The trace data of protocol activity can be collected from the V-SIPGW16 card and saved to the PC, using the utility, V-SIPGW16 Protocol Trace.
This option requires that the target V-SIPGW16 card be set to INS status. Follow the steps below to trace and file V-SIPGW16 card protocol activity:
Note
To access the following menu options, you must be logged in to the Maintenance Console in Batch or Interactive mode at Installer level. For details about the software mode and access level, refer
to “2.1.1 Starting Maintenance Console and Software Modes” and “2.1.2 Access Levels” in the PC Programming Manual.
To save trace data to the SD Memory Card
- From the Utility menu, select V-SIPGW16 Protocol Trace.
When the progress bar disappears, the protocol trace is complete. The trace data has been saved to the SD Memory Card (file name: “PRTSIPC”).
To transfer trace data to the PC
- From the Utility menu, select File Transfer PBX (SD Card) to PC. The list of trace data files will be
- Select the desired trace data
- Click Transfer.
- Navigate to the folder in which you want to save the
- Enter a file
- Click Save.
- Click OK.
5 Appendix
5.1 Revision History
5.1.1 KX-TDE100/KX-TDE200 PMMPR Software File Version 3.0xxx
New Contents
Changed Contents
Starting the Maintenance Console and Assigning the Basic Items (Quick Setup)
5.1.2 KX-TDE600 PGMPR Software File Version 3.0xxx
New Contents
Changed Contents
Starting the Maintenance Console and Assigning the Basic Items (Quick Setup)
Index
Index
A
Accessing Card Properties 45 Accessing Port Properties 17 Accessing Shelf Properties 48
Adding Settings to Provider Profiles, Port Property 18 Automatic Programming, Port Property 17
B
Bandwidth Requirements 8
C
Card Property, Icon Description 45 Card Property, Programming 45 Configuration Management 54
D
DHCP Server 13
DNS (Domain Name System) 5 DNS Server 5
F
Firewall Requirements 7 Fixed IP Address 5
H
Hardware Requirements 11
I
Icon Description, Card Property 45 Icon Description, Port Property 17 Icon Description, Shelf Property 48
Important Notice for Subscription and Installation 7 Installing and Starting the Maintenance Console 11 Installing the V-SIPGW16 Card to the PBX 15
ISP (Internet Service Provider) 4
ITSP (Internet Telephony Service Provider) 4
M
Maintenance 53
Manual Programming, Port Property 17
N
NAT (Network Address Translation) Traversal 5
P
Port Property, Automatic Programming 17 Port Property, Icon Description 17
Port Property, Manual Programming 17 Port Requirements 7
Programming Card Property 45 Programming Port Property 17 Programming Shelf Property 48
Provider Profiles 54
Q
Quick Setup 12
R
Required Bandwidth for Each Channel 8
Revision History, KX-TDE100/KX-TDE200 PMMPR Software File Version 3.0xxx 57
Revision History, KX-TDE600 PGMPR Software File Version 3.0xxx 57
Router Requirements 8
S
SBC (Session Border Controller) 6 Shelf Property, Icon Description 48 Specifications 9
System Requirements 11
V
V-SIPGW16 Connection Outline 4 V-SIPGW16 Protocol Trace 55
Panasonic Manuals www.voicesonic.com
Phone 877-289-2829
Copyright:
This material is copyrighted by Panasonic System Networks Co., Ltd., and may be reproduced for internal use only. All other reproduction, in whole or in part, is prohibited without the written consent of Panasonic System Networks Co., Ltd.
© Panasonic System Networks Co., Ltd. 2009
PSQX4501XA KK1108TE2129