IDM-TOP Terminal User Manual V1.1 Ethernet over E1 Converter (IP over TDM)
IDM-TOP Terminal User Manual
Ver 1.1
2008-9
1.1. Console Interface Configuration
Appendix 1 Ethernet Throughput
Appendix 2 Jitter Buffer configuration
1.1. Console Interface Configuration
Using the RS232 cable connects the PC serial port and IDM-TOP terminal interface (DB9), runs the terminal simulation program, such as: HyperTerminal.
The configuration should be:
Baud Rate: 115200
Data Bit: 8
Odd/Even Check:None
Stop Bit: 1
Flow control: None
Terminal Type: VT100
The system needs the user input the username and password to login.
The default user:
User: admin
Password: admin
After the system boot up, the terminal show the prompt to get operator command.
IDM-TOP>
Command |
Description |
system information |
Display the device software/hardware version and MAC address. |
system mac config |
Configure the device MAC address |
system ip |
Display the device IP address, subnet mask, default gateway. |
system ip config |
Configure the device IP address, subnet mask, default gateway. |
Example1: Show the system information.
IDM-TOP> system i
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++System Information+++
MAC address (00-10-05-11-04-12)
Version time: (2008-06-14 13:50:00)
Boot version: (1.02)
Application version (1.00)
+++++++++++++++++++++++++++++++++++++++++++++++++++
Example2: Show the system IP information.
IDM-TOP> system ip
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++System IP+++
IP Address (current : 10.153.70.21)
IP Mask (current : 255.255.255.0)
Default Gateway (current : 0.0.0.0)
+++++++++++++++++++++++++++++++++++++++++++++++++++
Example3: Configure the system IP address.
IDM-TOP> system ip c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++System IP Config+++
IP Address (current : 10.153.70.21)10.153.70.21
IP Mask (current : 255.255.255.0)
Default Gateway (current : 0.0.0.0)
Change IP will reboot . Are you sure to do change?[0:NO, 1:Yes]1
Example4: Configure the system IP address and Gateway
Note: If the target TOP device is not in the same subnet of current device, a router is needed, administrator should set the default gateway to router IP. The following diagrams show the application.
The device A configuration:
IDM-TOP > system ip c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++System IP Config+++
IP Address (current : 0.0.0.0)192.168.0.150
IP Mask (current : 255.255.255.0)
Default Gateway (current : 192.168.0.100)
Change IP will reboot . Are you sure to do change?[0:NO, 1:Yes]1
Note: The bundle configuration also provides the gateway configuration options, either system or bundle config will active the gateway.
Example5: Configure the system MAC address.
IDM-TOP > system mac c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++System MAC Config+++
MAC Address (current : 0:10: 5:11: 4:12)
Change MAC will reboot . Are you sure to do change?[0:NO, 1:Yes]1
Note1: Before the bundle configuration, pls configure the correlative TDM port features firstly.
Note2: When the TDM port features are changed, the correlative bundle will be deleted automatically by the system, pls reconfigure the bundle anew.
【Command Syntax】tdm <tdm Port Number> <Sub Command>
【Description】
Parameter |
Description |
Tdm Port Number |
Range: 1-8. |
Sub Command |
See the following table. |
Sub Command |
Description |
config |
Configure the TDM port features |
information |
Display the TDM port features |
loopback |
Configure the TDM port internal/external loopback |
statistic |
Display the TDM port current and history performance statistics |
【config Sub Command Parameter Description】
Parameter |
Description |
Admin status |
Configure TDM port management status |
Clock source |
TDM port transmits clock source selection. RxClk: The correlative E1 port uses the receive line clk to transmit. Adaptive: The correlative E1 port uses the recovery clock to transmit.(Adaptive: mean recovery clock from PSN). Internal: The correlative E1 port uses the system clock to transmit, This option is not recommended. |
Rx sensitivity |
Short Haul, Long Haul |
Line type |
Unframed Framed without CRC (G.704) Framed with CRC (G.704) Multi-Framed without CRC (G.704) Multi-Framed with CRC (G.704). |
Line code |
HDB3, AMI |
Line impedance |
Balanced, Unbalanced. (Balanced 120Ω is default). |
Example1: Show the system all the TDM ports features.
IDM-TOP> show tdm
TDM TABLE
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Port number Admin bit Line type Clock Loop status
======================================================================
0 Enable MF Adaptive Disable
1 Enable Unframed Adaptive Disable
2 Enable Unframed Adaptive Disable
3 Enable Unframed Adaptive Disable
4 Enable Unframed Adaptive Disable
5 Enable Unframed Adaptive Disable
6 Enable Unframed Adaptive Disable
7 Enable Unframed Adaptive Disable
Note: This command let the operator get all the TDM port information easily.
Example2: Show the selected TDM port features detail.
IDM-TOP> tdm 2 i
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++TDM 2 Information+++
Admin status (current : Enable)
Clock source (current : Adaptive)
Rx sensitivity (current : Short haul)
Line type (current : Framed MF CRC)
Line code (current : HDB3)
Line impedance (current : Balanced)
Note: This command shows the second TDM port information detail.
Example3: Configure the selected TDM port features.
IDM-TOP> tdm 2 c
Admin status [0:Disable, 1:Enable](current : Enable)
Clock source [0:Adaptive, 1:RxClk, 2:Internal] (current : Internal)
Rx sensitivity [0:Long Haul, 1:Short Haul](current : Short haul)
Line type [0:UnFrm, 1:Frm, 2:Frm CRC, 3:MF, 4:MF CRC](current : Framed MF CRC)
Line code [0:HDB3, 1:AMI](current : HDB3)
Line impedance [0:Balanced, 1:Unbalanced](current : Balanced)
Example4: Get the selected TDM port statistics.
IDM-TOP> tdm 2 s
Select TimeSlot[0 - 96]0
+++++++++++++++++++++++++++++++++++++++++++++++++++
Port 2 Current PM (Run Time= 355s)
LOS: ( 0)
LOF: ( 0)
AIS: ( 0)
ES: ( 3)
S-Stop! C-Clear!
Note: This command shows the second TDM port statistics detail. The time-slot selection means 97 15mins performance statistics. “0” mean the current 15mins performance statistics.
Example4: Loopback the selected TDM port.
IDM-TOP> tdm 2 l
Loopback State[0:Disable, 1:Liu_R, 2:Liu_L_D, 3:Liu_L_A,4:Frm_R_P,5:Frm_R,6:Frm_L](current : Disable)1
Note1: Only the option: 0:Disable, 1:Liu_R, 3:Liu_L_A could be used by the operator. Do not select other options, it will bring unpredictable result.
Note2: The loopback options mean:
Disable: Disable the loopback function, the system work in normal model.
Liu_R: LIU remote loopback. This option is very useful for test the TDM port and line connection. The application is showed in the following diagram.
Liu_L_D: LIU local digital loopback. Only for system reserved test.
Liu_L_A: LIU local digital loopback. This option is very useful for test the ETH port and line connection. The application is showed in the following diagram.
Frm_R_P: Framer remote payload loopback. Used only in framed mode. Only for system reserved test.
Frm_R: Framer remote loopback. Used only in framed mode. Only for system reserved test.
Frm_L: Framer local loopback. Used only in framed mode. Only for system reserved test.
Note: The loopback is based on channel, each channel’s loopback configuration will not affect the performance of the other channels.
Bundle: A pseudowire connection. In unframed mode, it is the unframed E1 pseudowire connection. In framed mode, it is n*64k binding pseudowire connection.
IDM-TOP system supports 64 bundles. The bundle number is 0-63. The bundle number is a bundle symbol in the device, it classify different bundles.
The bundle ID is a global identification. In UDP/IP network it is the UDP port number, the range is 1-8190.
【Command Syntax】bundle <bundle number> <sub command>
【Description】
Parameter |
Description |
Bundle Number |
Range: 0-63. |
Sub Command |
See the following table. |
Sub Command |
Description |
config |
Configure the bundle; the bundle only could be configured when it is in disable status. If the bundle is enable, pls disable the bundle firstly to reconfigure it. |
information |
Display the bundle’s configuration and current connection status. |
enable |
Enable the bundle. |
disable |
Disable the bundle. |
statistic |
Display the bundle current and history statistics. |
【Configure Sub Command Parameter Description】
Parameter |
Description |
Bundle Type |
TDM data encapsulation type, the IDM-TOP supports unframed and framed service encapsulation. Unframed Service: SAToP(RFC4553)and TDMoIP(RFC5087). In unframed mode, SAToP is recommended for bandwidth consumption. Framed Service: CESoPSN (RFC5086). Notes: If the multi-framed E1 16timeslot is used for signaling, the CESoPSN with CAS should be used. |
TDM Port No. |
TDM port number correlative with current bundle. (1-8) |
Destination IP |
Bundle destination IP,the remote IDM-TOP device IP address,bundle source IP is the device´s IP. (See detail in system commands). |
Next Hop |
When the destination and source IP are not in the same subnet, we need appoint the next hop. If it is configured “0.0.0.0”, the default gateway will be the next hop. (See detail in system commands). |
destination bundle id |
Bundle’s destination tag, this tag will be used for bi-direction communication of the IDM-TOPdevice. The range is 1-8190. |
Source TX bundle id |
Bundle’s source tag, the received PW data with this tag as destination bundle will be processed by local IDM-TOP device. The range is 1-8190. |
Payload Size |
TDM data encapsulation length, the length affects the bandwidth consumption and delay of the PSN network. See detail in Appendix 1. |
Clock Recovery |
Enable/Disable Recovery the TDM clock from the PSN network. |
Jitter Buffer |
Jitter buffer size,it could compensate the PSN network delay and jitter. See detail in Appendix 2. |
IP ToS |
Configure the bundle data packets’ IP precedence/TOS/DSCP filed,it could be used for QoS. |
Vlan Tagged |
Configure the bundle’s VLAN tag or not. |
VLAN Identifier |
VLAN Id. |
Vlan Priority |
VLAN priority,it could be used for QoS. |
【Statistic Sub Command Description】
Items |
Description |
Sequence errors |
Seconds with sequence errors occurred on the bundle statistics. |
Jitter buffer underflows |
The number of jitter buffer underflows occurred on the bundle. |
Jitter buffer overflows |
The number of jitter buffer overflows occurred on the bundle. |
Total rx frames |
Rx packets on the Bundle. |
Total tx frames |
Tx packets on the Bundle. |
Example1: Show all the bundle information in the device.
IDM-TOP> show b
Bundle TABLE
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Id Admin Oper TDM Bundle type Dst id Src id Rclock Ip address Timeslot
=================================================================================
1 Enable Fail to Receive 1 CESoPSN with CAS 40000 40000 Enable 192.168.0.103. 1-15,17-31
2 Disable Disabled 2 SAToP 2 2 Enable 192.168.1.125. 0-31
Example2: Show the selected bundle information detail.
IDM-TOP> bundle 2 i
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++Bundle 2 Information+++
Bundle Status: (Disabled)
Bundle Type (current : SAToP)
TDM Port No. (current : 2)
Destination IP Address (current : 192.168.1.125)
Gateway (current : 0.0.0.0)
Destination Bundle Identifier (current : 2)
Source Bundle Identifier (current : 2)
Payload Size (current : 800)
Clock Recovery (current : Enable)
Max Buffer Size (current : 2000)
IP ToS (current : 0)
Vlan Tagged (current : Disable)
+++++++++++++++++++++++++++++++++++++++++++++++++++
Example3: Configure the selected bundle feature.
IDM-TOP> bundle 2 c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++Bundle 2 Config+++
Bundle Type [0: TDMoIP, 1: SAToP,
2: CESoPSN no CAS, 3: CESoPSN with CAS](current : SAToP)3
TDM Port No. [1-8](current : 2)1
TimeSlot Assignment (current : 0-31)1-15,17-31
Destination IP Address (current : 192.168.1.125)
Gateway (current : 0.0.0.0)
Destination Bundle Identifier [1-8190](current : 2)
Source Bundle Identifier [1-8190](current : 2)
Payload Size [size=Nx30 N=1,2,4,8,16]bytese(current : 800)480
Clock Recovery [0:NO, 1:Yes](current : Enable)
Max Buffer Size(*10us) [100-12500](current : 2000)
IP ToS [0-255](current : 0)
Vlan Tagged [0:NO, 1:Yes](current : Disable)
[Time Slot Config Description]
The Time-slot assignment configuration: “1-3” mean slot1 and slot2 and slot3.
“1,3,8” mean slot1 and slot3 and slot8. “1,3,8, 10-12” mean slot1 and slot3 and slot8 and slot10 and slot11 and slot12.
The above configuration mean the 1-15 and 17-31 time-slot are selected, total is 30 time-slot.
[Payload Size Config Description]
In current configuration, 30 time slots are selected, size is Nx30 N=1,2,4,8,16, the 16*framed encapsulation is selected, so the payload in the IP packet is 480 bytes.
[Jitter Buffer Config Description]
In current configuration, the jitter buffer set to 500, means the buffer size could compensate 5ms line pdvt delay.
The pdvt parameter (in the 'bundle configuration tables') defines the amount of data to be stored in the jitter buffer to compensate for network delay variation. This parameter has two implications:
• pdvt defines the device immunity to the Ethernet network delay variation.
• The data arriving from the network is delayed by pdvt before it is sent to the TDM line.
Example4: Configure the selected bundle TOS/VLAN features.
IDM-TOP> bundle 2 c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++Bundle 2 Config+++
Bundle Type [0: TDMoIP, 1: SAToP,
2: CESoPSN no CAS, 3: CESoPSN with CAS](current : CESoPSN with CAS)
TDM Port No. [1-8](current : 1)
TimeSlot Assignment (current : 1-15,17-31)
Destination IP Address (current : 192.168.1.125)
Gateway (current : 0.0.0.0)
Destination Bundle Identifier [1-8190](current : 2)
Source Bundle Identifier [1-8190](current : 2)
Payload Size [size=Nx30 N=1,2,4,8,16]bytese(current : 480)
Clock Recovery [0:NO, 1:Yes](current : Enable)
Max Buffer Size(*10us) [100-12500](current : 2000)
IP ToS [0-255](current : 0)6
Vlan Tagged [0:NO, 1:Yes](current : Disable)1
VLAN ID [1 - 4095](current : 1)2000
Vlan Priority [0 - 7](current : 7)7
Note: In the configuration above, the bundle’s IP packets TOS are configured as 6, and VLAN ID is 2000, the PRI is 7. The administrator could configured the TOS/VLAN/PRI to make sure the PW packets transmitted in high priority in the packet network.
Example5: Enable and Disable the selected bundle.
After configuring the bundle, a bundle should be enable to become effective.
IDM-TOP> bundle 2 en
IDM-TOP>
IDM-TOP> bundle 2 dis
IDM-TOP>
IDM-TOP> bundle 2 en
IDM-TOP>
Example6: Show the performance statistics of selected bundle.
IDM-TOP> bundle 2 s
Select TimeSlot[0 - 96]0
+++++++++++++++++++++++++++++++++++++++++++++++++++
Bundle Status: (Receive Fail)
Bundle 2 Current PM (236)
Sequence error [sec]: ...(0)
Underrun Occurred [sec]: ...(39)
Overrun Occurred [sec]: ...(0)
Minimum JB Level [msec]: ...(0)
Maximum JB Level [msec]: ...(8)
Total rx frames: ...(0)
Total tx frames: ...(55707)
C-Clear S-Stop!
Note: This command shows the second bundle statistics detail. The time-slot selection means 97 15mins performance statistics. “0” mean the current 15mins performance statistics.
The ETH command is used to query and configure of the uplink ETH port.
【Command Syntax】ETH <sub command>
【Description】
Sub Command |
Description |
config |
Configure the eth interface features. |
information |
Display the eth’s configuration and current connection status. |
statistic |
Display the eth current and history statistics. |
Example1: Show the eth information in the device.
IDM-TOP> eth i
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++ETH Information+++
Operational Status (current : Up)
Auto Negotiation (current : Enable)
Speed and Duplex (current : 100M full duplex)
+++++++++++++++++++++++++++++++++++++++++++++++++++
Example2: Configure the eth port features.
IDM-TOP> eth c
+++++++++++++++++++++++++++++++++++++++++++++++++++
+++ETH Config+++
Auto Negotiation [0:Enable, 1:Disable](current : Enable)0
IDM-TOP>
Example3: Show the eth port statistics.
IDM-TOP> eth s
------Ethernet Port Link Status : Link Up ------
Correct Bytes (RX) :192946860
Correct Bytes (TX) :193331413
Correct Frames (RX) :1136677
Correct Frames (TX) :1139597
Pause Packets (RX) :0
Pause Packets (TX) :0
FCS Error :0
Single Collision :0
Alignment Errors :0
Multiple Collision :0
Symbol Errors :0
Defered Frames :0
Excessive Length Ers :0
Underrun :0
Jabbers Errors :0
Excessive Collision :0
Under size Packets :0
Late Collision :0
Classified Packets :1136635
Carrier Sense :0
Checksum Err Packets :74905
Sqe Test Errors :0
press 'C' to clear press 'S' to stop!
Command |
Description |
reboot |
System reboot. |
reset |
System recovery to default configuration. Note: After reset operation, the device MAC address need to be set. (See detail in system commands). |
User |
Add and remove user. Change user password. |
load |
Download the software application online. Xmodem and Ymodem is supported. |
Example1: Reboot the system.
System reboot will initiate the system again. But the system configuration could be stored automatically, so the operator needs not to reconfigure the system after reboot.
In the reboot process, the pseudowire service will be affected.
IDM-TOP> reboot
Reboot system, are you sure?[0:NO, 1:Yes]1
Example2: Reset the system.
System database resets to default. All the system configuration will be erased, so this operation is very dangerous.
IDM-TOP> reset
Reset Database, are you sure?[0:NO, 1:Yes]1
Example3: Check the legal user in the system.
IDM-TOP> user list
Index user permission
0 admin R/W
Example4: Add and Delete user.
IDM-TOP> user add
admin password *****
new user name test
new user permission[1:R ,2:R/W] (current : 2)1
new password test
password confirmation *****
IDM-TOP>
IDM-TOP> user list
Index user permission
0 admin R/W
1 test R
IDM-TOP>
IDM-TOP> user delete
admin password *****
delete user name test
IDM-TOP>
IDM-TOP> user list
Index user permission
0 admin R/W
Example5: Change user password.
IDM-TOP> user p
old password *****
new password *****
password confirmation *****
Example6: Download the application file to the system.(Xmodem)
The administrator could download the application file to the system via console. Xmodem and Ymodem are supported by our system.
[Xmodem Download Command : load xmodem or load x]
Xmodem download is supported by SecureCRT, the following example shows how to download via xmodem in SecureCRT.
IDM-TOP> load x
Use Xmodem protcal,please Select Program File .
(press 'Ctrl+c' exit to reboot TA)
Waiting ...CC
{Note: select the PC Terminal manual Transfer->Send Xmodem}
{Then select the target file}
{Then press the “send” to start transmit}
The device console will show the process of download.
IDM-TOP> load x
Use Xmodem protcal,please Select Program File .
(press 'Ctrl+c' exit to reboot TA)
Waiting ...CC
Starting xmodem transfer. Press Ctrl+C to cancel.
Transferring image_v1.0.bin...
18% 52 KB 2 KB/s 00:01:53 ETA 0 Errors
After the download successfully, the terminal will show the following information, then the device will auto boot.
Example7: Download the application file to the system.(Xmodem/Ymodem via HyperTerminal on PC)
The administrator could download the application file to the system by Xmodem or Ymodem via HyperTerminal on PC. The example is for Ymodem download, the Xmodem is similar.
[Xmodem Download Command : load xmodem or load x]
[Ymodem Download Command : load ymodem or load y]
The following example shows the ymodem download process.
IDM-TOP> load ymodem
Use Ymodem protcal,please Select Program File .
(press 'Ctrl+c' exit to reboot TA)
Waiting ...CC
{Note: select the PC Terminal manual Transfer->Send File-> Select the target file and the protocol, the xmodem or ymodem protocol could be selected.}
{Then press the “send” to start transmit}
The device console will show the process of download.
After the download successfully, the terminal will show the following information, then the device will auto boot.
The IDM-TOP system supports help for all the command, it is very convenience for the operator. The help commands will show the user how to config the command, and provide the explanation of the command parameters.
Example1: Show all the commands.
Type the “help” and enter, all the commands are showed in the screen.
IDM-TOP> help
help Bundle
help Dump
help Eth
help EXEC
help Exit
help Help
help mem
help mn
help PW
help Reboot
help Reg
help Show
help System
help TDM
help TFTP
help Load
help User
Example2: Show the command for “bundle”.
Type the “help bundle” and enter, the usage and options for bundle command is showed in the screen.
IDM-TOP> help bundle
Usage (Bundle):
bundle [id] [options]
Id: 0-63 Range: 0-63.
Options:
Config The bundle only could be configured when it is in disable status.