Terminal Services Commands on the Cisco IOS XR Software

This chapter describes the
Cisco IOS XR commands used for setting up physical and virtual terminal connections, managing terminals, and configuring virtual terminal line (vty) pools.

For detailed information about configuring physical and virtual terminals, see the Implementing Physical and Virtual Terminals on
Cisco IOS XR Software module in Cisco IOS XR System Management Configuration
Guide for the Cisco XR 12000 Series Router.

absolute-timeout

To set the absolute
timeout for line disconnection, use the
absolute-timeout command in line template
configuration mode. To remove the
absolute-timeout command from the configuration
file and restore the system to its default condition, use the
no form of
this command.

absolute-timeoutminutes

noabsolute-timeoutminutes

Syntax Description

minutes

Absolute
timeout interval, in minutes. Range is from 10 to 10000.

Command Default

minutes: 1440

Command Modes

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Release 5.0.0

This command was introduced.

Usage Guidelines

Use the
absolute-timeout command to terminate the
connection after the specified time has elapsed, regardless of whether the
connection is being used at the time of termination. You can specify an
absolute-timeout value for each port. The user is notified 20 seconds before
the session is terminated.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the session timeout value to 2880 minutes (2 days) for
the default line template:

access-class

To restrict incoming
and outgoing connections using an IPv4 or IPv6 access list, use the
access-class command in line template
configuration mode. To remove the restriction, use the
no form of
this command.

access-classlist-name
{ in | out }

noaccessclasslist-name
{ in | out }

Syntax Description

list-name

IPv4 or IPv6
access list name.

in

Filters
incoming connections.

out

Filters
outgoing connections.

Command Default

No access class is
set.

Command Modes

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
access-class
command to restrict incoming or outgoing connections to addresses defined in an
access list. Use the
ipv4access-list or
ipv6access-list command to define an access list by
name.

Note

To restrict
access of incoming or outgoing connections over IPv4 and IPv6, the IPv4 access
list and IPv6 access list must share the same name.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to specify an access class assigned to outgoing connections
for the default line template:

RP/0/0/CPU0:router(config)# line defaultRP/0/0/CPU0:router(config-line)# access-class vtyacl out

The following
sample output from the
showipv4access-lists command displays the IPv4 access list named vtyacl:

Related Commands

Command

Description

ipv4 access-list

Defines
an IPv4 access list by name.

ipv6 access-list

Defines
an IPv6 access list by name.

autocommand

To automatically run
one or more commands after a user logs in to a vty terminal session, use the
autocommand
command in line default or line template configuration mode. To remove the
autocommand
command from the configuration file and restore the system to its default
condition, use the
no form of
this command.

autocommandcommand

noautocommandcommand

Syntax Description

command

Command or
command alias to be executed on user login to a vty session.

Command Default

No default behavior
or values

Command Modes

Line template configuration

Line default configuration

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Usage Guidelines

Use the
autocommand
command to automatically run a command or command alias when a user logs in to
a vty session. To run multiple commands, use a command alias for the
command argument. When the user logs in, the commands included in the
alias are run sequentially.

Note

The
autocommand
command is supported on vty connections only; it is not supported on console or
aux line connections. Use this command to automatically run a command after
user login.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to use the
autocommand
command to automatically run the
showipinterfacebrief command when a user logs in to a default vty
session:

The following example
shows how the
show ip
interface brief command is automatically run when the user logs on to a vty
session:

User Access Verification
Username: lab
Password:
Executing Autocommand 'show ip interface brief'
RP/0/0/CPU0:router# show ip interface brief
Interface IP-Address Status Protocol
MgmtEth0/RP0/CPU0/0 172.16.0.0 Up Up
POS0/0/0/0 unassigned Up Up
POS0/0/0/1 unassigned Up Up
POS0/0/0/2 unassigned Up Up
POS0/0/0/3 unassigned Up Up
POS0/3/0/0 unassigned Up Up
POS0/3/0/1 unassigned Up Up
POS0/3/0/2 unassigned Up Up
POS0/3/0/3 unassigned Up Up

The following
example shows how to disable the feature using the
no form of
the
autocommand
command. In this example, the autocommand for the
showipinterfacebrief command is disabled. When the user logs out,
and logs back in, the
autocommand
command does not run.

The following example
shows how to use a command alias with the
autocommand
command to run more than one command when a user logs in to a default vty
session. In this example, the alias “test” is created to include the
showipinterfacebrief command and the
showusers command. The autocommand feature is then used to run the
“test” alias when a user logs in to the vty terminal:

banner exec

To create a message
that is displayed when an EXEC process is created (an EXEC banner), use the
bannerexec command in

global configuration

mode. To delete the EXEC banner, use the
no form of
this command.

bannerexecdelimitermessagedelimiter

nobannerexec

Syntax Description

delimiter

Delimiting
character is (c).

message

Message
text. Text may include tokens in the form $(token) in the message text. Tokens are replaced with the
corresponding configuration variable. Tokens are described in
Table 1.

Command Default

No EXEC banner is
displayed.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
bannerexec command to specify a message that is
displayed when an EXEC process is created (a line is activated or an incoming
connection is made to a vty). Follow this command with one or more blank spaces
and the delimiting character (c). After entering one or more lines of text,
terminate the message with the delimiting character (c).

When a user
connects to a router, the message-of-the-day (MOTD) banner appears first,
followed by the login banner and prompts. After the user logs in to the router,
the EXEC banner or incoming banner is displayed, depending on the type of
connection. For a reverse Telnet login, the incoming banner is displayed. For
all other connections, the router displays the EXEC banner.

Use tokens in the
form $(token) in the message text to customize the banner. Tokens display
current configuration variables, such as the router hostname and IP address.

The tokens are
described in this table.

Table 1 banner exec
Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays
the hostname for the router.

$(domain)

Displays
the domain name for the router.

$(line)

Displays
the vty or tty (asynchronous) line number.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set an EXEC banner that uses tokens:

RP/0/0/CPU0:router(config)# banner exec c
Enter TEXT message. End with the character 'c'.
THIS IS AN EXEC BANNERc

Defines
a customized banner that is displayed when there is a login timeout.

banner
incoming

To create a banner
that is displayed when there is an incoming connection to a terminal line from
a host on the network, use the
bannerincoming command in

global configuration

mode. To delete the incoming connection banner, use the
no form of
this command.

bannerincomingdelimitermessagedelimiter

nobannerincoming

Syntax Description

delimiter

Delimiting
character is (c).

message

Message
text. You can include tokens in the form $(token) in the message text. Tokens are replaced with the
corresponding configuration variable. Tokens are described in
Table 1.

Command Default

No incoming banner
is displayed.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Follow the
bannerincoming command with one or more blank spaces and
the delimiting character (c). After entering one or more lines of text,
terminate the message with the second occurrence of the delimiting character
(c).

An
incoming
connection is one initiated from the network side of the router.
Incoming connections are also called reverse Telnet sessions. These sessions
can display message-of-the-day (MOTD) banners and incoming banners, but they do
not display EXEC banners.

When a user
connects to a router, the MOTD banner (if configured) appears first, followed
by the login banner and prompts. After the user logs in to the router, the EXEC
banner or incoming banner is displayed, depending on the type of connection.
For a reverse Telnet login, the incoming banner is displayed. For all other
connections, the router displays the EXEC banner.

Incoming banners
cannot be suppressed. If you do not want the incoming banner to appear, you
must delete it with the
nobannerincoming command.

To customize the
banner, use tokens in the form $(token) in the message text. Tokens display current
variables, such as the router hostname and IP address.

This table
describes the tokens.

Table 2 banner
incoming Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays
the hostname for the router.

$(domain)

Displays
the domain name for the router.

$(line)

Displays
the vty or tty (asynchronous) line number.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to create an incoming connection banner:

RP/0/0/CPU0:router(config)# banner incoming c
Enter TEXT message. End with the character ‘c’
THIS IS AN INCOMING BANNER. c

Defines
a customized banner that is displayed when there is a login timeout.

banner login

To create a
customized banner that is displayed before the username and password login
prompts, use the
bannerlogin command in

global configuration

mode. To disable the login banner, use
no form of
this command.

bannerlogindelimitermessagedelimiter

nobannerlogin

Syntax Description

delimiter

Delimiting
character is (c).

message

Message
text. You can include tokens in the form $(token) in the message text. Tokens are replaced with the
corresponding configuration variable. Tokens are described in
Table 1.

Command Default

No login banner is
displayed.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Follow the
bannerlogin command with one or more blank spaces and
the delimiting character (c). Then enter one or more lines of text, terminating
the message with the second occurrence of the delimiting character (c).

When a user
connects to the router, the message-of-the-day (MOTD) banner (if configured)
appears first, followed by the login banner and prompts. After the user
successfully logs in to the router, the EXEC banner or incoming banner is
displayed, depending on the type of connection. For a reverse Telnet login, the
incoming banner is displayed. For all other connections, the router displays
the EXEC banner.

To customize the
banner, use tokens in the form $(token) in the message text. Tokens display current configuration
variables, such as the router hostname and IP address.

Tokens are
described in the this table.

Table 3 banner login
Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays
the hostname for the router.

$(domain)

Displays
the domain name for the router.

$(line)

Displays
the vty or tty (asynchronous) line number.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set a login banner:

RP/0/0/CPU0:router(config)# banner login c
Enter TEXT message. End with the character 'c'.
THIS IS A LOGIN BANNERc

Defines
a customized banner that is displayed when there is a login timeout.

banner motd

To create a
message-of-the-day (MOTD) banner, use the
bannermotd command in

global configuration

mode. To delete the MOTD banner, use the
no form of
this command.

bannermotddelimitermessagedelimiter

nobannermotd

Syntax Description

delimiter

Delimiting
character is (c).

message

Message
text. You can include tokens in the form $(token) in the message text. Tokens are replaced with the
corresponding configuration variable.

Command Default

No MOTD banner is
displayed.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Follow this
command with one or more blank spaces and the delimiting character (c). Then
enter one or more lines of text, terminating the message with the second
occurrence of the delimiting character (c).

This MOTD banner
is displayed to all terminals connected and is useful for sending messages that
affect all users (such as impending system shutdowns). Use the
nobannermotd command to disable the MOTD banner on a line.

When a user
connects to the router, the MOTD banner (if configured) appears first, followed
by the login banner and prompts. After the user successfully logs in to the
router, the EXEC banner or incoming banner is displayed, depending on the type
of connection. For a reverse Telnet login, the incoming banner is displayed.
For all other connections, the router displays the EXEC banner.

To customize the
banner, use tokens in the form $(token) in the message text. Tokens display
current configuration variables, such as the router hostname and IP address.

Tokens are
described in this table.

Table 4 banner motd
Tokens

Token

Information Displayed in the Banner

$(hostname)

Displays
the hostname for the router.

$(domain)

Displays
the domain name for the router.

$(line)

Displays
the vty or tty (asynchronous) line number.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to configure an MOTD banner with a token:

RP/0/0/CPU0:router(config)# banner motd c
Enter TEXT message. End with the character 'c'.
Notice: all routers in $(domain) will be upgraded beginning April 20 c

Defines
a customized banner that is displayed when there is a login timeout.

banner
prompt-timeout

To create a banner
that is displayed when there is a login authentication timeout, use the
bannerprompt-timeout command in

global configuration

mode. To delete the prompt timeout banner, use the
no form of
this command.

bannerprompt-timeoutdelimitermessagedelimiter

nobannerprompt-timeout

Syntax Description

delimiter

Delimiting
character is (c).

message

Message
text. You can include tokens in the form $(token) in the message
text. Tokens are replaced with the corresponding configuration variable.

Command Default

No banner is
displayed when there is a login authentication timeout.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Follow this
command with one or more blank spaces and the delimiting character (c). Then
enter one or more lines of text, terminating the message with the second
occurrence of the delimiting character (c).

This
prompt-timeout banner is displayed when there is a login authentication timeout
at the username and password prompt.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to configure a prompt-timeout banner:

RP/0/0/CPU0:router(config)# banner prompt-timeout c
Enter TEXT message. End with the character 'c'.
THIS IS A PROMPT TIMEOUT BANNERc

Related Commands

clear line
vty

To clear a virtual
terminal line (vty) to an idle state, use the
clearlinevty command in

EXEC

mode.

clearlinevtyline-number

Syntax Description

line-number

Line number
in the range from 0 to 99.

Command Default

No default behavior
or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
showusers command to determine the origin of the connection and which
lines to clear. When a line is cleared to an idle state, the user on the other
end of the connection receives notice that the connection was closed by a
foreign host.

Related Commands

cli whitespace
completion

To enable completion
of a command when you type the space key, use the
cliwhitespacecompletion command in the appropriate line
configuration mode. To disable whitespace completion, use the
no form of
this command.

cliwhitespacecompletion

nocliwhitespacecompletion

Syntax Description

This command has no keywords or arguments.

Command Default

Whitespace
completion is disabled.

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.3.0

This command
was introduced.

Usage Guidelines

Use the
cliwhitespacecompletion command to complete the next word of
the command syntax if you type the space key before completing the word. If
more than one option is valid, all options are displayed for you to choose one.

Related Commands

databits

To set the data bits
per character for physical terminal connections, use the
databits
command in line console configuration mode. To restore the default value, use
the
no form of
this command.

databits
{ 5 | 6 | 7 | 8 }

nodatabits

Syntax Description

5

Sets the
data bits per character to 5.

6

Sets the
data bits per character to 6.

7

Sets the
data bits per character to 7.

8

Sets the
data bits per character to 8.

Command Default

Eight databits per
character.

Command Modes

Line console configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
databits
command to set the data bits attributes for physical terminal connections.
Physical terminal connections use either the console or auxiliary line
template.

The
databits
command masks the high bit on input from devices that generate 7 data bits with
parity. If parity is being generated, specify 7 data bits per character. If no
parity generation is in effect, specify 8 data bits per character. The keywords
5 and
6 are
supplied for compatibility with older devices and generally are not used.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the data bits per character for the console terminal
template to 7:

Examples

disconnect-character

To define a
character to disconnect a session, use the
disconnect-character command in line template
configuration mode. To remove the
disconnect-character command from the
configuration file and restore the system to its default condition, use the
no form of
this command.

disconnect-character
[ number | character ]

nodisconnect-character

Syntax Description

number

(Optional)
ASCII decimal equivalent of the disconnect character. Range is from 0 through
255.

character

(Optional)
Disconnect character.

Command Default

No disconnect
character is defined.

Command Modes

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

The break
character is represented by 0; null cannot be represented.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the disconnect character for the default line template
to the Esc character, which is the ASCII decimal equivalent 27:

Related Commands

escape-character

To define a
character to escape a session, use the
escape-character command in line template
configuration mode. To remove the
escape-character command from the configuration
file and restore the system to its default condition, use the
no form of
this command.

escape-character
{ break | number | character | default | none }

noescape-character

Syntax Description

break

Sets the
escape character to the Break key.

number

ASCII
decimal equivalent of the escape character. Range is from 0 through 255.

character

Escape
character.

default

Specifies
the default escape character (^^X).

none

Disables the
escape function.

Command Default

The default escape
character is ^^X.

Command Modes

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
escape-character command to define an escape
character sequence that is different from the default. Use the escape character
to exit from an existing connection and return to the EXEC prompt.

The default escape
key sequence is Ctrl-Shift-6, X (^^X).The
escape-character command with the
default
keyword sets the escape character to the Break key (the default setting for the
Break key is Ctrl-C).

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the escape character for the default line template to
Ctrl-P, which is the ASCII decimal character 16:

Related Commands

exec-timeout

To set the interval
that the EXEC command interpreter waits until user input is detected, use the
exec-timeout command in the appropriate line
configuration mode. To remove the
exec-timeout
command from the running configuration and restore the system to its default
condition, use the
no form of
this command.

exec-timeoutminutesseconds

noexec-timeoutminutesseconds

Syntax Description

minutes

Minutes for
the wait interval. Range is from 0 to 35791.

seconds

Seconds for
the wait interval. Range is from 0 to 2147483.

Command Default

minutes: 10

seconds: 0

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

If no input is
detected during the interval, the EXEC facility resumes the current connection.
If no connections exist, the EXEC facility returns the terminal to the idle
state and disconnects the incoming session. To disable the EXEC timeout
function so that the EXEC session never timeouts, enter the following command:

exec-timeout 00

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the timeout interval for the console line template to
60 minutes, 0 seconds:

Related Commands

flowcontrol
hardware

To configure the
hardware flow control setting for physical terminal connections, use the
flowcontrolhardware command in line console configuration
mode. To remove the attribute from the configuration file and restore the
system to its default condition, use the
no form of
this command.

flowcontrolhardware
{ in | out | none }

noflowcontrolhardware
{ in | out | none }

Syntax Description

in

Specifies
inbound flow control.

out

Specifies
outbound flow control.

none

Specifies no
flow control.

Command Default

None

Command Modes

Line console configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
flowcontrolhardware command to set the flow control attribute
for physical line connections. Physical line connections use either the console
or auxiliary line template.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to restrict the hardware flow control to inbound for the
console line template:

Related Commands

length

To set the number of
lines that display at one time on the screen, use the
length command
in line template configuration mode. To remove the
length command
from the configuration file and restore the system to its default condition,
use the
no form of
this command.

lengthlines

nolengthlines

Syntax Description

lines

Number of
lines that displays on a screen. Range is from 0 through 512. 0 specifies no
pausing. The default is 24.

Command Default

lines: 24

Command Modes

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
length
command to modify the default length setting for the specified line template.
The length setting determines when the screen pauses during the display of
multiple-screen output. Specifying a value of 0 for the lines argument prevents
the router from pausing between screens of output.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the length of the default line template to 33 lines:

Related Commands

Sets the
length of the display terminal for the current terminal session.

line

To specify the
console, the default, or a user-defined line template and enter line template
configuration mode, use the
line command in

global configuration

mode.

line
{ console | default | templatetemplate-name }

Syntax Description

console

Specifies
the line template for the console line.

default

Specifies
the default line template.

templatetemplate-name

Specifies a
user-defined line template to be applied to a vty pool.

Command Default

None

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Release 3.3.0

The
aux keyword was not supported.

Usage Guidelines

Use the
line command
to specify a line template type and enter into line template configuration
mode. Line templates are a collection of attributes used to configure and
manage physical terminal line connections (the console and auxiliary ports) and
vty connections. The following templates are available in
Cisco IOS XR software:

Default line template—The
default line template that applies to a physical and virtual terminal lines.

Console line template—The
line template that applies to the console line.

User-defined line
templates—User-defined line templates that can be applied to a range of virtual
terminal lines.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to enter line template configuration mode to allow
configuration changes to be made to the default line template:

RP/0/0/CPU0:router(config)# line defaultRP/0/0/CPU0:router(config-line)#

Related Commands

resume

To switch to another
active Secure Shell (SSH) or Telnet session, use the
resume command
in

EXEC

mode.

resume [connection]

Syntax Description

connection

(Optional)
Name or number of the active network connection; the default is the most recent
connection. Number range is from 1 to 20.

Command Default

The most recent
connection.

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

SSH and Telnet
sessions can be established to another router or server.

When the network
session is being established and without disconnecting the network session, you
can resume the router console session by typing a special sequence of
characters as shown. After switching back to the router console, the network
connection can be resumed by specifying the number of the connection or the
name of the connection.

You can have
several concurrent sessions open and switch back and forth between them. The
number of sessions that can be open is defined using the
session-limit command.

You can switch
between sessions by escaping one session and resuming a previously opened
session, as follows:

Escape from
the current session by pressing the escape sequence (Ctrl Shift-6, x [^^X]) to
return to the EXEC prompt.

Enter the
showsessions command to list the open sessions. All
open sessions associated with the current terminal line are displayed.

Enter the
resume
command and the session number to make the connection.
You can also
resume the previous session by pressing the
Return key.
The
^^X
and commands are available for all supported
connection protocols.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to escape from one connection and resume another. You can
omit the connection name and simply enter the connection number to resume that
connection.

send

To send messages to
one or all terminal lines, use the
send command in

EXEC

mode.

send
{ * | line-number | aux0 | console0 | vtynumber }

Syntax Description

*

Sends a
message to all tty lines.

line-number

Line number
to which the message is sent. A number from 0 to 101.

aux0

Sends a
message to the auxiliary line.

console 0

Sends a
message to the console line.

vtynumber

Sends a
message to a virtual terminal line (vty). Range is 0 to 99.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

The system prompts
for the message, which can be up to 500 characters long. Enter
Ctrl-Z to end the message. Enter
Ctrl-C to abort this command.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to send a message to all lines:

RP/0/0/CPU0:router# send *
Enter message, end with CTRL/Z; abort with CTRL/C:
The system will be shut down in 10 minutes for repairs.^Z
Send message? [confirm]
RP/0/0/CPU0:router#
***
***
*** Message from tty to all terminals:
***
The system will be shut down in 10 minutes for repairs.

session-limit

To set the maximum
number of outgoing terminal sessions from the current terminal, use the
session-limit command in the appropriate line configuration mode. To remove
any specified session limit, use the
no form of
this command.

session-limitconnections

nosession-limit

Syntax Description

connections

Maximum
number of outgoing connections. Range is from 0 through 20.

Command Default

connections: 6

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to limit the number of active outgoing connections for the
default line template to eight:

session-timeout

To set the timeout
interval for all outgoing connections from the current terminal, use the
session-timeout command in the appropriate line
configuration mode. To remove the
session-timeout
command from the configuration file and restore the system to its default
condition, use the
no form of
this command.

session-timeoutminutes [output]

nosession-timeoutminutes

Syntax Description

minutes

Timeout
interval, in minutes. Range is 0 to 35791. The default is 10.

output

(Optional)
Specifies that when traffic is sent to an asynchronous line from the router
(within the specified interval), the connection is retained.

Command Default

minutes: 10

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
session-timeout command to set the interval that
Cisco IOS XR software waits for traffic before closing the connection to a remote
device and returning the terminal to an idle state. If the
output
keyword is not specified, the session timeout interval is based solely on
detected input from the user. If the keyword is specified, the interval is
based on input and output traffic.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the session timeout value for the default line
template to 120 minutes (2 hours):

Hardware
Universal Asynchronous Receiver/Transmitter (UART) overruns or software buffer
overflows, both defined as the number of overruns or overflows that have
occurred on the specified line since the system was restarted. Hardware
overruns are buffer overruns; the UART chip has received bits from the software
faster than it can process them. A software overflow occurs when the software
has received bits from the hardware faster than it can process them.

Acc I/O

Not
implemented.

The following
example shows sample output from the
showline command with the console line specified:

Unique
identifier of the tty; it contains the type of tty and, for physical ttys, it
indicates the physical location of the tty.

Speed

Baud rate
that the inbound serial connection is using in bps.

Overruns

Hardware
UART overruns or software buffer overflows, both defined as the number of
overruns or overflows that have occurred on the specified line since the system
was restarted. Hardware overruns are buffer overruns; the UART chip has
received bits from the software faster than it can process them. A software
overflow occurs when the software has received bits from the hardware faster
than it can process them.

Acc I/O

Not
implemented.

Line

Unique
identifier of the TTY. This field displays the type of TTY and the physical
location of physical TTYs.

Location

Location
of the line.

Type

Line type.

Length

Length of
the terminal or screen display, in rows.

Width

Width of
the terminal or screen display, in columns.

Baud rate
(TX/RX)

Transmit
rate/receive rate of the line, in bps.

parity

Parity
bits value used for physical terminal connections.

stopbits

Stop bits
value used for physical terminal connections.

databits

Data bits
value used for physical terminal connections.

Template

Line
template being sourced by the particular connection.

Config

Configuration applied to the tty. This field indicates the
allowed incoming transports that can be used to access the router from this
tty.

Allowed
transports are

Incoming
transport protocols that can be used by this tty to access the router.

show
sessions

To display
information about suspended Secure Shell (SSH) and Telnet connections launched
from the terminal session, use the
showsessions command in

EXEC

mode.

showsessions

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
show sessions
command to display the hostname, remote connection service used by the router
to access the host, idle time, and connection name.

Task ID

Task ID

Operations

tty-access

read

Examples

The following
example shows sample output from the
show sessions
command:

Identifier
for the connection used for resuming and disconnecting suspended sessions. An
asterisk (*) indicates the current terminal session.

Host

Remote
host to which the router is connected. This field displays either the IP
address or hostname of the remote host. If the IP address of the remote host is
mapped to the hostname (that is, if Domain Name System [DNS] services are
enabled) and the session is initiated with the hostname, the output for this
field displays the hostname of the host rather than the IP address of the host.

Configuration applied to the tty. This field indicates the
allowed incoming transports that can be used to access the router from this
tty.

Allowed
transports are

Incoming
transport protocols that can be used by this tty to access the router.

show users

To display
information about the active lines on the router, use the
showusers command in
EXEC
mode.

showusers

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
show users
command to display the line number, connection name, idle time, hosts, and
terminal location. An asterisk (*) indicates the current terminal session.

Note

To display all
user groups and task IDs associated with the currently logged-in user, use the
showuser command in EXEC mode. See the
Authentication, Authorization, and Accounting Commands on Cisco
IOS XR Software module in
Cisco IOS XR System Security Command Reference for the Cisco XR 12000 Series Router.

Related Commands

terminal exec
prompt

To specify prompt
attributes for the current terminal session, use the
terminalexec
prompt command in the appropriate mode.

terminalexecprompt
{ no-timestamp | timestamp }

Syntax Description

no-timestamp

Disables the
time-stamp printing before each command.

timestamp

Enables the
time-stamp printing before each command.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use theterminal exec prompt command with the
timestamp
keyword to show the time-stamp display after each command is entered. Use the
terminalexec command with the
no-timestamp
keyword to disable the time-stamp display.

Note

The
terminal
commands are active for the current terminal session only. To apply a setting
to all sessions, use the
line
commands.

Task ID

Task ID

Operations

tty-access

read

Examples

This example shows
how to enable the time-stamp prompt. When enabled, the date and time are
displayed after each command. In this example, the
showversion command is entered, and the date and time
is displayed.

Related Commands

Display
the terminal configuration settings for the current terminal line.

terminal exec
utility pager

To configure the
terminal page display options, use the
terminal exec utility pager command in the
appropriate mode.

terminal exec utility pager
{ less | more | none }

Syntax Description

less

Specifies to
use unix-like "less" bidirectional paging for the terminal display.

more

Specifies to
use unix-like "more" unidirectional paging for the terminal display.

none

Specifies
that the display is not paginated.

Command Default

No pagination is
configured by default.

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
terminal exec utility
pager command with the
more keyword to
scroll forward through command display one screen at a time. "--More--" is
displayed at the end of each screen. Press the Space key to advance one screen.
Press the Enter key to advance one line. Press the Esc key to exit the command
display.

Task ID

Task ID

Operation

tty-access

Read

Examples

This example shows
how to limit command display to one screen at a time such that you can move
forward through the display:

RP/0/0/CPU0:router#terminal exec utility pager more

terminal
length

To set the number of
lines that display at one time on the screen for the current terminal session,
use the
terminallength command in

EXEC

mode.

terminallengthlines

Syntax Description

lines

Number of
lines that display on a screen. Range is from 0 through 512.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
terminallength command to set the terminal length value
for only the current terminal session and not save it to the running
configuration. Exiting from the terminal session returns the terminal length
value to the value configured with the
length
command.

Specifying a value
of 0 for the
lines
argument prevents the router from pausing between screens of output.

Note

The
terminal
commands are active for the current terminal session only. To apply a setting
to all sessions, use the
line
commands.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

This example shows
how to set the length for the current terminal session to 120 lines:

Related Commands

terminal
width

To set the width of
the display terminal for the current terminal session, use the
terminalwidth command in

EXEC

mode.

terminalwidthcharacters

Syntax Description

characters

Number of
characters to display on a screen. Range is from 0 to 512.

Command Default

None

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
terminalwidth command to set the terminal width value for
only the current terminal session and not save it to the running configuration.
Exiting from the terminal session returns the terminal width value to the value
configured with the
width
(display) command.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the terminal width for the current terminal session to
120 characters:

RP/0/0/CPU0:router# terminal width 120

Related Commands

timestamp
disable

To disable
time-stamp recording at the top of each command output, use the
timestampdisable command in the appropriate line
configuration mode. To reenable time-stamp recording if disabled, use the
no form of
this command.

timestampdisable

notimestampdisable

Syntax Description

This command has no keywords or arguments.

Command Default

Time-stamp recording
at the top of each command output is enabled.

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.3.0

This command
was introduced.

Release 3.4.0

No
modification.

Release 3.8.0

The command
was changed from
timestamp to
timestamp
disable. The default was changed.

Usage Guidelines

By default, the time
stamp is displayed at the top of any command output. The time stamp records the
time at which the command was issued. You can use the
snmp-serverview command to disable this setting so that the
time stamp does not appear at the top of the command output. This setting
applies to all command outputs on any terminal line to which the current line
template applies.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

This example shows
how to disable time-stamp recording for the console line template:

transport
input

To define the
transport protocols that can be used to access the router, use the
transportinput command in the appropriate line
configuration mode. To change or remove the protocol, use the
no form of
this command.

Command Default

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

To be accepted,
incoming network connections to an asynchronous port (terminal line) must use a
transport protocol specified with the
transportinput command. This command can be useful in
limiting the acceptable transport protocols to include or exclude those used by
different types of users, or to restrict a line to secure connections (SSH
connections).

Task ID

Task ID

Operations

tty-access

read,
write

Examples

This example shows
how to set the transport input setting for the default line template to SSH
connections:

Related Commands

Specifies the transport protocol that
Cisco IOS XR software uses if the user does not specify one when initiating a
connection.

transport
output

To specify the
transport protocols that can be used for outgoing connections from a line, use
the
transportoutput command in the appropriate line
configuration mode. To change or remove the protocol, use the
no form of
this command.

Related Commands

Specifies the transport protocol that
Cisco IOS XR software uses if the user does not specify one when initiating a
connection.

transport
preferred

To specify the
default outgoing transport protocol to be used for initiating network
connections, use the
transportpreferred command in the appropriate line
configuration mode. To change or remove the protocol, use the
no form of
this command.

transportpreferred
{ none | ssh | telnet }

notransportpreferred
{ none | ssh | telnet }

Syntax Description

none

Disables the
feature.

ssh

Specifies
the Secure Shell (SSH) transport protocol.

telnet

Specifies
the Telnet transport protocol.

Command Default

No transport
protocol is set as the default outgoing protocol.

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
transportpreferred command to provide a default transport
protocol to use when initiating outgoing connections. The preferred outgoing
transport protocol specified with the
transportpreferred command enables you to initiate an
outgoing connection without explicitly specifying the transport protocol.

Cisco IOS XR software assumes that any unrecognized command is a hostname and the
software attempts a connection. When the protocol is set to
none, the
system ignores unrecognized commands entered at the EXEC prompt, and does not
attempt a connection.

The default
setting, the same as using the
transportpreferred command with the
none keyword,
prevents errant connection attempts.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

The following
example shows how to set the preferred transport setting for the default line
template to SSH:

Command Default

Command Modes

Command History

Release

Modification

Release 3.2

This
command was introduced.

Release 3.8.0

The
keyword
fm was changed to
eem.

Usage Guidelines

When creating or
modifying vty pools, follow these usage guidelines:

Before creating or
modifying the vty pools, enable the Telnet server using the
telnetserver command in global configuration mode. See
Cisco IOS XR IP Addresses and Services Configuration
Guide for the Cisco XR 12000 Series Router and
Cisco IOS XR IP Addresses and Services Command
Reference for the Cisco XR 12000 Series Router for more information.

The vty range for the
default vty pool must start at vty 0 and must contain a minimum of five vtys.

The vty range from 0
through 99 can reference the default vty pool.

The vty range from 5
through 99 can reference a user-defined vty pool.

The vty range from 100 is
reserved for the embedded event manager vty pool.

The vty range for embedded
event manager vty pools must start at vty 100 and must contain a minimum of six
vtys.

A vty can be a member of
only one vty pool. A vty pool configuration fails if the vty pool includes a
vty that is already in another pool.

If you attempt to
remove an active vty from the active vty pool when configuring a vty pool, the
configuration for that vty pool fails.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

This example shows
how to configure a user-defined vty pool (test1) that contains
vtys 10 through14 and references the user-defined line template test2:

RP/0/0/CPU0:router(config)# vty-pool test1 10 14 line-template test2

Related Commands

Enters
line template configuration mode for the specified line template.

width
(display)

To set the width of
the display terminal, use the
width command
in the appropriate line configuration mode. To remove the
width command
from the configuration file and restore the system to its default condition,
use the
no form of
this command.

widthcharacters

nowidthcharacters

Syntax Description

characters

Number of
characters to display on a screen. Range is from 0 to 512.

Command Default

characters: 80

Command Modes

Line console configuration

Line default configuration

Line template configuration

Command History

Release

Modification

Release 3.2

This command
was introduced.

Usage Guidelines

Use the
width command
to modify the default width setting for the specified line template.

Task ID

Task ID

Operations

tty-access

read,
write

Examples

This example shows
how to set the terminal width for the default line template to 99 characters: