Login
- Table of Contents
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 01-RTC terminal access commands | 168.70 KB |
RTC terminal access commands
The following compatibility matrixes show the support of hardware platforms for RTC terminal access:
|
Hardware |
RTC terminal access compatibility |
|
MSR810, MSR810-W, MSR810-W-DB, MSR810-LM, MSR810-W-LM, MSR810-10-PoE, MSR810-LM-HK, MSR810-W-LM-HK, MSR810-LM-CNDE-SJK, MSR810-CNDE-SJK |
No |
|
MSR810-LMS, MSR810-LUS |
No |
|
MSR810-LMS-EA, MSR810-LME |
No |
|
MSR2600-6-X1, MSR2600-10-X1 |
No |
|
MSR 2630 |
Yes |
|
MSR3600-28, MSR3600-51 |
Yes |
|
MSR3600-28-SI, MSR3600-51-SI |
No |
|
MSR3600-28-X1, MSR3600-28-X1-DP, MSR3600-51-X1, MSR3600-51-X1-DP |
Yes |
|
MSR3610-I-DP, MSR3610-IE-DP, MSR3610-IE-ES, MSR3610-IE-EAD, MSR3610-I-IG, MSR3610-IE-IG |
No |
|
MSR3610-X1, MSR3610-X1-DP, MSR3610-X1-DC, MSR3610-X1-DP-DC |
Yes |
|
MSR 3610, MSR 3620, MSR 3620-DP, MSR 3640, MSR 3660 |
Yes |
|
MSR3610-G, MSR3620-G |
Yes |
|
Hardware |
RTC terminal access compatibility |
|
MSR810-W-WiNet, MSR810-LM-WiNet |
No |
|
MSR830-4LM-WiNet |
No |
|
MSR830-5BEI-WiNet, MSR830-6EI-WiNet, MSR830-10BEI-WiNet |
No |
|
MSR830-6BHI-WiNet, MSR830-10BHI-WiNet |
No |
|
MSR2600-6-WiNet, MSR2600-10-X1-WiNet |
No |
|
MSR2630-WiNet |
Yes |
|
MSR3600-28-WiNet |
Yes |
|
MSR3610-X1-WiNet |
Yes |
|
MSR3610-WiNet, MSR3620-10-WiNet, MSR3620-DP-WiNet, MSR3620-WiNet, MSR3660-WiNet |
Yes |
|
Hardware |
RTC terminal access compatibility |
|
MSR2630-XS |
No |
|
MSR3600-28-XS |
Yes |
|
MSR3610-XS |
Yes |
|
MSR3620-XS |
Yes |
|
MSR3610-I-XS |
No |
|
MSR3610-IE-XS |
No |
|
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 VPN instances. 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 VPN instances.
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 VPN instance vpn1 to 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 1 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 2 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 3 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 4 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 5 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 6 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 7 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
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 synchronous serial interface Serial 2/1/0.
<Sysname> system-view
[Sysname] interface serial 2/1/0
[Sysname-Serial2/1/0] link-protocol stlp
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
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
Related commands
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
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
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
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-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 terminal template abc with the terminal number of 1 to 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 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 a client on a VTY serving as a one-to-many UDP RTC server.
Use undo rtc-multipeer remote to delete a client from a VTY serving as a one-to-many UDP RTC server.
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 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 one-to-many UDP RTC server VTY 1. The client list includes a client with an IP address of 1.1.1.2 and a UDP port number of 1024, and a client with an IP address of 1.1.1.3 and a UDP port number of 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
# Configure the description as 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 delete a VTY.
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 delete a VTY.
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 delete a VTY.
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 delete a VTY.
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 delete a 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
