- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
01-Text | 441.14 KB |
Contents
display posa connection terminal
display posa statistics caller-id
display posa statistics caller-ip
display posa statistics terminal
negotiation no-carrier-detect retry
negotiation unscramble-binary1
posa bind terminal first-terminal-id
posa connection-threshold terminal
posa e1-dial-falling-threshold
posa terminal ssl-server-policy
reset posa connection terminal
vty rtc-client remote remote-port
POS terminal access commands
The following matrix shows the feature and hardware compatibility:
Hardware |
POS terminal access compatibility |
MSR810/810-W/810-W-DB/810-LM/810-W-LM/810-10-PoE/810-LM-HK/810-W-LM-HK/810-LMS/810-LUS |
No |
MSR2600-6-X1/2600-10-X1 |
No |
MSR 2630 |
Yes |
MSR3600-28/3600-51 |
Yes |
No |
|
MSR3610-X1/3610-X1-DP/3610-X1-DC/3610-X1-DP-DC |
Yes |
MSR 3610/3620/3620-DP/3640/3660 |
Yes |
MSR5620/5660/5680 |
Yes |
Hardware |
POS terminal access compatibility |
MSR810-LM-GL |
No |
MSR810-W-LM-GL |
No |
MSR830-6EI-GL |
No |
MSR830-10EI-GL |
No |
MSR830-6HI-GL |
No |
MSR830-10HI-GL |
No |
MSR2600-6-X1-GL |
No |
MSR3600-28-SI-GL |
No |
auto-connect enable
Use auto-connect enable to enable automatic connection for a POS application template that uses the permanent TCP connection mode. The router automatically initiates a connection to the FEP for the POS application template.
Use undo auto-connect enable to disable automatic connection.
Syntax
auto-connect enable
undo auto-connect enable
Default
Automatic connection is disabled. The router does not automatically initiate a connection to the FEP for a POS application template.
Views
POS application template view
Predefined user roles
network-admin
Usage guidelines
This feature takes effect only on POS application templates that use the permanent TCP connection mode:
· If enabled for a POS application template that uses permanent TCP connection mode, this feature takes effect immediately.
· If enabled for a POS application template that uses temporary TCP connection mode, this feature takes effect when the template's TCP connection mode changes to permanent.
The established connection is used only for nontransparent transmission between multiple terminals and the FEP over the connection.
Examples
# Enable automatic connection to the FEP from POS application template 1 that uses the permanent TCP connection mode.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] auto-connect enable
Related commands
posa server enable
timer auto-connect
backup app
Use backup app to specify a backup POS application template.
Use undo backup app to restore the default.
Syntax
backup app app-id
undo backup app
Default
No backup POS application template is specified.
Views
POS application template view
Predefined user roles
network-admin
Parameters
app-id: Specifies a backup POS application template by its ID, in the range of 1 to 1024.
Usage guidelines
If the FEP corresponding to an application template is unreachable, the router initializes a TCP connection to the FEP that corresponds to the backup application template. This command is applicable only to TCP-based POS application templates.
If the specified application template does not exist or is not TCP type, this command can be configured but it does not take effect.
Examples
# Create TCP-based application template 1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
# Create TCP-based application template 2, and specify its backup application template as application template 1.
<Sysname> system-view
[Sysname] posa app 2 type tcp
[Sysname-posa-app2] backup app 1
Related commands
timer quiet
caller-number enable
Use caller-number enable to enable sending of the caller ID in packets sent to the FEP.
Use undo caller-number enable to disable sending of the caller ID.
Syntax
caller-number enable
undo caller-number enable
Default
Sending of the caller ID to the FEP is disabled.
Views
POS application template view
Predefined user roles
network-admin
Usage guidelines
This command is applicable only to TCP-based POS application templates.
This feature is supported only for FCM or AM POS terminal devices.
· For an AM POS terminal device, this feature takes effect only when the application template is configured in temporary TCP connection mode.
· For an FCM POS terminal device, this feature takes effect only when the application template is configured in nontransparent mode.
· The caller ID format differs for FCM and AM POS terminals.
Examples
# Configure POS application template 1 in TCP mode. Enable sending of the caller ID.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] mode temporary
[Sysname-posa-app1] caller-number enable
description
Use description to set a description for a POS application template.
Use undo description to restore the default.
Syntax
description text
undo description
Default
No description is set for a POS application template.
Views
POS application template view
Predefined user roles
network-admin
Parameters
text: Specifies a description, a case-sensitive string of 1 to 32 printable characters except question marks (?).
Examples
# Create a TCP-based POS application template and set the description to ChinaBank1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] description ChinaBank1
display fcm statistics
Use display fcm statistics to display POS access statistics on FCM interfaces.
Syntax
display fcm statistics [ interface fcm { interface-number | interface-number:setnumber.subnumber } ]
Views
Any view
Default command level
network-admin
network-operator
Parameters
interface fcm { interface-number | interface-number:setnumber.subnumber }: Specifies an FCM interface or FCM subinterfaces. The interface-number argument represents the interface number of a physical FCM interface. The interface-number:setnumber.subnumber argument represents subinterfaces of the FCM interface channelized from an E1POS CE1/PRI interface. If no interface is specified, this command displays POS statistics for all physical FCM interfaces and subinterfaces of FCM interfaces channelized from E1POS CE1/PRI interfaces.
Usage guidelines
If you restart the router or execute the reset fcm statistics command, the statistics will be deleted.
Examples
# Display POS statistics for interface FCM 2/1/0.
<Sysname> display fcm statistics interface fcm 2/1/0
Interface TerminalID ConnectFailed TimedOut Transactions (Total/Success)
Fcm2/1/0 5 20 30 100/20
Table 1 Command output
Field |
Description |
Interface |
POS access port, which must be an FCM interface. |
TerminalID |
ID of the POS terminal template. If no POS terminal template is bound, this field displays a hyphen (-). |
ConnectFailed |
Number of dial-up negotiation failures. |
TimedOut |
Number of disconnections because of transaction timeouts. |
Transactions |
Number of transactions for an FCM interface. · Total—Total number of transactions. · Success—Number of transactions for which packets were successfully forwarded. A transaction counted in this statistic is also counted in the TimedOut statistic when the transaction times out. |
Related commands
reset fcm
display posa connection terminal
Use display posa connection terminal to display connection information for POS terminal templates.
Syntax
display posa connection terminal [ terminal-id ]
Views
Any view
Default command level
network-admin
network-operator
Parameters
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024. If no terminal template is specified, this command displays connection information for all POS terminals.
Examples
# Display connection information for all POS terminal templates.
<Sysname> display posa connection terminal
Total TCP connections : 2
Total FCM connections : 1
Total flow connections: 1
Max concurrent trades : 65535
Current non-TCP trades: 2
Current TCP trades : 60
ID Type Interface SrcIP:SrcPort DstIP:DstPort trades
1 TCP - 192.168.100.100:1319 192.168.100.236:3000 10
1 TCP - 192.168.100.100:1320 192.168.100.236:3000 20
5 TCP - 192.168.100.200:1323 192.168.100.236:4000 30
6 FCM Fcm10/0:0.0 - - 1
7 Flow Asy1/0 - - 1
# Display connection information for POS terminal template 1.
<Sysname> display posa connection terminal 1
ID Type Interface SrcIP:SrcPort DstIP:DstPort trades
1 TCP - 192.168.100.100:1319 192.168.100.236:3000 10
1 TCP - 192.168.100.100:1320 192.168.100.236:3000 20
Table 2 Command output
Field |
Description |
Total TCP connections |
Total number of current TCP connections. |
Total FCM connections |
Total number of current FCM connections. |
Total flow connections |
Total number of current flow connections. |
Max concurrent trades |
Max number of concurrent transactions that is supported by the system. |
Current non-TCP trades |
Total number of current non-TCP concurrent transactions. |
Current TCP trades |
Total number of current TCP concurrent transactions. |
ID |
ID of the POS terminal template. |
Type |
Access modes of POS terminal template: · Flow—Flow access mode. · FCM—FCM dial-up access mode. · TCP—TCP access mode. |
Interface |
POS access interface. For TCP access, this field displays a hyphen (-). |
SrcIP |
Source IP address of the connection. For non-TCP access, this field displays a hyphen (-). |
SrcPort |
Source port of the connection. For non-TCP access, this field displays a hyphen (-). |
DstIP |
Source IP address of the connection. For non-TCP access, this field displays a hyphen (-). |
DstPort |
Destination port of the connection. For non-TCP access, this field displays a hyphen (-). |
Trades |
Number of concurrent transactions of the connection. |
display posa statistics app
Use display posa statistics app to display POS application template statistics.
Syntax
display posa statistics app [ app-id ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
app-id: Specifies a POS application template by its ID, in the range of 1 to 1024. If no application template is specified, this command displays statistics for all POS application templates.
Usage guidelines
Statistics collection for an application template applies to all instances that use the application template.
Statistics for an application template will be deleted if you perform one of the following tasks:
· Delete the application template.
· Restart the router.
· Execute the reset posa statistics command.
Examples
# Display all POS application template statistics.
<Sysname> display posa statistics app
ID Received Sent PktErr DisErr InDiscarded OutDiscarded
1 100 100 0 0 0 3
2 60 70 0 0 0 0
3 100 10 0 0 0 0
Table 3 Command output
Field |
Description |
ID |
ID of the POS application template. |
Received |
Number of packets received from FEPs (including PktErr and DisErr, not including InDiscarded). |
Sent |
Number of packets sent to FEPs (not including OutDiscarded). |
PktErr |
Number of packets in incorrect format. |
DisErr |
Number of packets failed to be distributed to POS terminal templates. |
InDiscarded |
Number of incoming packets discarded because of a full buffer. |
OutDiscarded |
Number of outgoing packets discarded because of link failures. |
Related commands
reset posa statistics
display posa statistics caller-id
Use display posa statistics caller-id to display POS transaction statistics of a caller ID.
Syntax
display posa statistics caller-id [ caller-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
caller-number: Specifies a caller ID, a string of 1 to 64 characters. It can contain only digits and letters, such as 01012345678. A caller ID is typically all digits, but letters can also be used. If no caller ID is specified, this command displays POS transaction statistics for all caller IDs.
Usage guidelines
If you restart the router or execute the reset posa statistics command, the statistics will be cleared.
Examples
# Display POS transaction statistics of caller ID 01012345678.
<Sysname> display posa statistics caller-id 01012345678
CID Received Sent PktErr MapErr InDiscarded OutDiscarded
01012345678 100 100 0 0 0 0
Table 4 Command output
Field |
Description |
CID |
Caller ID of the POS terminal. |
Received |
Number of packets received from the POS terminal (including PktErr and MapErr packets, not including InDiscarded packets). |
Sent |
Number of packets sent to the POS terminal (not including OutDiscarded packets). |
PktErr |
Number of packets in incorrect format. |
MapErr |
Number of packets failed to be mapped to application templates. |
InDiscarded |
Number of incoming packets discarded because of a full buffer. |
OutDiscarded |
Number of outgoing packets discarded because of link failures. |
Related commands
posa statistics caller-id
reset posa statistics
display posa statistics caller-ip
Use display posa statistics caller-ip to display POS transaction statistics of a source IP statistical item.
Syntax
display posa statistics caller-ip [ group-id ]
Views
Any view
Default command level
network-admin
network-operator
Parameters
group-id: Specifies the ID of a source IP statistical item, in the range of 1 to 64. If no source IP statistical item is specified, this command displays POS transaction statistics for all source IP statistical items.
Usage guidelines
If you restart the router or execute the reset posa statistics command, the statistics will be cleared.
Examples
# Display POS transaction statistics of source IP statistical item 64.
<Sysname> display posa statistics caller-ip 1
ID Type IP Mask Received Sent PktErr MapErr InDiscarded OutDiscarded
64 IPV4 1.1.1.1 255.255. 150 2 0 0 0 0
255.0
Table 5 Command output
Field |
Description |
ID |
ID of the source IP statistical item. |
IPType |
Type of the IP protocol. |
CIP |
Source IP address specified by the source IP statistical item. |
IPMask |
Mask of the source IP address. |
Received |
Number of packets received from the POS terminal (including PktErr and MapErr packets, not including InDiscarded packets). |
Sent |
Number of packets sent to the POS terminal (not including OutDiscarded packets). |
PktErr |
Number of packets in incorrect format. |
MapErr |
Number of packets failed to be mapped to application templates. |
InDiscarded |
Number of incoming packets discarded because of a full buffer. |
OutDiscarded |
Number of outgoing packets discarded because of link failures. |
Related commands
posa statistics caller-ip
reset posa statistics
display posa statistics nii
Use display posa statistics nii to display POS transaction statistics of an NII.
Syntax
display posa statistics nii [ nii-id ]
Views
Any view
Default command level
network-admin
network-operator
Parameters
nii-id: Specifies the destination address in the TPDU header of a POS packet. It is a four-hexadecimal-digit string such as ffff. If no NII is specified, this command displays POS transaction statistics for all NIIs.
Usage guidelines
If you restart the router or execute the reset posa statistics command, the statistics will be cleared.
Examples
# Display POS transaction statistics for TPDU destination address 0x15.
<Sysname> display posa statistics nii 15
ID Received Sent TotalTrade SuccessTrade SuccessRate
0x15 2 2 2 2 100.0%
Table 6 Command output
Field |
Description |
ID |
ID of the source IP statistical item. |
Received |
Number of packets received from the POS terminal. |
Sent |
Number of packets sent to the POS terminal. |
TotalTrade |
Total number of transactions destined for the NII. |
SuccessTrade |
Total number of successful transactions destined for the NII. |
SuccessRate |
Transaction success transaction rate of the NII. |
Related commands
reset posa statistics
trade-exchanges
display posa statistics terminal
Use display posa statistics terminal to display POS terminal template statistics.
Syntax
display posa statistics terminal [ terminal-id ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024. If no terminal template is specified, this command displays statistics for all POS terminal templates.
Usage guidelines
Statistics collection for a terminal template applies to all instances that use the terminal template.
Statistics for a terminal template will be deleted if you perform one of the following tasks:
· Delete the terminal template.
· Restart the router.
· Execute the reset posa statistics command.
Examples
# Display all POS terminal template statistics.
<Sysname> display posa statistics terminal
ID Received Sent PktErr MapErr InDiscarded OutDiscarded Notified
1 100 50 2 2 0 5 2
2 60 70 0 10 1 6 0
3 100 100 0 0 1 3 0
4 3 0 0 0 0 3 0
Table 7 Command output
Field |
Description |
ID |
ID of the POS terminal template. |
Received |
Number of packets received from POS terminals (including PktErr and MapErr, not including InDiscarded). |
Sent |
Number of packets sent to POS terminals (not including OutDiscarded and Notified). |
PktErr |
Number of packets in incorrect format received from POS terminals. |
MapErr |
Number of packets failed to be mapped to application templates. |
InDiscarded |
Number of packets discarded because of a full buffer or failures to obtain transaction numbers when the router receives packets from POS terminals. |
OutDiscarded |
Number of packets discarded because of link failures when the router sends packets to POS terminals. |
Notified |
Number of notification packets sent to POS terminals for the following failures: · Failures to map packets to POS applications. · Failures to obtain transaction numbers. · Failures to forward packets to the FEP. |
Related commands
reset posa statistics
display posa status app
Use display posa status app to display POS application state information.
Syntax
display posa status app [ app-id ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
app-id: Specifies a POS application template by its ID, in the range of 1 to 1024. If no application template is specified, this command displays state statistics for all POS application templates.
Examples
# Display state information for all POS application templates.
<Sysname> display posa status app
AppID Type Mode Interface IPAddr:Port State
1 TCP Temporary - 192.168.7.254:1000 linked
2 TCP Temporary - 192.168.7.224:1000 Error
3 Flow - Asy2/1/0 - Down
9 TCP Permanent - 192.168.4.1:20 Unlinked
11 TCP Permanent - 192.4.5.5:111 Unlinked
30 TCP Temporary - 192.168.7.52:4000 Multilink(10)
31 Flow - - - -
Table 8 Command output
Field |
Description |
AppID |
ID of the POS application template. |
Type |
Connection mode of the POS application template: flow or TCP. |
Mode |
TCP connection mode of the POS application template: · Permanent—Permanent TCP connection mode. · Temporary—Temporary TCP connection mode. For the flow mode, this field displays a hyphen (-). |
Interface |
Interface of the POS application template. If no interface is configured, or the POS application is in TCP mode, this field displays a hyphen (-). |
IPAddr:Port |
IP address and port number of the FEP for the POS application template. If no IP address and port number are configured, or the POS application is in flow mode, this field displays a hyphen (-). |
State |
Connection state of the POS application template. For the flow mode: · Up—The connection has been established. · Down—The connection has been terminated. For the TCP mode: · Unlinked—The connection has not been established. · Linking—The connection is being established. · Linked—The connection has been established. · Multilink(N)—Multiple TCP connections have been established for the POS application. N indicates the number of TCP connections. · Blocked—The POS application template is blocked because of application fault. · Error—The mapping entry for the application template is not available because the mapping entry failed to be enabled (TCP connection failed to be bound to a source port). If no interface, IP addresses or port number is configured, this field displays a hyphen (-). |
display posa status terminal
Use display posa status terminal to display POS terminal state information.
Syntax
display posa status terminal [ terminal-id ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024. If no terminal template is specified, this command displays state information for all POS terminal templates.
Examples
# Display state information for all POS terminal templates.
<Sysname> display posa status terminal
TerminalID Type Interface ListenPort State
1 TCP - 2000 Unlinked
2 TCP - 2000 Error
3 FCM Fcm2/10/0:0.0 - Down
254 TCP - 3000 Multilink(2)
255 Flow Asy2/1/0 - Up
Table 9 Command output
Field |
Description |
TerminalID |
ID of the POS terminal template. |
Type |
POS terminal access mode: Flow, FCM (dial-up access), or TCP. |
Interface |
Access interface. If no interface is configured, or the POS terminal is in the TCP access mode, this field displays a hyphen (-). |
ListenPort |
Listening port for a POS terminal. If no interface is configured, or the POS terminal is in the FCM or flow access mode, this field displays a hyphen (-). |
State |
Connection state of the POS terminal. For the flow or FCM access mode: · Up—The connection has been established. · Down—The connection has been terminated. For the TCP access mode: · Unlinked—The connection has not been established. · Linking—The connection is being established. · Linked—The connection has been established. · Multilink(N)—Multiple TCP connections have been established for the POS terminal. N indicates the number of TCP connections. · Error—The entry is not available. |
hello enable
Use hello enable to enable handshaking for a POS application template.
Use undo hello enable to disable handshaking for a POS application template.
Syntax
hello enable
undo hello enable
Default
Handshaking for POS application templates is disabled.
Views
POS application template view
Predefined user roles
network-admin
Usage guidelines
This command takes effect only on TCP-based POS application templates.
By default, the router communicates with an FEP only when there are packets from a POS terminal. If the FEP is faulty, the current transaction might fail or be delayed. To solve this problem, you can enable POS application handshaking to detect the state of an FEP. This feature also allows an FEP to detect the reachability of the router.
With handshaking enabled for an application template, the router initiates a connection to the corresponding FEP for the application template at a specific interval. The interval is configured by using the timer hello command. When the TCP connection is established, the router sends to the FEP a packet with an empty data field (fixed as 00056000000000). The FEP does not respond to the packet.
· For an application template using the temporary TCP connection mode, the router initiates a new connection at every interval.
· For an application template using the permanent TCP connection mode, the router uses the existing TCP connection to send a packet. If no TCP connection exists, the router creates a TCP connection and keeps the TCP connection after the handshaking.
The handshaking will change the state of the current POS application. If the POS application is in blocked state, it will switch to non-blocked state when the handshaking succeeds. If the POS application is in non-blocked state, it will switch to blocked state when the handshaking fails.
For an application template using the temporary TCP connection mode, the FEP state change notifications will not be sent when handshakes succeed.
Examples
# Enable handshaking for POS application templates.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] hello enable
Related commands
timer hello
ip
Use ip to configure the IP address and port number of the corresponding FEP for a POS application template.
Use undo ip to restore the default.
Syntax
ip ip-address port port-number
undo ip
Default
No IP address or port number is configured for the POS application template.
Views
POS application template view
Predefined user roles
network-admin
Parameters
ip-address: Specifies the IP address of the FEP. The address can be any unicast IPv4 address except the loopback address.
port-number: Specifies the port number of the FEP, in the range of 1 to 65535.
Usage guidelines
This command applies only to POS application templates in TCP mode.
You can specify only one IP address and port number for a POS application template. Modifying the IP address or port number also removes all existing TCP connections that use this template.
Examples
# Create POS application template 1 in TCP mode. Set the IP address and port number of the FEP for POS application template 1 to 1.1.1.1 and 3000.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] ip 1.1.1.1 port 3000
# Modify the IP address and port number of the FEP to 1.1.1.2 and 3001 for POS application template 1.
[Sysname-posa-app1] ip 1.1.1.2 port 3001
Connections for the application have been reset.
Related commands
posa app
mode
Use mode to configure the TCP connection mode for a POS application template.
Use undo mode to remove the configuration.
Syntax
mode { permanent | temporary }
undo mode
Default
The TCP connection mode of a POS application template is the permanent mode.
Views
POS application template view
Predefined user roles
network-admin
Parameters
permanent: Sets the TCP connection mode to permanent mode.
temporary: Sets the TCP connection mode to temporary mode.
Usage guidelines
In temporary mode, the router terminates the TCP connection to the FEP when a POS transaction finishes. The router establishes another TCP connection for a new transaction. The router can establish concurrent TCP connections with the FEP.
In permanent mode, for POS transactions in nontransparent transport mode, the router maintains the TCP connection to the FEP when the first POS transaction finishes. The router uses the TCP connection to transfer subsequent POS packets. The router establishes a dedicated TCP connection with the FEP for each POS transaction in transparent mode, regardless of the TCP connection mode of the application template. In this case, the router can establish concurrent TCP connections with the FEP.
This command takes effect only on POS application templates operating in TCP mode.
If you switch between permanent and temporary modes, the TCP connections already established by the POS application template are terminated.
Examples
# Create POS application template 1 in TCP mode. Specify the temporary TCP connection mode for POS application 1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] mode temporary
Connections for the application have been reset.
The output shows that the permanent TCP connection already established by the POS application template is deleted.
Related commands
posa app
negotiation hookoff
Use negotiation hookoff to set the hook off delay time for an FCM card after the FCM interface receives the ringing current.
Use undo negotiation hookoff to remove the configuration.
Syntax
negotiation hookoff delaytime
undo negotiation hookoff
Default
The hook off delay time for an FCM card is 500 milliseconds.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
delaytime: Specifies the hook off delay time for an FCM card, in the range of 100 to 6000 milliseconds.
Examples
# Set the hook off delay time to 2000 milliseconds for the FCM card after the interface FCM 2/4/0 receives the ringing current.
<Sysname> system-view
[Sysname] interface fcm 2/4/0
[Sysname-Fcm2/4/0] negotiation hookoff 2000
negotiation no-carrier-detect retry
Use negotiation no-carrier-detect retry to set the maximum number of successive no-carrier states allowed to be detected before the FCM card hangs up.
Use undo negotiation no-carrier-detect retry to remove the configuration.
Syntax
negotiation no-carrier-detect retry retries
undo negotiation no-carrier-detect retry
Default
An FCM card hangs up if a no-carrier state is detected.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
retries: Specifies the maximum number of successive no-carrier states allowed to be detected before the FCM card hangs up. The value is in the range of 1 to 1000.
Examples
# Set the maximum number of successive no-carrier states allowed to be detected to 20 for FCM 2/4/0.
<Sysname> system-view
[Sysname] interface fcm 2/4/0
[Sysname-Fcm2/4/0] negotiation no-carrier-detect retry 20
negotiation scramble-binary1
Use negotiation scramble-binary1 to set the modem negotiation scramble-binary1 time.
Use undo negotiation scramble-binary1 to remove the configuration.
Syntax
negotiation scramble-binary1 scramble-binary1time
undo negotiation scramble-binary1
Default
The modem negotiation scramble-binary1 time is 250 milliseconds.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
scramble-binary1time: Specifies the modem negotiation scramble-binary1 time, in the range of 100 to 1500 milliseconds.
Examples
# Set the modem negotiation scramble-binary1 time to 200 milliseconds for FCM 2/4/0.
<Sysname> system-view
[Sysname] interface fcm 2/4/0
[Sysname-Fcm2/4/0] negotiation scramble-binary1 200
negotiation silence
Use negotiation silence to set the modem negotiation silence time.
Use undo negotiation silence to remove the configuration.
Syntax
negotiation silence silencetime
undo negotiation silence
Default
The modem negotiation silence time is 0 milliseconds.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
silencetime: Specifies the modem negotiation silence time, in the range of 0 to 3000 milliseconds.
Usage guidelines
Silence time is the time interval from when the FCM card hooks off to when the FCM card sends a packet.
Silence time is used for the handshaking between a POS terminal and the FCM card. The silence time must be shorter than the maximum waiting time of a POS terminal and longer than the off-hook detection time of a POS terminal.
· If the silence time is longer than the maximum waiting time, the POS terminal considers that there is no data from the FCM card and hangs up.
· If the silence time is shorter than the off-hook detection time, the FCM card will send data to the POS terminal before the POS terminal successfully detected the off-hook of the FCM card. As a result, the POS terminal cannot receive the data.
Examples
# Set the modem negotiation silence time to 100 milliseconds.
<Sysname> system-view
[Sysname] interface fcm 2/4/0
[Sysname-Fcm2/4/0] negotiation silence 100
negotiation unscramble-binary1
Use negotiation unscramble-binary1 to set the modem negotiation unscramble-binary1 time.
Use undo negotiation unscramble-binary1 to remove the configuration.
Syntax
negotiation unscramble-binary1 unscramble-binary1time
undo negotiation unscramble-binary1
Default
The modem negotiation unscramble-binary1 time is 400 milliseconds.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
unscramble-binary1time: Specifies the modem negotiation unscramble-binary1 time, in the range of 300 to 1500 milliseconds.
Examples
# Set the modem negotiation unscramble-binary1 time to 900 milliseconds for FCM 2/4/0.
<Sysname> system-view
[Sysname] interface fcm 2/4/0
[Sysname-Fcm2/4/0] negotiation unscramble-binary1 900
posa app
Use posa app to create a POS application template and enter its view, or enter the view of an existing POS application template.
Use undo posa app to remove the POS application template.
Syntax
posa app app-id type { flow | tcp }
undo posa app app-id
Default
No POS application templates exist.
Views
System view
Predefined user roles
network-admin
Parameters
app-id: Specifies an ID for the POS application template, in the range of 1 to 1024.
type: Configures the connection mode in which the POS application template communicates with the FEP:
· flow—Specifies the flow mode.
· tcp—Specifies the TCP mode.
Usage guidelines
You must specify a unique ID for each application template on the router. You cannot change the connection mode for an existing application template.
For an application template in flow mode, bind it to an Async, Serial, or Aux interface after it is created so that it can take effect.
Examples
# Create POS application template 1 in flow mode. Bind POS application template 1 to Async 2/7/0.
<Sysname> system-view
[Sysname] posa app 1 type flow
[Sysname-posa-app1] quit
[Sysname] interface Async 2/7/0
[Sysname-Async2/7/0] posa bind app 1
# Create POS application template 2 in TCP mode.
<Sysname> system-view
[Sysname] posa app 2 type tcp
Related commands
posa bind app
posa auto-stop-service enable
Use posa auto-stop-service enable to enable automatic shutdown of POS access service when all FEPs are unreachable.
Use undo posa auto-stop-service enable to disable automatic shutdown of POS access service when all FEPs are unreachable.
Syntax
posa auto-stop-service enable
undo posa auto-stop-service enable
Default
The POS access service is not automatically shut down when all FEPs are unreachable.
Views
System view
Predefined user roles
network-admin
Usage guidelines
An FEP is unreachable when one of the following occurs:
· The router fails to initiate a connection to the FEP, for example, the linking time for the connection expires.
· The router is disconnected from the FEP because of the keepalive failure.
This command is applicable only to TCP-based and E1POS terminal templates. This command enables the router to automatically perform the following operations when all FEPs are unreachable:
· Shuts down the listening ports for all TCP-based POS terminal templates.
· Sets the access interfaces for all E1POS terminal templates to reply with busy tones.
When any of the FEPs becomes reachable, the router automatically performs the following operations:
· Opens the listening ports for all TCP-based POS terminal templates.
· Stops the busy tone reply for all E1POS terminal templates.
Examples
# Enable automatic shutdown of POS access service when all FEPs are unreachable.
<Sysname> system-view
[Sysname] posa auto-stop-service enable
posa bind app
Use posa bind app to bind a POS application template to an interface.
Use undo posa bind app to restore the default.
Syntax
posa bind app app-id
undo posa bind app
Default
No POS application template is bound to an interface.
Views
Asynchronous interface view
Synchronous/asynchronous interface view
Predefined user roles
network-admin
Parameters
app-id: Specifies a POS application template by its ID, in the range of 1 to 1024.
Usage guidelines
You can use this command on a synchronous/asynchronous interface only when the interface is operating in asynchronous mode. If you bind an application template to an interface not operating in asynchronous mode, the state of the application template is Error.
Before binding a POS application template to an interface, create the POS application template in flow mode in system view.
To bind a new POS application template to the interface, first execute the undo posa bind app command to remove the existing POS application template binding.
Bind different application templates to different interfaces.
You cannot bind both a POS terminal template and a POS application template to the same interface.
The connection mode of the specified POS application template must be flow mode.
Examples
# Create POS application template 2 in flow mode.
<Sysname> system-view
[Sysname] posa app 2 type flow
[Sysname-posa-app2] quit
# Bind interface Async 2/1/0 to POS application template 2.
<Sysname> system-view
[Sysname] interface async 2/1/0
[Sysname-Async2/1/0] posa bind app 2
Related commands
posa app
posa bind terminal
Use posa bind terminal to configure the current interface as the access interface of a POS terminal template by binding the POS terminal template to the interface.
Use undo posa bind terminal to restore the default.
Syntax
posa bind terminal terminal-id [ app app-id ]
undo posa bind terminal
Default
An interface is not an access interface of any POS terminal template.
Views
Asynchronous interface view
Physical AM interface view
Physical FCM interface view
Synchronous/asynchronous interface view
Predefined user roles
network-admin
Parameters
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024.
app app-id: Specifies a POS application template by its ID, in the range of 1 to 1024. This option specifies the POS application template to be associated with the POS terminal template in transparent mode. The specified application template must be an existing TCP-based application template. If no application template is specified, it indicates that the terminal template is operating in nontransparent mode.
Usage guidelines
You can use this command on a synchronous/asynchronous interface only when the interface is operating in asynchronous mode. If you bind a terminal template to an interface not operating in asynchronous mode, the state of the terminal template is Error.
Bind different terminal templates to different interfaces.
You cannot bind both a POS terminal template and a POS application template to the same interface.
Use the following guidelines when you specify the app app-id option:
· The POS terminal template bound to an interface cannot be switched between nontransparent mode and transparent mode. To assign a new POS application template to the POS terminal template, first execute the undo posa bind terminal command to remove the existing POS application template binding.
· In transparent mode, you can associate multiple POS terminal templates with one POS application template.
· If the specified application template does not exist or is not in TCP mode, the configuration is allowed but it does not take effect. Related transactions will fail.
Examples
# Configure Async 2/1/0 as the access interface of POS terminal template 1.
<Sysname> system-view
[Sysname] interface async 2/1/0
[Sysname-Async2/1/0] posa bind terminal 1
Related commands
posa app
posa bind terminal first-terminal-id
Use posa bind terminal first-terminal-id to bulk-configure the subinterfaces of the current interface as POS access interfaces.
Use undo posa bind terminal first-terminal-id to restore the default.
Syntax
posa bind terminal first-terminal-id first terminal-id [ app-list app-list ] [ reassemble ]
undo posa bind terminal first-terminal-id
Default
Subinterfaces of an interface are not POS access interfaces of any POS terminal templates.
Views
Channelized AM interface view
Channelized FCM interface view
Predefined user roles
network-admin
Parameters
first-terminal-id: Specifies the start terminal template ID in the range of 1 to 1024. The specified terminal template and the subsequent terminal templates (maximum ID 1024) will be bound to FCM or AM subinterfaces in ascending order of terminal template IDs.
app-list app-list: Sets POS terminal templates to operate in transparent mode and specifies the POS application templates to be associated with the POS access interfaces. The app-list argument represents a list of POS application template IDs, which can contain the following elements separated by commas:
· Single application template ID, in the range of 1 to 1024.
· Hyphen-connected application template ID range, in format of start ID-end ID, for example 1-14. The start ID must be smaller than the end ID. The value range for the start ID and end ID is 1 to 1024.
· Colon-connected value, for example, 16:13. The number before the colon represents a POS application template ID in the range of 1 to 1024. The number after the colon (1 to 30) represents the number of subinterfaces to which the specified POS application template ID will be bound.
For example, the list of 1-14,15,16:13,127-128 indicates the subinterfaces numbered 1 to 14 are bound to the POS application template IDs of 1 to 14, the subinterface numbered 15 is bound to the POS application template ID 15, the subinterfaces numbered 16 to 28 are bound to the POS application template ID 16, and the subinterfaces numbered 29 to 30 are bound to the POS application template IDs of 127 to 128.
The application template ID list cannot contain spaces. If no application template ID is specified, this command configures the POS terminal templates to operate in nontransparent mode.
reassemble: Reassembles packet fragments on the router before sending them to FEPs in transparent mode. If you do not specify this option, the router sends packet fragments to FEPs without reassembling them. Only channelized AM interfaces support this option.
Usage guidelines
Multiple FCM subinterfaces can be created from an E1POS CE1/PRI interface and multiple AM subinterfaces can be created from an E1DM CE1/PRI interface. For information about creating FCM and AM subinterfaces, see Interface Configuration Guide. Use this command to specify the POS terminal templates and POS application templates to be bound to the subinterfaces.
For this command to be successfully executed, make sure the following requirements are met:
· The number of the specified POS terminal templates must be no less than the number of the subinterfaces. For example, if you set the first terminal template ID to 1020 and the current interface has more than five FCM subinterfaces, the configuration will fail because of insufficient terminal template IDs.
· The number of the specified POS application templates must be equal to the number of the subinterfaces.
· The specified terminal templates must be FCM/AM terminal templates and none of the terminal templates can be bound to another interface.
If the specified application template does not exist or is not in TCP mode, the configuration is allowed but it does not take effect. Related transactions will fail.
If FEPs do not support fragments reassembling, specify the reassemble option to enable the router to reassemble packet fragments in transparent mode.
Examples
# The interface FCM2/4/0:15 has 30 subinterfaces. Bulk-configure the 30 subinterfaces as the access interfaces for POS terminal templates with the IDs of 1 to 30. Bind the 30 subinterfaces to POS application template IDs of 1 to 30.
[sysname] interface fcm 2/4/0:15
[sysname-Fcm2/4/0:15] posa bind terminal first-terminal-id 1 app-list 1-30
Related commands
posa app
posa calling-prefix
Use posa calling-prefix to configure the router to add a prefix to caller IDs of POS terminals.
Use undo posa calling-prefix to restore the default.
Syntax
posa calling-prefix string
undo posa calling-prefix
Default
The router does not add a prefix to caller IDs in packets sent to the FEP.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
string: Specifies a caller ID prefix, a string of 1 to 8 digits.
Usage guidelines
This command is available only on the HMIM-1E1POS and DHMIM-1E1POS1DM interface modules.
A caller ID prefix identifies the location of a POS terminal.
This command takes effect only after sending of caller IDs is enabled.
Examples
# Configure the router to add a prefix of 010 to the caller ID of the POS terminal on interface FCM 2/4/0:15.
<Sysname> system-view
[Sysname] interface fcm 2/4/0:15
[Sysname-Fcm5/0:15] posa calling-prefix 010
Related commands
caller-number enable
posa connection-threshold terminal
Use posa connection-threshold terminal to set the concurrent connection threshold for POS terminals.
Use undo posa connection-threshold terminal to restore the default.
Syntax
posa connection-threshold terminal { fcm fcm-threshold-value | tcp tcp-threshold-value }
undo posa connection-threshold terminal { fcm | tcp }
Default
The concurrent connection threshold is 4096 for TCP access mode and 255 for FCM dial-up access mode.
Views
System view
Predefined user roles
network-admin
Parameters
fcm fcm-threshold-value: Specifies the concurrent connection threshold for FCM dial-up access mode, in the range of 1 to 255.
fcm fcm-threshold-value: Specifies the concurrent connection threshold for TCP access mode, in the range of 1 to 4096.
Usage guidelines
The router generates SNMP notifications for fcm-connection-exceed or tcp-connection-exceed events when the following requirements are met:
· SNMP notification is enabled for fcm-connection-exceed or tcp-connection-exceed events.
· Number of FCM or TCP concurrent connections exceeds the threshold.
Connections can still be established after the concurrent connections threshold is exceeded.
Examples
# Set the TCP concurrent connection threshold to 200.
<Sysname> system-view
[Sysname] posa connection-threshold terminal tcp 200
Related commands
snmp-agent trap enable posa
posa e1-dial-falling-threshold
Use posa e1-dial-falling-threshold to configure the alarm threshold for the low E1 dialing success rate.
Use undo posa e1-dial-falling-threshold to restore the default.
Syntax
posa e1-dial-falling-threshold threshold-value
undo posa e1-dial-falling-threshold
Default
The alarm threshold for the low E1 dialing success rate is 90%.
Views
System view
Default command level
network-admin
Parameters
threshold-value: Specifies the alarm threshold for the low E1 dialing success rate in percentage, in the range of 1 to 99.
Usage guidelines
The router generates SNMP notifications for e1-dial-falling events when the following requirements are met:
· SNMP notification is enabled for e1-dial-falling events.
· E1 dialing success rate drops below the threshold.
Examples
# Set the alarm threshold to 80% for the low E1 dialing success rate.
<Sysname> system-view
[Sysname] posa e1-dial-falling-threshold 80
Related commands
snmp-agent trap enable posa
posa fcm
Use posa fcm to set FCM parameters for modem negotiation.
Use undo posa fcm to restore the default for an FCM parameter.
Syntax
posa fcm { answer-time time1 | idle-time time2 | trade-time time3 }*
undo posa fcm { answer-time | trade-time | idle-time }
Default
The answering time is 2000 milliseconds. The idle time is 180 seconds. The transaction time is 12000000 milliseconds.
Views
System view
Predefined user roles
network-admin
Parameters
answer-time time1: Specifies the answering time in the range of 500 to 2000 milliseconds. The default answering time is 2000 milliseconds.
idle-time time2: Specifies the maximum idle time for the link, in the range of 1 to 12000 seconds. The default idle time is 180 seconds.
trade-time time3: Specifies the maximum time of a single transaction, in the range of 30000 to 12000000 milliseconds. The default transaction time is 12000000 milliseconds.
Usage guidelines
Typically, the modem on the router usually acts as the called party and the built-in modem in the POS terminal acts as the calling party. In a basic modem communication, the POS terminal originates a call to the called party, which answers and sends an answer tone to the POS terminal after detecting the calling signal. After the POS terminal receives the answer tone, both parties begin modem negotiation (V.22).
For a system with poor network quality, a short answer tone may cause a modem negotiation failure. If the interface comes up and down, without data being transmitted or received, you need to enlarge the value of answer-time.
To improve the efficiency of the POS access interface, and to avoid a POS terminal occupying system resources for a long period of time, manage individual transaction times by configuring parameters trade-time and idle time. If the maximum transaction time or the maximum idle time is exceeded, the router actively disconnects the corresponding POS terminal to release the link resource.
Typically, the default values of FCM parameters can meet the application demands. You can customize these parameters as needed.
Examples
# Change answer-time to 800 milliseconds, trade-time to 1200000 milliseconds (20 minutes), and idle-time to 6 seconds.
<Sysname> system-view
[Sysname] posa fcm answer-time 800
[Sysname] posa fcm trade-time 1200000
[Sysname] posa idle-time 6
posa map
Use posa map to configure POS application mapping entries.
Use undo posa map to remove POS application mapping entries.
Syntax
posa map { default | destination des-code | source src-code } * app app-id
undo posa map { default | destination des-code | source src-code } *
Default
No POS application mapping entries are configured.
Views
System view
Predefined user roles
network-admin
Parameters
default: Specifies a default POS application template, to which packets that do not match any mappings are sent.
destination des-code: Specifies the destination address in the TPDU header of a POS packet. It is a four-hexadecimal-digit string such as FFFF to identify a bank, and is generally assigned from the transaction center.
source src-code: Specifies the originator address in the TPDU header of a POS packet. It is a string of four hexadecimal digits such as 0001 to identify a POS terminal.
app app-id: Specifies a POS application template by its ID, in the range of 1 to 1024. If the specified application template ID does not exist, the configuration is allowed but it does not take effect.
Usage guidelines
The POS terminal access device matches the originator address and/or destination address in the TPDU header of a received POS packet against the configured POS application mapping table. If the TPDU originator address, destination address, or both addresses match an entry in the POS application mapping table, the packet is sent to the specified POS application template. If no match is found, the packet is sent to the default POS application template.
You can configure multiple POS application mapping entries for the same POS application template. The entry that has both the originator and destination addresses has the highest priority. The default entry has the lowest priority.
The router supports up to 1024 POS application mapping entries, including the default mapping entry.
If you change the destination FEP of a mapping entry during a transaction, the connection will not be removed. However, it might affect the ongoing POS transaction.
Examples
# Configure a POS application mapping entry that maps packets destined for 01f1 to POS application template 2.
<Sysname> system-view
[Sysname] posa map destination 01f1 app 2
# Configure a default POS application mapping entry that maps unmatched packets to POS application template 1.
<Sysname> system-view
[Sysname] posa map default app 1
Related commands
posa app
posa server enable
Use posa server enable to enable the POS access service.
Use undo posa server enable to disable the POS access service.
Syntax
posa server enable
undo posa server enable
Default
The POS access service is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
To implement POS access, first enable the POS access service.
If you configure POS functions incorrectly, the functions will not take effect. For example, you specify an unavailable TCP port as the source port for an application template. The display posa status command displays the POS terminal/application template state as Error after you enable the POS access service. After you fix the problem (for example, correct the TCP source port for the application template), you can re-enable the POS access service.
Examples
# Enable the POS access service.
<Sysname> system-view
[Sysname] posa server enable
Related commands
display posa status
posa statistics caller-id
Use posa statistics caller-id to add a caller ID statistical item. The router counts the packets exchanged between the POS terminal and the FEP for the caller ID.
Use undo posa statistics caller-id to remove the specified caller ID statistical item.
Syntax
posa statistics caller-id caller-number
undo posa statistics caller-id caller-number
Default
No caller ID statistical item is configured.
Views
System view
Predefined user roles
network-admin
Parameters
caller-number: Specifies a caller ID, a string of 1 to 64 characters. It can contain only digits and letters, such as 01012345678. A caller ID is typically all digits, but letters can also be used.
Usage guidelines
This feature applies only to POS terminals using dial-up access mode.
If you configure the same caller ID multiple times, no error message is displayed.
The router supports a maximum of 64 caller ID statistical items.
Examples
# Add a statistical item for caller ID 01012345678 to count the packets between the POS terminal and the FEP.
<Sysname> system-view
[Sysname] posa statistics caller-id 01012345678
Related commands
display posa statistics caller-id
posa statistics caller-ip
Use posa statistics caller-ip to create a source IP statistical item. The source IP statistical item specifies a source IP or source IP segment. The router counts the packets that are sourced from the source IP and IP segment.
Use undo posa statistics caller-ip to remove the specified source IP statistical item.
Syntax
posa statistics caller-ip group-id ip-address ip-mask
undo posa statistics caller-ip group-id
Default
No source IP statistical item is configured.
Views
System view
Predefined user roles
network-admin
Parameters
group-id: Specifies an ID for the source IP statistical item, in the range of 1 to 64.
ip-address: Specifies a source IP address or source IP segment in dotted decimal notation.
ip-mask: Specifies a mask in dotted decimal notation.
Usage guidelines
This feature applies only to POS terminals template using TCP.
Source IP segment can overlap each other or be the same.
POS terminal packets that match multiple source IP statistical items are counted for all the statistical items.
Examples
# Create source IP statistical item 1 so that the router will count the packets that are sourced from the IP segment 10.0.1.0/24.
<Sysname> system-view
[Sysname] posa statistics caller-ip 1 10.0.1.0 255.255.255.0
Related commands
display posa statistics caller-ip
posa terminal
Use posa terminal to create a TCP access POS terminal template.
Use undo posa terminal to delete the specified POS terminal template.
Syntax
posa terminal terminal-id type tcp listen-port port [ idle-time time ] [ http | https | ssl ]
undo posa terminal terminal-id
Default
No TCP access POS terminal templates exist.
Views
System view
Predefined user roles
network-admin
Parameters
terminal-id: Specifies a POS terminal template ID in the range of 1 to 1024.
type tcp: Specifies TCP mode.
listen-port port: Specifies a listening port number in the range of 1 to 65535.
idle-time time: Specifies the idle timeout for the POS terminal template, in the range of 1 to 1440 minutes. The default value of 0 indicates that no limit is set for the idle time.
http: Use HTTPS connections to communicate with the POS terminal.
The following matrix shows the http keyword and hardware compatibility:
Hardware |
Keyword compatibility |
MSR810/810-W/810-W-DB/810-LM/810-W-LM/810-10-PoE/810-LM-HK/810-W-LM-HK/810-LMS/810-LUS |
No |
MSR2600-6-X1/2600-10-X1 |
No |
MSR 2630 |
Yes |
MSR3600-28/3600-51 |
Yes |
MSR3600-28-SI/3600-51-SI |
No |
MSR3610-X1/3610-X1-DP/3610-X1-DC/3610-X1-DP-DC |
Yes |
MSR 3610/3620/3620-DP/3640/3660 |
Yes |
MSR5620/5660/5680 |
Yes |
https: Uses HTTPS connections to communicate with the POS terminal.
ssl: Uses SSL-based TCP connections to communicate with the POS terminal.
Usage guidelines
For flow or dial-up access mode, a corresponding terminal template is created automatically when you specify an access interface for the POS terminal. For TCP access mode, you need to create a template manually.
Do not set the same listening port number for multiple TCP access terminal templates. To set a new listening port number for the TCP access terminal template, first execute the undo posa terminal command to remove the existing listening port number setting.
If a POS terminal template does not exchange any packet with a POS terminal during the specified idle timeout period, the POS terminal template disconnects from the POS terminal.
If you specify the https or ssl keyword, execute the posa terminal ssl-server-policy command to specify the SSL server policy that the device uses to establish HTTPS or SSL connections with POS terminals.
Examples
# Create TCP access POS terminal template 1, set its listening port number to 3000, and configure the device to communicate with the POS terminal through HTTPS.
<Sysname> system-view
[Sysname] posa terminal 1 type tcp listen-port 3000 https
Related commands
posa bind terminal
posa terminal ssl-server-policy
posa terminal description
Use posa terminal terminal-id description to configure a description for a POS terminal template.
Use undo posa terminal terminal-id description to delete the POS terminal template description.
Syntax
posa terminal terminal-id description text
undo posa terminal terminal-id description
Default
No description is configured for a POS terminal template.
Views
System view
Predefined user roles
network-admin
Parameters
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024.
text: Specifies a description for the POS terminal template, a case-sensitive string of 1 to 32 printable characters except question marks (?).
Usage guidelines
You can configure a description for a POS terminal template before creating the POS terminal template.
Examples
# Configure the description as shopping1 for POS terminal template 1.
<Sysname> system-view
[Sysname] posa terminal 1 description shopping1
Related commands
posa terminal
posa terminal ssl-server-policy
Use posa terminal ssl-server-policy to specify an SSL server policy for TCP-based POS terminal templates.
User undo posa terminal ssl-server-policy to restore the default.
Syntax
posa terminal ssl-server-policy policy-name
undo posa terminal ssl-server-policy
Default
No SSL server policy is specified for TCP-based POS terminal templates.
Views
System view
Predefined user roles
network-admin
Parameters
policy-name: Specifies an SSL server policy by its name, a case-insensitive string of 1 to 31 characters.
Usage guidelines
Execute this command if you specify the https or ssl keyword of the posa terminal command. The device uses the SSL server policy parameters to establish HTTPS or SSL connections with POS terminals.
Examples
# Specify SSL server policy policy1 for TCP-based POS terminal templates.
<Sysname> system-view
[Sysname] posa terminal ssl-server-policy policy1
Related commands
posa terminal
ssl server-policy (see Security Command Reference)
posa tpdu-replace
Use posa tpdu-replace to configure a TPDU destination address replacement policy. The router uses the policy to replace the TPDU destination addresses of packets before looking up the application mapping table.
Use undo posa tpdu-replace to delete a TPDU destination address replacement policy.
Syntax
posa tpdu-replace match terminal { terminal-id | any } destination { des-code | any } to des-code
undo posa tpdu-replace match terminal { terminal-id | any } [ destination { des-code | any } ]
Default
The router does not replace the TPDU destination address.
Views
System view
Predefined user roles
network-admin
Parameters
terminal terminal-id: Specifies a POS terminal template by its ID. The router replaces the TPDU destination address for all packets sent by the terminal with the target destination address.
terminal any: Specifies all POS terminal templates. The router replaces the TPDU destination address for packets sent by any terminal with the specified target destination address.
destination des-code: Specifies the TPDU destination address to be replaced. The router replaces the matched TPDU destination addresses with the specified target destination address.
destination any: Sets the TPDU destination address to be replaced to any address. The router replaces the TPDU destination address for packets sent by any matched terminal with the specified target destination address.
to des-code: Specifies the target TPDU destination address.
Usage guidelines
You can configure multiple TPDU destination address replacement policies. The router uses the policies in the following order of decreasing priority:
· Policies configured with both the terminal-id and the des-code arguments.
· Policies configured with both the terminal-id argument and the destination any keywords.
· Policies configured with both the terminal any keywords and the des-code argument.
· Policies configured with both the terminal any and the destination any keywords.
The router uses the original TPDU destination address as the source address to send reply messages to POS terminals.
Examples
# Configure the router to replace the TPDU destination address of POS packets destined for 0002 with 0003 for terminal 1.
<Sysname> system-view
[Sysname] posa tpdu-replace match terminal 1 destination 0002 to 0003
Related commands
tpdu-change
posa trade-falling-threshold
Use posa trade-falling-threshold to configure the alarm threshold for the low NII transaction success rate.
Use undo posa trade-falling-threshold to restore the default.
Syntax
posa trade-falling-threshold threshold-value
undo posa trade-falling-threshold
Default
The alarm threshold for the low NII transaction success rate is 90%.
Views
System view
Default command level
network-admin
Parameters
threshold-value: Specifies the alarm threshold for the low NII transaction success rate in percentage, in the range of 1 to 99.
Usage guidelines
The router generates SNMP notifications for trade-success-falling events when the following requirements are met:
· SNMP notification is enabled for trade-success-falling events.
· NII transaction success rate drops below the threshold.
Examples
# Set the alarm threshold to 80% for the low NII transaction success rate.
<Sysname> system-view
[Sysname] posa trade-falling-threshold 80
Related commands
snmp-agent trap enable posa
posa trade-limit tcp
Use posa trade-limit tcp to set the TCP concurrent transaction threshold.
Use undo posa trade-limit tcp to restore the default.
Syntax
posa trade-limit tcp limit-value
undo posa trade-limit tcp
Default
No limit is set to the number of concurrent transactions on a TCP connection.
Views
System view
Predefined user roles
network-admin
Parameters
limit-value: Specifies the concurrent transaction threshold for each TCP connection, in the range of 0 to 65535. The value of 0 indicates that no limit is set to the number of TCP concurrent transactions.
Usage guidelines
You can install licenses to increase the concurrent transaction threshold for each TCP connection supported by the device. For more information about licenses, see Fundamentals Configuration Guide.
If the TCP concurrent transaction threshold is configured, the router discards the packets that exceed the threshold. If SNMP notification is also enabled for tcp-trade-exceed events, the router generates notifications by using the following scheme:
1. The router generates a notification when the number of concurrent transactions on a TCP connection exceeds the threshold for the first time.
2. The router does not generate any notifications before the number of concurrent transactions on that TCP connection drops below 90% the threshold.
3. After the number of concurrent transactions drops below 90% of the threshold, the router continues to generate a notification when the threshold is exceeded.
This scheme prevents frequent SNMP notifications in case of heavy transaction traffic.
Examples
# Set the TCP concurrent transaction threshold to 1024.
<Sysname> system-view
[Sysname] posa trade-limit tcp 1024
Related commands
snmp-agent trap enable posa
posa trade-timeout
Use posa trade-timeout to set the timeout for each transaction.
Use undo posa trade-timeout to restore the default.
Syntax
posa trade-timeout timeout-value
undo posa trade-timeout
Default
The timeout for each transaction is 240 seconds.
Views
System view
Predefined user roles
network-admin
Parameters
timeout-value: Specifies the timeout for each transaction, in the range of 1 to 240 seconds.
Usage guidelines
The timeout timer is set when the router receives a transaction packet from a POS terminal. If the router receives no reply from the FEP before the timer expires, the transaction times out. The router discards the reply packet that is received after the timer expires.
If the network condition is poor, do not configure a small transaction timeout. A small transaction timeout might cause the router to reassign the transaction number of an expired transaction to a new transaction. Then, the router treats the reply to the expired transaction as the reply to the new transaction.
Examples
# Set the timeout for each transaction to 120 seconds.
<Sysname> system-view
[Sysname] posa trade-timeout 120
reset fcm statistics
Use reset fcm statistics to clear statistics for FCM interfaces.
Syntax
reset fcm statistics [ interface fcm { interface-number | interface-number:setnumber.subnumber } ]
Views
User view
Predefined user roles
network-admin
Parameters
interface fcm { interface-number | interface-number:setnumber.subnumber }: Specifies an FCM interface or FCM subinterfaces. The interface-number argument represents the interface number of a physical FCM interface. The interface-number:setnumber.subnumber argument represents subinterfaces of the FCM interface channelized from an E1POS CE1/PRI interface. If no interface is specified, this command displays POS statistics for all physical FCM interfaces and subinterfaces of FCM interfaces channelized from E1POS CE1/PRI interfaces.
Examples
# Clear POS statistics for all physical FCM interfaces and subinterfaces of FCM interfaces channelized from E1POS CE1/PRI interfaces.
<Sysname> reset fcm statistics
Related commands
display fcm statistics
reset posa connection terminal
Use reset posa connection terminal to disconnect TCP connections between the router and POS terminal devices.
Syntax
reset posa connection terminal { all | destination-ip ip-addr2 | destination-port port-number | source-ip ip-addr1 }
Views
User view
Predefined user roles
network-admin
Parameters
all: Disconnects all TCP connections between the router and POS terminal devices.
destination-ip ip-addr2: Specifies a destination IP address.
destination-port port-number: Specifies a destination port number in the range of 1 to 65535.
source-ip ip-addr1: Specifies a source IP address.
Usage guidelines
This command disconnects a single or multiple TCP connections based on the specified source IP address, destination IP address, and destination port number.
The number of disconnections is displayed when you execute this command.
Examples
# Disconnect all TCP connections between the router and POS terminal devices.
<Sysname> reset posa statistics
100 connections have been deleted.
reset posa statistics
Use reset posa statistics to clear POS transaction statistics.
Syntax
reset posa statistics [ app [ app-id ] | terminal [ terminal-id ] ] | nii [ nii-id ]
Views
User view
Predefined user roles
network-admin
Parameters
app-id: Specifies a POS application template by its ID, in the range of 1 to 1024.
terminal-id: Specifies a POS terminal template by its ID, in the range of 1 to 1024.
nii-id: Specifies a TPDU destination address, a four-hexadecimal-digit string such as ffff.
Usage guidelines
This command clears the statistics that are displayed by the following commands:
· display posa statistics app.
· display posa statistics caller-id.
· display posa statistics caller-ip.
· display posa statistics nii.
· display posa statistics terminal.
When you use this command to clear statistics for an application template or terminal template that does not exist, the router does not display an error message.
Examples
# Clear POS transaction statistics.
<Sysname> reset posa statistics
Related commands
display posa statistics app
display posa statistics caller-id
display posa statistics caller-ip
display posa statistics nii
display posa statistics terminal
trade-exchanges
snmp-agent trap enable posa
Use snmp-agent trap enable posa to enable SNMP notifications for POS terminal access.
Use undo snmp-agent trap enable posa to disable SNMP notifications for POS terminal access.
Syntax
snmp-agent trap enable posa [ app-state-change | e1-dial-falling | fcm-connection-exceed | fcm-link-failure | fcm-physical-failure | fcm-trade-abnormal | server-state-change | tcp-connection-exceed | tcp-trade-exceed | terminal-hangup | trade-success-falling ] *
undo snmp-agent trap enable posa [ app-state-change | e1-dial-falling | fcm-connection-exceed | fcm-link-failure | fcm-trade-abnormal | fcm-physical-failure | server-state-change | tcp-connection-exceed | tcp-trade-exceed | terminal-hangup | trade-success-falling ] *
Default
SNMP notifications for all POS terminal access events are enabled.
Views
System view
Predefined user roles
network-admin
Parameters
app-state-change: Enables notifications for POS application template state changes.
e1-dial-falling: Enables notifications for the low E1 dialing success rate events.
fcm-connection-exceed: Enables notifications for FCM concurrent connections exceeding the threshold events.
fcm-link-failure: Enables notifications for POS application template state changes.
fcm-physical-failure: Enables notifications for negotiation failures on the FCM physical layer.
fcm-trade-abnormal: Enables notifications for abnormal transaction events on FCM interfaces. A transaction is regarded as abnormal when the router sends the transaction packet but receives no reply.
server-state-change: Enables notifications for POS access server state changes.
tcp-connection-exceed: Enables notifications for TCP concurrent connections exceeding the threshold events.
tcp-trade-exceed: Enables notifications for TCP concurrent transactions exceeding the threshold events.
terminal-hangup: Enables notifications for POS terminal hangups.
trade-success-falling: Enables notifications for the low NII transaction success rate events.
Usage guidelines
This feature enables generating SNMP notifications for POS access events. For POS terminal access notifications to be sent correctly, you must also configure SNMP on the device. For more information about SNMP configuration, see the network management and monitoring configuration guide for the device.
If you do not specify any keywords, this command enables or disables SNMP notifications for all types of POS access events.
Examples
# Disable SNMP notifications for FCM physical layer negotiation failures.
<Sysname> system-view
[Sysname] undo snmp-agent trap enable posa fcm-physical-failure
Related commands
posa connection-threshold terminal
posa trade-limit tcp
source ip
Use source ip to specify a source address for TCP connections.
Use undo source ip to restore the default.
Syntax
source ip ip-address
undo source ip
Default
No source address for TCP connections is specified.
Views
POS application template view
Predefined user roles
network-admin
Parameters
ip-address: Specifies a source IP address for a TCP connection. The address can be any unicast IPv4 address except the loopback address. Make sure the FEP is reachable from this IP address.
Usage guidelines
By default, the router uses the IP address of the interface bound to the application template to initialize a TCP connection to the FEP. For security purposes, you can use this command to specify an IP address as the source IP address.
Changing of the source address also deletes all existing TCP connections for the application template.
Examples
# Set the source address to 1.1.1.1 for POS application template 1. All existing connections for application template 1 are deleted.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] source ip 1.1.1.1
Connections for the application have been reset.
source port
Use source port to specify a source port number for TCP connections. The router must use the specified source port number to establish a TCP connection with the FEP.
Use undo source port to restore the default.
Syntax
source port port-number
undo source port
Default
No source port number is specified for TCP connections. The POS application template uses an available port number randomly assigned by the system to establish a TCP connection with the FEP.
Views
POS application template view
Predefined user roles
network-admin
Parameters
port-number: Specifies a source port number for TCP connections, in the range of 4000 to 4999.
Usage guidelines
If you specify a source port for a POS application template in temporary TCP connection mode, only one connection from the application template to the FEP can be created.
Changing the source port number also deletes all existing TCP connections for the application template.
The specified source port number must not be assigned to any other POS application template and must be different from the listening port number for the POS terminal. If you specify a source port number that is the same as the port number of any other system process, the source port does not take effect. You can use display posa status command to see which TCP ports have been occupied by other system processes.
Examples
# Set the source port number to 4001 for POS application template 1. All existing connections for application template 1 are deleted.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] source port 4001
Connections for the application have been reset.
tcp keepalive
Use tcp keepalive to configure TCP keepalive parameters for a POS application template.
Use undo tcp keepalive to restore the default.
Syntax
tcp keepalive interval interval count counts
undo tcp keepalive
Default
TCP keepalive packets are sent every 2 seconds. The router tears down the TCP connection to the POS application template if no reply is received during three sending intervals.
Views
POS application template view
Predefined user roles
network-admin
Parameters
interval interval: Specifies the keepalive interval in the range of 1 to 7200 seconds.
count counts: Specifies the keepalive number in the range of 2 to 100.
Usage guidelines
The configuration takes effect immediately.
The timeout of a TCP connection is the keepalive interval multiplied by the keepalive number. If no reply is received before the timeout timer expires, the router tears down the TCP connection.
Examples
# Configure TCP-based POS application template 1. Set the keepalive interval to 100 seconds and the keepalive number to 4.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] tcp keepalive interval 100 count 4
tcp linking-time
Use tcp linking-time to configure the timeout for the TCP connection request to the FEP. The timeout is the maximum time that the POS application template can stay in TCP linking state.
Use undo tcp linking-time to restore the default.
Syntax
tcp linking-time time
undo tcp linking-time
Default
The maximum TCP linking time is 20 seconds.
Views
POS application template view
Predefined user roles
network-admin
Parameters
time: Specifies the maximum TCP linking time, in the range of 1 to 20 in seconds.
Usage guidelines
If the maximum TCP linking time expires, the TCP connection request is canceled and the transaction fails. This command also specifies the maximum time that the router waits for the FEP to respond to a caller ID negotiation packet from an AM POS terminal device.
The configuration takes effect only for TCP connections established after this command is executed.
Examples
# Set the maximum TCP linking time to 10 seconds for POS application template 1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] tcp linking-time 10
terminal-ip append
Use terminal-ip append to enable sending of the caller IP address in packets sent to the FEP.
Use undo terminal-ip append to disable sending of the caller IP address.
Syntax
terminal-ip append
undo terminal-ip append
Default
Sending of the caller IP address to the FEP is disabled.
Views
POS application template view
Predefined user roles
network-admin
Usage guidelines
The following matrix shows the command and hardware compatibility:
Hardware |
Command compatibility |
MSR810/810-W/810-W-DB/810-LM/810-W-LM/810-10-PoE/810-LM-HK/810-W-LM-HK/810-LMS/810-LUS |
No |
MSR2600-6-X1/2600-10-X1 |
No |
MSR 2630 |
Yes |
MSR3600-28/3600-51 |
Yes |
MSR3600-28-SI/3600-51-SI |
No |
MSR3610-X1/3610-X1-DP/3610-X1-DC/3610-X1-DP-DC |
Yes |
MSR 3610/3620/3620-DP/3640/3660 |
Yes |
MSR5620/5660/5680 |
Yes |
This feature is applicable only when the POS terminal access mode is TCP.
Enable this feature on the POS access device only when the FEP supports the caller IP address display function.
When the cascade mode is used, enable this feature only on the router that is directly connected to the FEP.
Examples
# Enable sending of caller IP addresses for POS application template 1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] terminal-ip append
threshold answer-tone
Use threshold answer-tone to set the modem negotiation answer-tone threshold.
Use undo threshold answer-tone to restore the default.
Syntax
threshold answer-tone answertonetime
undo threshold answer-tone
Default
The modem negotiation answer-tone threshold is -18 dBm when the E1POS interface module is used and -9 dBm when the FCM interface module is used.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
answertonetime: Specifies the modem negotiation answer-tone threshold, in the range of 1 to 42 -dBm.
Examples
# Set the modem negotiation answer-tone threshold to -41 dBm for FCM 2/1/0.
<Sysname> system-view
[Sysname] interface fcm 2/1/0
[Sysname–Fcm2/1/0] threshold answer-tone 41
threshold rlsdoff
Use threshold rlsdoff to set the RLSD turn-off threshold for modem negotiation.
Use undo threshold rlsdoff to restore the default.
Syntax
threshold rlsdoff rlsdofftime
undo threshold rlsdoff
Default
The RLSD turn-off threshold for modem negotiation is -48 dBm.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
rlsdofftime: Specifies the RLSD turn-off threshold in the range of 0 to 75 -dBm.
Examples
# Set the RLSD turn-off threshold to -74 dBm for FCM 2/1/0.
<Sysname> system-view
[Sysname] interface fcm 2/1/0
[Sysname–Fcm2/1/0] threshold rlsdoff 74
threshold rlsdon
Use threshold rlsdon to set the RLSD turn-on threshold for modem negotiation.
Use undo threshold rlsdon to restore the default.
Syntax
threshold rlsdon rlsdontime
undo threshold rlsdon
Default
The RLSD turn-on threshold for modem negotiation is -43 dBm.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
rlsdofftime: Specifies the RLSD turn-on threshold in the range of 0 to 75-dBm.
Examples
# Set the RLSD turn-on threshold to -73 dBm for FCM 2/1/0.
<Sysname> system-view
[Sysname] interface fcm 2/1/0
[Sysname–Fcm2/1/0] threshold rlsdon 73
threshold txpower
Use threshold txpower to set the transmission power threshold for modem negotiation.
Use undo threshold txpower to restore the default.
Syntax
threshold txpower txpowertime
undo threshold txpower
Default
The modem negotiation transmission power threshold is -10 dBm for a physical FCM interface.
The modem negotiation transmission power threshold is -18 dBm for a channelized FCM interface.
Views
FCM interface view
Predefined user roles
network-admin
Parameters
rlsdofftime: Specifies the modem negotiation transmission power threshold, in the range of 1 to 42 -dBm.
Examples
# Set the modem negotiation transmission power threshold to -40 dBm for FCM 2/1/0.
<Sysname> system-view
[Sysname] interface fcm 2/1/0
[Sysname–Fcm2/1/0] threshold txpower 40
timer auto-connect
Use timer auto-connect to set the interval between auto connections to the FEP for the POS application template.
Use undo timer auto-connect to restore the default.
Syntax
timer auto-connect interval
undo timer auto-connect
Default
A POS application template automatically initiates a connection to the FEP every 10 minutes.
Views
POS application template view
Predefined user roles
network-admin
Parameters
interval: Specifies the interval at which the POS application template automatically initiates a connection to the FEP, in the range of 1 to 1440 minutes.
Usage guidelines
This command is applicable only to POS application templates that use permanent TCP connection mode.
Before the router successfully establishes a permanent TCP connection with the FEP for a POS application template, the router automatically initiates connections to the FEP at the specified interval.
Examples
# Set the auto connection interval for the POS application template 1 to 1 minute.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] timer auto-connect 1
Related commands
auto-connect enable
timer hello
Use timer hello to set the interval for a POS application template to send handshaking packets.
Use undo timer hello to restore the default.
Syntax
timer hello interval
undo timer hello
Default
A POS application template sends handshaking packets every 1 minute.
Views
POS application template view
Predefined user roles
network-admin
Parameters
interval: Specifies the interval at which the POS application template sends handshake packets, in the range of 1 to 600 minutes.
Usage guidelines
After you enable handshaking for an application template and specify the interval, the router sends handshaking packets to the FEP at the specified interval.
Examples
# Set the handshaking interval time for POS application template 1 to 10 minutes.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] timer hello 10
Related commands
hello enable
timer quiet
Use timer quiet to set the quiet time for a POS application template.
Use undo timer quiet to restore the default.
timer quiet interval
undo timer quiet
Default
The quiet time for a POS application template is 600 minutes.
Views
POS application template view
Predefined user roles
network-admin
Parameters
interval: Specifies the quiet time for the POS application template, in the range of 10 to 600 minutes.
Usage guidelines
When a POS terminal launches a transaction, the router tries to establish a TCP connection with the FEP. If the FEP is unreachable, the router places the FEP to blocked state and starts the quiet timer.
The configuration takes effect immediately and the quiet timer restarts at 0.
Examples
# Set the quiet timer for POS application template 1 to 500 minutes.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] timer quiet 500
Related commands
backup app
tpdu-change
Use tpdu-change to configure the TPDU address change policy. The router uses the policy to change either the TPDU originator or destination addresses of packets before sending them to FEPs.
Use undo tpdu-change to restore the default.
Syntax
tpdu-change { destination | source }
undo tpdu-change
Default
The router changes the TPDU originator address.
Views
POS application template view
Predefined user roles
network-admin
Parameters
destination: Changes the TPDU destination addresses of packets.
source: Changes the TPDU originator addresses of packets.
Usage guidelines
FEPs require the change of either the originator or destination address in the TPDU field. Determine the TPDU address change policy according to the requirements of FEPs.
In nontransparent mode, modifying the TPDU address change policy also removes all permanent TCP connections governed by the application template.
Examples
# Configure the router to change the TPDU destination address of packets sent to the FEP that corresponds to POS application template 1.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] tpdu-change destination
Connections for the application have been reset.
trade-exchanges
Use trade-exchanges to configure the minimum number of packet round trips for a successful NII transaction.
Use undo trade-exchanges to restore the default.
Syntax
trade-exchanges counts
undo trade-exchanges
Default
The minimum number of packet round trips for a successful NII transaction is 1.
Views
POS application template view
Default command level
network-admin
Parameters
counts: Specifies the minimum number of packet round trips for a successful NII transaction, in the range of 1 to 16.
Usage guidelines
You can configure the minimum number of packet round trips for a successful NII transaction based on service needs. An NII transaction is regarded as successful only when the number of packet round trips between the router and the FEP is equal to or greater than the specified value.
Examples
# Set the minimum number of packet round trips to 5 for a successful NII transaction.
<Sysname> system-view
[Sysname] posa app 1 type tcp
[Sysname-posa-app1] trade-exchanges 5
Related commands
display posa statistics nii
reset posa statistics
RTC terminal access commands
The following matrix shows the feature and hardware compatibility:
Hardware |
RTC terminal access compatibility |
MSR810/810-W/810-W-DB/810-LM/810-W-LM/810-10-PoE/810-LM-HK/810-W-LM-HK/810-LMS/810-LUS |
No |
MSR2600-6-X1/2600-10-X1 |
No |
MSR 2630 |
Yes |
MSR3600-28/3600-51 |
Yes |
No |
|
MSR3610-X1/3610-X1-DP/3610-X1-DC/3610-X1-DP-DC |
Yes |
MSR 3610/3620/3620-DP/3640/3660 |
Yes |
MSR5620/5660/5680 |
Yes |
Hardware |
RTC terminal access compatibility |
MSR810-LM-GL |
No |
MSR810-W-LM-GL |
No |
MSR830-6EI-GL |
No |
MSR830-10EI-GL |
No |
MSR830-6HI-GL |
No |
MSR830-10HI-GL |
No |
MSR2600-6-X1-GL |
No |
MSR3600-28-SI-GL |
No |
auto-close
Use auto-close to set the automatic link teardown time.
Use undo auto-close to restore the default.
Syntax
auto-close time
undo auto-close
Default
The automatic link teardown time is 0, which indicates that automatic link teardown is disabled.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
time: Specifies the automatic link teardown time in the range of 5 to 240 seconds.
Usage guidelines
Automatic link teardown for a terminal is enabled after you specify an automatic link teardown time in the terminal template view. Then, when the terminal and the initiator are disconnected from each other for the specified teardown time, the initiator automatically tears down the TCP connection to the receiver. The TCP connection always remains active if automatic link teardown is disabled.
Examples
# Set the automatic link teardown time to 10 seconds.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] auto-close 10
Related commands
auto-link
auto-link
Use auto-link to enable automatic link establishment and set the automatic link establishment time.
Use undo auto-link to restore the default.
Syntax
auto-link time
undo auto-link
Default
The automatic link establishment time is 0. The value of 0 indicates that automatic link establishment is disabled and a link needs to be established manually.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
time: Specifies the automatic link establishment time in the range of 5 to 240 seconds.
Usage guidelines
Automatic link establishment for a terminal is enabled after you specify an automatic link establishment time in the terminal template view. Then, when the terminal is in Up state for the specified link establishment time, the initiator automatically establishes a TCP connection to the receiver. If automatic link establishment is disabled, a link needs to be established manually. The initiator establishes a TCP connection to the receiver only after you enter a character on the terminal. The characters cannot be hotkeys or the special characters that terminals can process directly, such as Shift+F2.
Examples
# Set the automatic link establishment time to 10 seconds.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] auto-link 10
Related commands
auto-close
bind vpn-instance
Use bind vpn-instance to bind a VPN instance to a terminal template.
Use undo bind vpn-instance to restore the default.
Syntax
bind vpn-instance vpn-instance-name
undo bind vpn-instance
Default
No VPN instance is bound to a terminal template.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters.
Usage guidelines
When the RTC client is also acting as an MPLS PE router, you can configure this command on the RTC client to identify terminals in VPNs. To bind a terminal to a VPN instance:
· Create a terminal template.
· Bind the terminal template to the VPN instance.
· Apply the terminal template to the asynchronous serial interface connected to the terminal.
If you do not configure this command on the RTC server, the RTC server receives connection requests from any VPNs.
You can bind only one VPN instance to each terminal template. If you execute this command for a terminal template multiple times, the most recent configuration takes effect.
Examples
# Bind the VPN instance vpn1 to the terminal template abc.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] bind vpn-instance vpn1
display rta
Use display rta to display terminal access information.
Syntax
display rta { all | statistics | terminal-number { vty-number | brief | detail | statistics } }
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
all: Displays information about all terminals.
statistics: Displays statistics for terminals.
terminal-number: Specifies a terminal by its number, in the range of 1 to 255.
vty-number: Specifies a VTY by its number, in the range of 0 to 7.
brief: Displays brief information about the specified terminal.
detail: Displays detailed information about the specified terminal.
Examples
# Display information about VTY 1 of terminal 1.
<Sysname> display rta 1 1
VTY 1
APP index: 0
APP type: RTC Client
APP state: Unlinked
Remote IP: 192.168.0.110
Source IP: Not configured
Actual source IP: --
Remote port: 9010
Local port: Not configured
Connection duration: 00:00:00
Table 10 Command output
Field |
Description |
APP Index |
Application index. |
APP Type |
Application type: RTC client or RTC server. |
APP State |
Application state: · Unlinked—Application is not connected. · Linking—Application is being connected. This state is available only for a TCP RTC client. · Linked—Application is connected. If a template has no applications, this field displays two hyphens (--). |
Remote IP |
IP address of the peer access device. |
Source IP |
Source IP address that is configured for the VTY in terminal template view. |
Actual Source IP |
Actual source IP address that is used for establishing a connection. If the connection is not established, this field displays two hyphens (--). |
Remote Port |
Listening port number of the peer access device. |
Local Port |
Listening port number of the local access device. |
Connection duration |
Time since the application was connected, in the format hh:mm:ss. |
# Display brief information about terminal 1.
<Sysname> display rta 1 brief
TTY 1
Interface used : Async2/2/0
Current state : Up
Current APP : 0
APP type : RTC client
APP name : Not configured
APP state : Unlinked
Socket recvBuf Size : 2048 bytes
Socket sendBuf Size : 2048 bytes
TTY auto-link : 10 seconds
TTY close-link : 10 seconds
TTY receive bytes : 1371 bytes
TTY send bytes : 63696 bytes
Last receive time : 19:39:33
Last send time : 03:39:34
Current APP receive : 55280 bytes
Current APP send : 1524 bytes
Time from APP is linked: 00:00:00
------------------------------------
VTY APP Type State
0 0 RTC client Unlinked
Table 11 Command output
Field |
Description |
TTY 1 |
TTY terminal whose terminal number is 1. |
Interface used |
Physical interface corresponding to the terminal number. |
Current state |
Current terminal state: · Down—The physical connection is down. · Up—The physical connection is up. |
Current APP |
Current application. |
APP type |
Application type. |
APP name |
Application name. |
APP state |
Application state. |
Socket recvbuf size |
TCP receive buffer size. |
Socket sendbuf size |
TCP send buffer size. |
TTY auto-link |
Automatic link establishment time. |
TTY close-link |
Automatic link teardown time. |
TTY receive bytes |
Data in bytes that is received. |
TTY send bytes |
Data in bytes that is sent. |
Last receive time |
Time when last data was received. |
Last send time |
Time when last data was sent. |
Current APP receive |
Data in bytes received by the current application. |
Current APP send |
Data in bytes sent by the current application. |
Time from APP is linked |
Time since the application was connected. |
VTY APP Type State |
VTY list configured on the terminal: · VTY—VTY number. · APP—Application. · Type—Application type. · State—Application state. |
# Display statistics about terminal 1.
<Sysname> display rta 1 statistics
TTY 1
Received from terminal: 1231
Send to terminal: 348
Received from remote: 8342
Send to remote: 7342
VTY 0
Receive from terminal: 1231 Last receive time: 03:08:29
Send to terminal: 348 Last send time: 01:10:30
Receive from remote: 8342 Last receive time: 17:21:25
Send to remote: 7342 Last send time: 09:44:43
Table 12 Command output
Field |
Description |
Receive from terminal |
Data in bytes received from the terminal. |
Send to terminal |
Data in bytes sent to the terminal. |
Receive from remote |
Data in bytes received from the remote terminal. |
Send to remote |
Data in bytes sent to the remote terminal. |
Last receive time |
Time when last data was received, in the format hh:mm:ss. If no data was received, this field displays two hyphens (--). |
Last send time |
Time when last data was sent, in the format hh:mm:ss. If no data was sent, this field displays two hyphens (--). |
# Display all terminal access information.
<Sysname> display rta all
TTYID TTY State Current APP APP Type APP State
1 Up 0 RTC client Unlinked
Table 13 Command output
Field |
Description |
TTYID |
Terminal number. |
TTY State |
Terminal state. |
Current APP |
Current application. |
APP Type |
Application type. |
APP State |
Application state. |
# Display terminal access statistics.
<Sysname> display rta statistics
RTA template number: 2
RTA TTY number: 1
RTA APP number: 1
RTA listen port number: 0
Table 14 Command output
Field |
Description |
RTA template number |
Number of terminal templates configured on the router. |
RTA TTY number |
Number of terminals configured on the router. |
RTA APP number |
Number of applications generated after terminal configuration. |
RTA listen port number |
Number of listening ports on the router. |
Related commands
display rta relay statistics
display rta relay status
display rta relay statistics
Use display rta relay statistics to display the forwarding statistics of a relay server.
Syntax
display rta relay statistics
Views
Any view
Predefined user roles
network-admin
network-operator
Usage guidelines
A relay server calculates the bytes and packets that are received from and sent to RTC clients.
Examples
# Display the forwarding statistics of a relay server.
<Sysname> display rta relay statistics
Server Port Client-IP Recv-Packets Recv-Bytes Sent-Packets Sent-Bytes
0 1026 1.1.1.2 15 190 30 370
0 1026 1.1.1.3 15 110 35 421
1 1027 1.1.1.4 0 0 0 0
Table 15 Command output
Field |
Description |
Server |
Forwarding group ID. |
Port |
TCP listening port of the forwarding group. |
Client-IP |
IP address of a client. |
recv-packets |
Number of packets received from a client. |
recv-bytes |
Bytes received from a client. |
sent-packets |
Number of packets sent to a client. |
sent-bytes |
Bytes sent to a client. |
Related commands
display rta
display rta relay status
display rta relay status
Use display rta relay status to display states of all RTC client connections accepted by a relay server.
Syntax
display rta relay status
Views
Any view
Predefined user roles
network-admin
network-operator
Usage guidelines
A relay server can accept a maximum of 10 client connections in each forwarding group. A forwarding group is identified by a port number.
Examples
# Display states of all RTC client connections accepted by a relay server.
<Sysname> display rta relay status
Server-ID Port Client-ID Client-IP State
0 1026 0 1.1.1.2 Linked
0 1026 1 1.1.1.3 Linked
1 1027 0 1.1.1.4 Linking
1 1027 2 1.1.1.6 Linked
Table 16 Command output
Field |
Description |
Server-ID |
Forwarding group ID. |
Port |
TCP listening port for a forwarding group. |
Client-ID |
Client identifier in a forwarding group. |
Client-IP |
Client IP address. |
State |
Client negotiation status: · Linking—The client has not sent the negotiation field. · Linked—The client has completed the negotiation process. |
Related commands
display rta
display rta relay statistics
driverbuf save
Use driverbuf save to configure a router not to clear the terminal receive buffer after a TCP connection is established.
Use undo driverbuf save to restore the default.
Syntax
driverbuf save
undo driverbuf save
Default
The router clears the terminal receive buffer after a TCP connection is established.
Views
Terminal template view
Predefined user roles
network-admin
Usage guidelines
The terminal receive buffer is used by a router to store data exchanged with terminals.
Examples
# Configure the router not to clear the terminal receive buffer after a TCP connection is established.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] driverbuf save
Related commands
driverbuf size
driverbuf size
Use driverbuf size to configure the size of the terminal receive buffer.
Use undo driverbuf size to restore the default.
Syntax
driverbuf size size
undo driverbuf size
Default
The size of the terminal receive buffer is 8 KB.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
size: Specifies the receive buffer size in the range of 8 to 32 KB.
Usage guidelines
If the terminal template has been applied to an interface, this command takes effect only after the terminal template is re-applied to the interface.
Examples
# Set the receive buffer size to 8 KB.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] driverbuf size 8
drivebuf save
idle-timeout
Use idle-timeout to set the TCP connection idle timeout time for RTC terminal access.
Use undo idle-timeout to restore the default.
Syntax
idle-timeout seconds
undo idle-timeout
Default
The TCP connection never times out.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
seconds: Specifies the connection idle timeout time in the range of 10 to 3600 seconds.
Usage guidelines
A TCP connection is automatically torn down when the following conditions are met:
· A TCP connection idle timeout time is set.
· No data is transmitted over the TCP connection during the specified idle timeout time.
Examples
# Set the terminal access idle timeout time to 1000 seconds.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] idle-timeout 1000
link-protocol stlp
Use link-protocol stlp to enable STLP encapsulation on an interface.
Use Undo link-protocol stlp to restore the default.
Syntax
link-protocol stlp
undo link-protocol stlp
Default
PPP encapsulation is enabled on all interfaces except Ethernet and VLAN interfaces.
Views
Interface view
Predefined user roles
network-admin
Usage guidelines
Secure Transport Layer Protocol (STLP) is a data link layer protocol. STLP is used for synchronous transparent transmission over remote terminal connections.
Examples
# Enable STLP encapsulation on interface Serial 2/1/0.
<Sysname> system-view
[Sysname] interface serial 2/1/0
[Sysname-Serial2/1/0] link-protocol stlp
resetkey
Use resetkey to configure the terminal reset hotkey.
Use undo resetkey to restore the default.
Syntax
resetkey ascii-code&<1-3>
undo resetkey
Default
No terminal reset hotkey is configured.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
ascii-code&<1-3>: Specifies the ASCII value of the terminal reset hotkey, in the range of 1 to 255. The &<1-3> means that you can enter a maximum of three ASCII values.
Usage guidelines
When a terminal fault occurs, you can press the terminal reset hotkey on the terminal. The RTC client tears down and then re-establishes the TCP connection with the RTC server.
The ASCII value of the hotkey configured for terminal reset must be different from that of any other hotkeys configured on the device. Otherwise, hotkey conflicts occur. Using the hotkey might not get a fast response when the terminal display is busy.
Examples
# Set the terminal reset hotkey to Ctrl+A by setting its ASCII value to 1.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] resetkey 1
reset rta connection
Use reset rta connection to forcibly tear down the TCP connection corresponding to a VTY of a terminal.
Syntax
reset rta connection terminal-number vty-number
Views
User view
Predefined user roles
network-admin
network-operator
Parameters
terminal-number: Specifies a terminal number in the range of 1 to 255.
vty-number: Specifies a VTY number in the range of 0 to 7.
Examples
# Tear down the TCP connection corresponding to VTY 1 of terminal 1.
<Sysname> reset rta connection 1 1
reset rta relay statistics
reset rta statistics
reset rta relay statistics
Use reset rta relay statistics to clear packet statistics for all clients connected to a relay server.
Syntax
reset rta relay statistics
Views
User view
Predefined user roles
network-admin
Examples
# Clear packet statistics for all clients on the relay server.
<Sysname> reset rta relay statistics
Related commands
reset rta connection
reset rta statistics
reset rta statistics
Use reset rta statistics to clear statistics for a terminal.
Syntax
reset rta statistics terminal-number
Views
User view
Predefined user roles
network-admin
network-operator
Parameters
terminal-number: Specifies a terminal by its number, in the range of 1 to 255.
Examples
# Clear all statistics for terminal 1.
<Sysname> reset rta statistics 1
reset rta connection
reset rta relay statistics
rta relay buffer-size
Use rta relay buffer-size to set the RTC relay forward buffer size for each RTC client.
Use undo rta relay buffer-size to restore the default.
Syntax
rta relay buffer-size buffer-size
undo rta relay buffer-size
Default
The forward buffer size for each RTC client connected to a relay server is 8 KB.
Views
System view
Predefined user roles
network-admin
Parameters
buffer-size: Specifies the forward buffer size for each RTC client, in the range of 1 to 64 KB.
Usage guidelines
If the number of packets to be sent out reaches the specified buffer size, new data will overwrite existing data, resulting in packet loss. By comparision, the TCP send buffer size (set by the rta relay tcp sendbuf-size command) will affect the transmission efficiency but will not cause packet loss.
Examples
# Set the RTC relay forward buffer size to 2 KB.
<Sysname> system-view
[Sysname] rta relay buffer-size 2
Related commands
rta relay tcp sendbuf-size
rta relay disconnect
Use rta relay disconnect to forcibly disconnect client connections from a relay server.
Syntax
rta relay disconnect { server-id client-id | all }
Views
System view
Predefined user roles
network-admin
Parameters
server-id: Specifies a forwarding group ID in the range of 0 to 63.
client-id: Specifies a client ID in the forwarding group, in the range of 0 to 9.
all: specifies all client connections.
Examples
# Disconnect all client connections from a relay server.
<Sysname> system-view
[Sysname] rta relay disconnect all
Related commands
display rta relay status
rta relay enable
Use rta relay enable to enable relay forwarding for a relay server.
Use undo rta relay enable to restore the default.
Syntax
rta relay enable
undo rta relay enable
Default
Relay forwarding is disabled for a relay server.
Views
System view
Predefined user roles
network-admin
Usage guidelines
Relay forwarding is applicable only to TCP transparent transmission between multiple RTC clients and one relay server (many-to-one mode).
Examples
# Enable RTC relay forwarding.
<Sysname> system-view
[Sysname] rta relay enable
rta relay listen-port
Use rta relay listen-port to set a TCP listening port for a relay server.
Use undo rta relay listen-port to restore the default.
Syntax
rta relay listen-port port-number
undo rta relay listen-port port-number
Default
No TCP listening ports are configured.
Views
System view
Predefined user roles
network-admin
Parameters
port-number: Specifies a TCP listening port in the range of 1024 to 50000.
Usage guidelines
A relay server can accept a maximum of 10 connections in each forwarding group.
The system supports a maximum of 64 TCP listening ports. A forwarding group contains the connections established through the same port and allows data from a terminal to be broadcast within the group.
Deleting a listening port will disconnect all the clients connected to the port.
Examples
# Set TCP listening ports to 1026 and 1027.
<Sysname> system-view
[Sysname] rta relay listen-port 1026
[Sysname] rta relay listen-port 1027
Related commands
rta relay enable
rta relay tcp
Use rta relay tcp to set the send buffer size and receive buffer size for TCP connections between the relay server and an RTC client.
Use undo rta relay tcp to restore the default send buffer size and receive buffer size.
Syntax
rta relay tcp { recvbuf-size recvbuff-size | sendbuf-size sendbuff-size }
undo rta relay tcp { recvbuf-size | sendbuf-size }
Default
The send buffer size and receive buffer size for TCP connections are both 2048 bytes.
Views
System view
Predefined user roles
network-admin
Parameters
recvbuff-size: Specifies the TCP receive buffer size in the range of 512 to 16384 bytes.
sendbuff-size: Specifies the TCP send buffer size in the range of 512 to 16384 bytes.
Usage guidelines
As a best practice, use the default settings. An improper send buffer size or receive buffer size can affect data forwarding efficiency or cause system overload.
Examples
# Set the TCP send buffer size and TCP receive buffer size on the relay server to 8194 bytes and 2046 bytes, respectively.
<Sysname> system-view
[Sysname] rta relay tcp sendbuf-size 8194
[Sysname] rta relay tcp recvbuf-size 2046
Related commands
rta relay tcp keepalive
rta relay tcp nodelay
rta relay tcp keepalive
Use rta relay tcp keepalive to configure the TCP keepalive attributes on a relay server.
Use undo rta relay tcp keepalive to restore the default.
Syntax
rta relay tcp keepalive time count
undo rta relay tcp keepalive
Default
The TCP keepalive interval is 50 seconds. The keepalive number is 3.
Views
System view
Predefined user roles
network-admin
Parameters
time: Specifies the keepalive interval in the range of 10 to 7200 seconds.
count: Specifies the keepalive number in the range of 1 to 100.
Usage guidelines
This command enables the relay server to use the TCP keepalive feature to detect the reachability of an RTC client. If the relay server receives no keepalive from an RTC client within the timeout time, it disconnects the RTC client. The timeout time is the result of multiplying the keepalive interval by the keepalive number.
Examples
# Set the keepalive interval to 100 seconds and the keepalive number to 3 for TCP connections on the relay server.
<Sysname> system-view
[Sysname] rta relay tcp keepalive 100 3
Related commands
rta relay tcp
rta relay tcp nodelay
rta relay tcp nodelay
Use rta relay tcp nodelay to enable TCP_NODELAY on a relay server.
Use undo rta relay tcp nodelay to disable TCP_NODELAY on a relay server.
Syntax
rta relay tcp nodelay
undo rta relay tcp nodelay
Default
TCP_NPDELAY is disabled on a relay server.
Views
System view
Predefined user roles
network-admin
Usage guidelines
TCP_NODELAY disables the Nagle algorithm for TCP. TCP_NODELAY removes the time delay caused by Nagle during TCP traffic transmission to improve the forwarding performance of a relay server.
Examples
# Enable TCP_NODELAY on the relay server.
<Sysname> system-view
[Sysname] rta relay tcp nodelay
Related commands
rta relay tcp
rta relay tcp keepalive
rta rtc version
Use rta rtc version to set the RTC version.
Use undo rta rtc version to restore the default.
Syntax
rta rtc version { v3 | v5 }
undo rta rtc version
Default
The router uses RTC Version 5.
Views
System view
Predefined user roles
network-admin
Parameters
v3: Uses the RTC Version 3.
v5: Uses the RTC Version 5.
Usage guidelines
The following matrix shows the command and hardware compatibility:
Hardware |
Command compatibility |
MSR810/810-W/810-W-DB/810-LM/810-W-LM/810-10-PoE/810-LM-HK/810-W-LM-HK/810-LMS/810-LUS |
No |
MSR2600-6-X1/2600-10-X1 |
No |
MSR 2630 |
Yes |
MSR3600-28/3600-51 |
Yes |
MSR3600-28-SI/3600-51-SI |
No |
MSR3610-X1/3610-X1-DP/3610-X1-DC/3610-X1-DP-DC |
Yes |
MSR 3610/3620/3620-DP/3640/3660 |
Yes |
MSR5620/5660/5680 |
Yes |
Comware 5 and Comware 7 support both RTC Version 3 and Version 5. Comware 3 supports only RTC Version 3.
For a router running Comware 5/7 to communicate with a router running Comware 3, set the RTC version to Version 3 on the router running Comware 5/7.
For routers running Comware 5/7 to communicate with each other, set the RTC version on the routers to the same version.
Examples
# Set the RTC version to Version 3.
<Sysname> system-view
[Sysname] rta rtc version v3
rta rtc-server listen-port
Use rta rtc-server listen-port to configure the listening port on an RTC server.
Use undo rta rtc-server listen-port to restore the default.
Syntax
rta rtc-server listen-port port-number
undo rta rtc-server listen-port port-number
Default
No listening port is configured on an RTC server.
Views
System view
Predefined user roles
network-admin
Parameters
port-number: Specifies the listening TCP port number in the range of 1024 to 50000.
Usage guidelines
Only one listening port can be configured on an RTC server.
Examples
# Set the RTC server listening port number to 9010.
<Sysname> system-view
[Sysname] rta rtc-server listen-port 9010
Related commands
rta server enable
rta server enable
Use rta server enable to enable terminal access on a router.
Use undo rta server enable to disable terminal access on a router.
Syntax
rta server enable
undo rta server enable
Default
Terminal access is disabled on a router.
Views
System view
Predefined user roles
network-admin
Usage guidelines
Disabling terminal access does not remove the existing settings for terminal templates, terminals, and VTYs on the router.
Examples
# Enable terminal access.
<Sysname> system-view
[Sysname] rta server enable
rta source-ip
Use rta source-ip to configure a global source IP address for TCP connections.
Use undo rta source-ip to restore the default.
Syntax
rta source-ip ip-address
undo rta source-ip
Default
No global source IP address is configured for TCP connections.
Views
System view
Predefined user roles
network-admin
Parameters
ip-address: Specifies a source IP address for TCP connections.
Usage guidelines
This command specifies a TCP source address. If no TCP source address is specified, the router uses the outbound interface's IP address as the TCP source address. Typically, the IP address of the loopback interface or dialer interface of a router is used as the TCP connection source IP address for dial-up backup and address hiding.
A source IP address configured in a terminal template has priority over the global TCP source IP address for the terminal using that template.
After a global TCP connection source IP address is configured, a TCP connection must be re-established for the address to take effect.
Examples
# Set the source IP address to 1.1.1.1 for the global TCP connection.
<Sysname> system-view
[Sysname] rta source-ip 1.1.1.1
rta template
Use rta template to create a terminal template and enter its view, or enter the view of an existing terminal template.
Use undo rta template to delete a terminal template.
Syntax
rta template template-name
undo rta template template-name
Default
No terminal templates exist.
Views
System view
Predefined user roles
network-admin
Parameters
template-name: Specifies a terminal template name, a string of 1 to 15 characters.
Examples
# Create terminal template abc and enter its view.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc]
rta terminal
Use rta terminal to apply a terminal template to an interface.
Use undo rta terminal to restore the default.
Syntax
rta terminal template-name terminal-number
undo rta terminal
Default
No terminal template is applied to an interface.
Views
Asynchronous serial interface view
Synchronous/asynchronous serial interface view
Predefined user roles
network-admin
Parameters
template-name: Specifies a template by its name, a string of 1 to 15 characters.
terminal-number: Specifies a terminal number in the range of 1 to 255.
Usage guidelines
To implement terminal access, apply a configured terminal template to an interface to create a terminal. An interface can be connected to only one physical terminal. The router identifies physical terminals by terminal number.
Examples
# Apply the terminal template abc with the terminal number of 1 to interface Async 2/2/1.
<Sysname> system-view
[Sysname] interface async 2/2/1
[Sysname-rta-async2/2/1] rta terminal abc 1
rta terminal backup
Use rta terminal backup to apply a terminal template to a backup interface.
Use undo rta terminal backup to restore the default.
syntax
rta terminal template-name terminal-number backup
undo rta terminal backup
default
No terminal template is applied to a backup interface.
Views
Interface view
Predefined user roles
network-admin
Parameters
template-name: Specify a terminal template by its name, a string of 1 to 15 characters.
terminal-number: Specifies a terminal number in the range of 1 to 255.
Usage guidelines
The primary interface takes over the traffic forwarding again when it recovers from a failure condition.
Examples
# Apply the terminal template abc with the terminal number of 1 to backup interface async 2/2/1.
<Sysname> system-view
[Sysname] interface async 2/2/1
[Sysname-rta-async2/2/1] rta terminal abc 1 backup
rtc-multipeer remote
Use rtc-multipeer remote to configure the client list on a VTY serving as a one-to-many UDP RTC server.
Use undo rtc-multipeer remote to remove the configuration.
Syntax
rtc-multipeer vty-number remote ip-address port-number
undo rtc-multipeer vty-number remote ip-address port-number
Default
No clients exist on a VTY serving as a one-to-many UDP RTC server.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY by its number, in the range of 0 to 7.
ip-address: Specifies the IP address of a client.
port-number: Specifies the UDP port of the client, in the range of 1024 to 50000.
Usage guidelines
Create a UDP_1N_Server VTY before you can configure a client list for it. You can configure a maximum of 10 clients for a VTY. For more information about configuring UDP_1N_Server VTYs, see the vty rtc-multipeer command.
Deleting a UDP_1N_Server VTY deletes the client list of the VTY.
Examples
# Configure a client list for the one-to-many UDP RTC server VTY 1. The client list includes a client with IP address 1.1.1.2 and UDP port 1024, and a client with IP address 1.1.1.3 and UDP port 1025.
<Sysname> system-view
[Sysname] rta template temp3
[Sysname-rta-template-temp3] vty 1 rtc-multipeer 1.1.1.1 1024
[Sysname-rta-template-temp3] rtc-multipeer 1 remote 1.1.1.2 1024
[Sysname-rta-template-temp3] rtc-multipeer 1 remote 1.1.1.3 1025
Related commands
vty rtc-multipeer
sendbuf bufsize
Use sendbuf bufsize to configure the maximum size of data to be sent to a terminal at one time.
Use undo sendbuf bufsize to restore the default.
Syntax
sendbuf bufsize size
undo sendbuf bufsize
Default
The maximum size of data to be sent to a terminal at one time is 500 bytes.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
size: Specifies the maximum size of data sent to a terminal at one time, in the range of 2 to 500 bytes.
Usage guidelines
The router sends data in packets to a terminal. The size of the packet might be different each time it is sent.
Examples
# Configure the maximum size to 200 bytes for data to be sent at one time.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] sendbuf bufsize 200
Related commands
sendbuf threshold
sendbuf threshold
Use sendbuf threshold to set the threshold of the terminal send buffer.
Use undo sendbuf threshold to restore the default.
Syntax
sendbuf threshold value
undo sendbuf threshold
Default
No threshold is set for the terminal send buffer.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
value: Specifies the threshold of the terminal send buffer, in the range of 50 to 2048 bytes.
Usage guidelines
The router uses the terminal send buffer to store the data to be sent to the terminal. The threshold specifies the maximum data in bytes that the send buffer can store.
Examples
# Set the terminal send buffer threshold to 1000 bytes.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] sendbuf threshold 1000
Related commands
sendbuf bufsize
tcp
Use tcp to configure a TCP parameter.
Use undo tcp to remove the configuration of a TCP parameter.
Syntax
tcp { keepalive time count | nodelay | recvbuf-size recvsize | sendbuf-size sendsize }
undo tcp { keepalive | nodelay | recvbuf-size | sendbuf-size }
Default
The keepalive interval is 50 seconds, and the keepalive number is 3.
Delay is enabled.
The receive buffer size is 2048 bytes.
The send buffer size is 2048 bytes.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
keepalive time count: Specifies the keepalive interval and the keepalive number. The keepalive interval is in the range of 10 to 7200 seconds. The keepalive number is in the range of 1 to 100.
nodelay: Disables the TCP Nagle algorithm, and enables TCP no delay.
recvbuf-size recvsize: Specifies the TCP receive buffer size in the range of 512 to 16384 bytes.
sendbuf-size sendsize: Specifies the TCP send buffer size in the range of 512 to 16384 bytes.
Usage guidelines
This command takes effect only after a TCP connection is re-established.
Examples
# Set the TCP receive buffer size to 512 bytes.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] tcp recvbuf-size 512
# Set the TCP send buffer size to 512 bytes.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] tcp sendbuf-size 512
# Disable TCP delay.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] tcp nodelay
# Set the TCP keepalive interval to 1800 seconds and the keepalive number to 2.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] tcp keepalive 1800 2
update changed-config
Use update changed-config to update the most recent template configurations immediately.
Syntax
update changed-config
Default
The configuration changes to a terminal template do not take effect immediately.
Views
Terminal template view
Predefined user roles
network-admin
Usage guidelines
If you modify a terminal template that has been applied to an interface, use this command to apply the most recent configurations.
Executing this command disconnects current connections and re-establishes connections. Make sure critical services will not be affected.
Some configurations (such as source IP address configuration) take effect only after they are updated and the connection is re-established.
Examples
# Set the automatic link teardown time under the template and update the configuration.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] auto-close 10
[Sysname-rta-template-abc] update changed-config
vty description
Use vty description to configure a description for a VTY.
Use undo vty description to restore the default.
Syntax
vty vty-number description string
undo vty vty-number description
Default
No description is configured for a VTY.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY by its number, in the range of 0 to 7.
string: Specifies a description, a case-sensitive string of 1 to 31 characters.
Usage guidelines
When a VTY is used for a service, you can use the service name as the description of the VTY.
Examples
# Set the description to chuxu for VTY 1.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] vty 1 description chuxu
vty hotkey
Use vty hotkey to set the hotkey for VTY fast switching.
Use undo vty hotkey to restore the default.
Syntax
vty vty-number hotkey ascii-code&<1-3>
undo vty vty-number hotkey
Default
No hotkey is set for VTY fast switching.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY by its number, in the range of 0 to 7.
ascii-code&<1-3>: Specifies the ASCII value of the hotkey, in the range of 1 to 255. The &<1-3> means that you can enter a maximum of three ASCII values.
Usage guidelines
Fast VTY switching allows you to switch between applications. In RTC terminal access, each terminal can be logically divided into eight VTYs and each VTY corresponds to one application. When multiple VTYs are configured for a terminal with the corresponding switching hotkeys, you can press the switching hotkeys to quickly switch between the VTYs. The connection of the original VTY application is not torn down. This way, dynamic switching between the VTYs (that is, different applications) on a terminal is implemented.
The ASCII value of the hotkey must be different from any other hotkey configured on the device. Otherwise, hotkey conflicts occur. For example, the hotkey value cannot be 17 or 19 because these values are used for flow control. Using a hotkey might not get a fast response when the terminal display is busy.
Examples
# Set the hotkey to Ctrl+A for VTY 1 by setting its ASCII value to 1.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] vty 1 hotkey 1
vty password
Use vty password to configure the password for VTY authentication.
Use undo vty password to restore the default.
Syntax
vty vty-number password { simple | cipher } string
undo vty vty-number password
Default
No password is configured for VTY authentication.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY by its number, in the range of 0 to 7.
simple: Specifies a password in plaintext form. For security purposes, the password specified in plaintext form will be stored in encrypted form.
cipher: Specifies a password in encrypted form.
string: Specifies the password. Its plaintext form is a case-sensitive string of 1 to 63 characters. Its encrypted form is a case-sensitive string of 1 to 117 characters.
Usage guidelines
To support terminal access authentication, passwords must be configured on the RTC server and the RTC clients. Authentication succeeds only if the passwords are the same. If no authentication is needed, do not set a password on the RTC server or RTC clients.
Examples
# Set the authentication password to plaintext password abc for VTY 1.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] vty 1 password simple abc
Related commands
vty rtc-client remote
vty rtc-server remote
vty rtc-client remote
Use vty rtc-client remote to create a VTY to act as a TCP RTC client.
Use undo vty to remove the configuration.
Syntax
vty vty-number rtc-client remote ip-address port-number [ source source-ip ]
undo vty vty-number
Default
No TCP RTC client VTYs exist.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY number in the range of 0 to 7.
ip-address: Specifies the IP address of the RTC server.
port-number: Specifies the listening port number of the RTC server, in the range of 1024 to 50000.
source source-ip: Specifies the TCP source IP address.
Usage guidelines
After this configuration, no VTY of another type can be configured in the template.
Examples
# Create VTY 1 to act as a TCP RTC client. Set the IP address of the RTC server to 1.1.1.1, listening port of the RTC server to 9010, and the source IP address to be used for establishing TCP connections to 2.2.2.2.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] vty 1 rtc-client remote 1.1.1.1 9010 source 2.2.2.2
rta rtc-server listen-port
vty rtc-server remote
vty rtc-client remote remote-port
Use vty rtc-client remote remote-port to create a VTY to act as a UDP RTC client.
Use undo vty to remove the configuration.
Syntax
vty vty-number rtc-client remote ip-address remote-port remote-port-number udp [ local-port local-port-number ] [ source source-ip-address ]
undo vty vty-number
Default
No UDP RTC client VTYs exist.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY number in the range of 0 to 7.
ip-address: Specifies the RTC server IP address.
remote-port-number: Specifies the UDP port number of the RTC server, in the range of 1024 to 50000.
source-ip-address: Specifies the local IP address.
local-port-number: Specifies the local UDP listening port, in the range of 1024 to 50000.
Usage guidelines
After this configuration, no VTY of another type can be configured in the template.
Examples
# Create VTY 1 to act as a UDP RTC client. Set the RTC server IP address to 1.1.1.1, RTC server UDP port to 1024, local address to 1.1.1.2, and the local UDP listening port to 1025.
<Sysname> system-view
[Sysname] rta template temp2
[Sysname-rta-template-temp2] vty 1 rtc-client remote 1.1.1.1 remote-port 1024 udp local-port 1025 source 1.1.1.2
Related commands
rta rtc-server remote-udp
vty rtc-multipeer
Use vty rtc-multipeer to create a VTY to act as a one-to-many UDP RTC server.
Use undo vty to remove the configuration.
Syntax
vty vty-number rtc-multipeer [ ip-address ] port-number
undo vty vty-number
Default
No one-to-many UDP RTC server VTYs exist.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY number in the range of 0 to 7.
ip-address: Specifies the local IP address.
port-number: Specifies the local UDP port in the range of 1024 to 50000.
Usage guidelines
Deleting a VTY that acts as a one-to-many UDP RTC server deletes the client list of the VTY.
Examples
# Create VTY 1 to act as a one-to-many UDP RTC server. Set the local UDP listening port to 1024 and the local IP address to 1.1.1.1.
<Sysname> system-view
[Sysname] rta template temp3
[Sysname-rta-template-temp3] vty 1 rtc-multipeer 1.1.1.1 1024
Related commands
vty rtc-client remote remote-port
rtc-multipeer remote
vty rtc-server remote
Use vty rtc-server remote to create a VTY to act as a TCP RTC server.
Use undo vty to remove the configuration.
Syntax
vty vty-number rtc-server remote ip-address terminal-number
undo vty vty-number
Default
No TCP RTC server VTYs exist.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY number in the range of 0 to 7.
ip-address: Specifies the RTC client IP address.
terminal-number: Specifies the terminal number corresponding to the RTC client, in the range of 1 to 255.
Usage guidelines
After this configuration, no VTY of another type can be configured in the template.
Examples
# Create a VTY to act as a TCP RTC server. Set the IP address of the RTC client to 2.2.2.2 and the terminal number to 1.
<Sysname> system-view
[Sysname] rta template abc
[Sysname-rta-template-abc] vty 1 rtc-server remote 2.2.2.2 1
Related commands
vty rtc-client remote
vty rtc-server remote udp
Use vty rtc-server remote udp to create a VTY to act as a UDP RTC server.
Use undo vty to remove the specified VTY.
Syntax
vty vty-number rtc-server remote [ ip-address remote-port remote-port-number ] udp local-port local-port-number [ source source-ip-address ]
undo vty vty-number
Default
No UDP RTC server VTYs exist.
Views
Terminal template view
Predefined user roles
network-admin
Parameters
vty-number: Specifies a VTY number in the range of 0 to 7.
ip-address: Specifies the IP address of the RTC client.
remote-port-number: Specifies the UDP port of the RTC client, in the range of 1024 to 50000.
source-ip-address: Specifies the local IP address.
local-port-number: Specifies the local UDP listening port, in the range of 1024 to 50000.
Usage guidelines
After this configuration, no VTY of another type can be configured in the template.
Examples
# Create VTY 1 to act as a UDP RTC server. Set the local IP address to 1.1.1.1, local UDP listening port to 1024, RTC client IP address to 1.1.1.2, and the RTC client UDP port to 1025.
<Sysname> system-view
[Sysname] rta template temp1
[Sysname-rta-template-temp1] vty 1 rtc-server remote 1.1.1.2 remote-port 1025 udp local-port 1024 source 1.1.1.1
Related commands
vty rtc-client remote remote-port
auto-close,50
auto-connect enable,1
auto-link,51
backup app,2
bind vpn-instance,51
caller-number enable,3
description,3
display fcm statistics,4
display posa connection terminal,5
display posa statistics app,6
display posa statistics caller-id,7
display posa statistics caller-ip,8
display posa statistics nii,9
display posa statistics terminal,10
display posa status app,11
display posa status terminal,12
display rta,52
display rta relay statistics,56
display rta relay status,57
driverbuf save,57
driverbuf size,58
hello enable,13
idle-timeout,59
ip,14
link-protocol stlp,59
mode,15
negotiation hookoff,16
negotiation no-carrier-detect retry,17
negotiation scramble-binary1,17
negotiation silence,18
negotiation unscramble-binary1,18
posa app,19
posa auto-stop-service enable,20
posa bind app,21
posa bind terminal,22
posa bind terminal first-terminal-id,23
posa calling-prefix,24
posa connection-threshold terminal,25
posa e1-dial-falling-threshold,26
posa fcm,26
posa map,27
posa server enable,28
posa statistics caller-id,29
posa statistics caller-ip,30
posa terminal,31
posa terminal description,32
posa terminal ssl-server-policy,33
posa tpdu-replace,33
posa trade-falling-threshold,34
posa trade-limit tcp,35
posa trade-timeout,36
reset fcm statistics,36
reset posa connection terminal,37
reset posa statistics,38
reset rta connection,60
reset rta relay statistics,61
reset rta statistics,61
resetkey,60
rta relay buffer-size,62
rta relay disconnect,62
rta relay enable,63
rta relay listen-port,63
rta relay tcp,64
rta relay tcp keepalive,65
rta relay tcp nodelay,66
rta rtc version,66
rta rtc-server listen-port,67
rta server enable,68
rta source-ip,68
rta template,69
rta terminal,70
rta terminal backup,70
rtc-multipeer remote,71
sendbuf bufsize,72
sendbuf threshold,72
snmp-agent trap enable posa,38
source ip,40
source port,40
tcp,73
tcp keepalive,41
tcp linking-time,42
terminal-ip append,42
threshold answer-tone,43
threshold rlsdoff,44
threshold rlsdon,44
threshold txpower,45
timer auto-connect,45
timer hello,46
timer quiet,47
tpdu-change,47
trade-exchanges,48
update changed-config,74
vty description,75
vty hotkey,75
vty password,76
vty rtc-client remote,77
vty rtc-client remote remote-port,78
vty rtc-multipeer,78
vty rtc-server remote,79
vty rtc-server remote udp,80