Utility Commands on the Cisco IOS XR Software

Keywords are entered using the displayed syntax, or with UNIX-equivalent syntax. The UNIX-equivalent syntax is displayed in parentheses () in the syntax description. For example, the universal keyword can also be entered using the UNIX-equivalent (-u). To display the UNIX-equivalent syntax online, enter the usage keyword.

utility bc

To implement an
arbitrary precision calculator, use the
utilitybc command in

EXEC mode or administration EXEC

mode.

utilitybc
[ fileinput-file ]

Syntax Description

fileinput-file

(Optional)
Specifies the text file containing commands and function definitions to be
interpreted by the bc utility.

After all
files have been read, the bc utility reads input from the standard input
(keyboard). If no files are specified, then only the standard input (keyboard)
is used.

The syntax of the
input-file
argument is as follows:
device:[/directory-path]/filename

Possible
values of the
device:
argument are:

bootflash:

Uses a
file from the bootflash: file system.

compactflash:

Uses a
file from the compactflash: file system.

compactflasha:

Uses a
file from compactflasha: file system partition.

disk0:

Uses a
file from disk0: file system.

disk0a:

Uses a
file from disk0a: file system partition.

disk1:

Uses a
file from disk1: file system.

disk1a:

Uses a
file from disk1a: file system partition.

flash:

Uses a
file from the flash: file system. The
flash: keyword
is alias for bootflash:.

ftp:

Uses a
file from an FTP network server. The syntax is
ftp:[[[//username[:password]@]location]/directory]/filename

harddisk:

Uses a
file from the hard disk drive file system (if present).

harddiska:

Uses a
file from the hard disk partition (if present).

nvram:

Uses a
file from the nvram: file system.

ipv4

Uses a
file from an IPv4 access list or prefix list.

ipv6

Uses a
file from an IPv6 access list or prefix list.

rcp:

Uses
a file from a remote copy protocol (rcp) network server. The syntax is
rcp:[[[//username@]location]/directory]/filename

tftp:

Uses
a file from a TFTP network server. The syntax is
tftp:[[//location]/directory]/filename

Use the
online help (?) function
to display the available devices and network protocols.

Command Default

If an input file
is not specified, the standard input (keyboard) is used.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following file systems were added:
disk0a:,
disk1a: and
compactflasha:.

Usage Guidelines

Use the
utility bc
command to use the interactive, programmable calculator that supports a
complete set of control structures, including functions. The utility first
processes any specified files, and then reads input from the keyboard (standard
input).

The bc utility
uses the bc programming language, an arbitrary precision calculator language
with syntax similar to the C programming language. The bc utility does not
support character or string manipulation.

The bc utility
supports:

26 functions

26 simple variables

26 array variables (up to
2048 elements per array).

The bc utility
supports the following common programming language constructs:

“if”, “while”, and “for”
statements

User-defined functions with
parameters

Local variables

Information
About Supported Network Protocols

In the syntax for
the
ftp:,
rcp:, and
tftp: network
protocols, the location is either an IP address or a hostname. The filename is
specified relative to the directory used for file transfers.

When no device is
specified, the current directory is used. To view the current directory, enter
the
pwd command.

Table 1 Network
Protocols Supported by Cisco IOS XR Software

Prefix

Name

Description

tftp:

Trivial
File Transfer Protocol

TFTP is a simplified version of FTP that allows files to
be transferred from one computer to another over a network, usually without the
use of client authentication (for example, username and password).

ftp:

File
Transfer Protocol

FTP is an application protocol, part of the TCP/IP
protocol stack, and is used for transferring files between network nodes. FTP
requires a username and password.

rcp:

remote
copy protocol

Rcp is a protocol that allows users to copy files to and
from a file system residing on a remote host or server on the network. Rcp uses
TCP to ensure the reliable delivery of data. Rcp downloads require a username.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utility bc
command is used to execute the bc statements contained in the ASCII text file
exp.txt:

RP/0/0/CPU0:router# utility bc file disk0:/usr/exp.txt
50
15
25
3
17

utility cut

To extract selected
characters or fields from standard input or from a file, use the
utilitycut command in

Syntax Description

(-c) Cuts out the
characters that are located on each line as specified with the
character-list
argument.

The
character-list
argument specifies the character positions or range of the characters to be
cut.

Use a comma (,) to indicate
more than one character. For example,
utility list
1,2,5 outputs the first, second, and fifth characters.

Use a dash (-) to indicate a
range. For example,
utility list
1-64 outputs the first 64 characters of each line,
utility list 5-
outputs the fifth character to the end of the line.

Note

Lines are
separated by a delimiter. The default delimiter is tab.

fieldsfield-list

(-f) Cuts out the fields
(lines) as indicated with the
field-list
argument.

The
field-list
argument specifies the field numbers or
ranges. For example,
utility field
2,9 outputs the second and ninth fields,
utility field
1-3 outputs the first three fields,
utility field
-6 outputs the first six fields.

Note

The fields
indicated by the
field-list
argument are assumed to be separated in the file by a delimiter character. The
default delimiter is tab. Use the
delimiterdelimiter
option to specify a delimiter character.
Lines without field delimiters are processed unless the
nodelim keyword
is specified.

nodelim

(Optional)
(-s) Ignores lines
with no delimiter. Use this optional keyword when the
fieldsfield-list keyword and argument is specified.

delimiterdelimiter-character

(Optional)
(-d) Specifies an
alternative delimiter to indicate the end of each field. Replace the
delimiter-character
argument with the character used as the
delimiter.

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

file
input-file

(Optional)
Storage device and directory path of the text file used instead of the standard
input (keyboard input).

The syntax of the
input-file
argument is:
device:[/directory-path]/filename

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If no file is
specified, the keyboard input (standard input) is used.

The delimiter is
tab.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:and
compactflasha:.

Usage Guidelines

The
utilitycut command cuts out columns, fields, or
characters displayed from standard input or from a file.

Use the
fieldsfield-list keyword and argument if the fields vary
in length from line to line. (The lines must be separated by a delimiter
character.) By default, the field delimiter character is the Tab key. Use the
delimiterdelimiter-character keyword and argument to
specify a different delimiter.

Use the
listcharacter-list
keyword and argument only if the fields are of a fixed
length. Replace the
character-list
argument with the character positions to be extracted.

For the
character-list argument, use a comma (,) to
indicate more than one character, or use a dash (-) to indicate a range. For
example,
utility list
1,2,5 outputs the first, second, and fifth characters,
utility list
1-64 outputs the first 64 characters of each line,
utility list
5- outputs the fifth character to the end of the line.

You can also use
the cut utility as a filter. If no files are specified, the keyboard input
(standard input) is used.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
fields
keyword can also be entered using the UNIX-equivalent (-f). To display the
UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilitycut command is entered with the
listcharacter-list keyword and argument to display the
first 10 characters in each line. The output is from the results of the
showversion command, which is entered with the pipe
(|) character:

In the following
example, the UNIX equivalent options are used directly. First, the
utilitycut command is entered with the
usage keyword
to display the possible options. Next, the
utilitycut command is entered with the options to extract
the desired data.

Copies
the end portion of the output displayed from standard input or a file.

utility date

To display the date
and time, use the
utilitydate command in

EXEC mode or administration EXEC

mode.

utilitydate
{ formatword | universal | usage | WORD }

Syntax Description

format
word

(Optional)
(+) Specifies the format for the date display. Use the online help system to
display the available format syntax for the
word argument.

universal

(Optional)
(-u) Displays the date
in Coordinated Universal Time (UTC) instead of local time. UTC is the standard
term for Greenwich Mean Time (GMT).

usage

(Optional)
Displays the UNIX options supported by this command.

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

Command Default

The date is
displayed in local time.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Usage Guidelines

The
utilitydate command displays the internal time and date
for the router.

Date
Format

Use the
formatword option to specify the format and content of the displayed date
and time. The format is composed of ASCII characters and field descriptors
prefaced with %, in a manner similar to a C-language printf() format specifier.
In the output, each field descriptor is replaced by its corresponding value;
all other characters are copied to the output without change. The format is
specified using the following characters:

%C

Century in
'CC' form. For example: 20

%y

Year in 'YY'
form. For example: 06

%m

Month in
'MM' form. For example: 08

%d

Date in 'DD'
form. For example: 28

%H

Hour in 'hh
(24 hr.)' form. For example: 18

%M

Minutes in
'mm' form. For example: 55

%S

seconds in
'ss' form. For example: 24

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
universal keyword can also be entered using the UNIX-equivalent (-u). To display the
UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

This example shows
how to display the router date and time using the
utilitydate command:

RP/0/0/CPU0:router# utility date
Fri Aug 04 11:53:38 UTC 2006

This example shows
how to display the router date and time using a variety of options with the
format
keyword:

Command Default

Command Modes

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Usage Guidelines

A colon (:) is
required between the entry for hour, minutes, and seconds.

Note

Generally, if
the system is synchronized by a valid outside timing mechanism, such as a
Network Time Protocol (NTP) clock source, or if you have a networking device
with calendar capability, you need not set the software clock. Use the
date command
or the
clockset command if no other time sources are
available.

Note

To manually copy
the hardware clock (calendar) settings into the software clock, use the
clockread-calendar command in EXEC mode.

By default, the
system makes a “slow adjustment” if the new time is in the range of the
following:

–2.5 minutes + old time

5 minutes + old time

In a slow
adjustment, the clock speed increases by less than 100 percent or decreases by
less than 50 percent over a period of time from 1 second to 5 minutes until the
clock catches up with the new time. This slow adjustment does not cause major
discontinuities in the time flow. Use the
-S0 option
to disable the slow adjustment.

Task ID

Task ID

Operations

universal

execute

Examples

The following
example shows how to set the time using the
utilitydateset command:

(Optional)
Specifies the storage device and directory path of the device, directory, or
file. When a directory or file is specified, the df utility displays the amount
of space on the file system that contains the directory or file.

If no files
are specified, then only the standard input (keyboard) is used.

The syntax of the
input-file
argument is as follows:
device:[/directory-path]/filename

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

Information is
displayed for all file systems.

The results are
displayed in 512-byte blocks.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a: and
compactflasha:.

Usage Guidelines

Use the (disk
free)
utilitydf command to display the amount of disk space
available for a device, directory, or file. Enter the command without keywords
or arguments to display information for all mounted file systems.

Use the
vsfStats
keyword to invoke the statvfs() function, which provides additional details for
all mounted file systems.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
kbytes
keyword can also be entered using the UNIX-equivalent (-k). To display the
UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the (disk free)
utilitydf command is entered without keywords or
arguments to display information for all file systems:

Syntax Description

all

(Optional)
(-a) Displays the disk
space used for each file in the directory. By default, information is displayed
only for the directory. Use the
all keyword to
display the total disk space used by all files in the directory, including the
directory itself.

specified

(Optional)
(-s) Displays the
total disk space used for each specified file, rather than the totals for any
subdirectories.

kbytes

(Optional)
(-k) Displays the disk
space used in 1-K blocks (1024-byte units) instead of the default of 512-byte
blocks.

bytes

(Optional)
(-p) Displays the disk
space used in bytes (the default is 512-byte blocks). Also generates error
messages for exiting files that cannot be displayed.

local

(Optional)
(-x) Displays
information for the local device only.

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

filesource

(Optional)
Displays the disk space used for a device, directory, or file.

The syntax
for the
source argument
is
device:/directory-path[/filename]

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

Enter the
utility du
command without specifying a device, directory, or file to display information
for the current directory, and subdirectories. (The command behaves as if the
filename dot (.) is entered.)

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

Information for
the current directory is displayed.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Enter the
utility du
command without specifying a file to display information for the current
directory. The command behaves as if the filename dot (.) is entered.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
kbytes keyword can also be entered using the UNIX-equivalent (-k). To display the
UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utility du
command is used to display the disk space used for the
subdirectories in the MPLS package directory:

Syntax Description

(-e) A regular expression.
This form is used when only one expression is specified on the command line.
Any names specified after this option are treated as input files.

scriptexpression-file

(-f) A file containing a
set of regular expressions, each separated by a new line. The type of the
expressions is determined by the -e and -f options. This form is used when more
than one expression is specified. You can specify more than one -f option.

The syntax
of the
expression-file
argument is:
[device:]/filename

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 20.

count

(Optional)
(-c) Displays a count
of selected lines.

linenum

(Optional)
(-n) Before each
output line, displays the line's line number.

matchfile

(Optional)
(-l) (“el”) Displays
only the names of files containing the selected lines.

matchline

(Optional)
(-x) Includes only
input lines selected against an entire fixed string or regular expression.

(Optional)
(-h) Displays
results without a filename prefix attached to the matched lines. This option
applies only when more than one file is searched.

reverse

(Optional)
(-v) Selects only
those lines that don't match the specified patterns.

filesearch-file

(Optional)
The file used for the search. Replace the
search-file
argument with the device and directory path of the file. The syntax for the
search-file
argument is:
[device:]/filename.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If no files are
specified, the keyboard input (standard input) is used.

If more than one
input file is specified, then the filename is displayed before each line.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

The grep utility
searches files for character patterns using regular expressions and returns all
lines that contain that pattern. The
utility egrep
command uses full regular expressions (expressions using the full set of
alphanumeric and special characters) to match the patterns.

The results are
displayed to the standard output (terminal screen).

Note

The egrep
utility options are entered using the displayed syntax, or with UNIX-equivalent
syntax. The UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
count keyword
can also be entered using the UNIX-equivalent (-c). To display the
UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utility egrep
command is used to locate the regular expression “uptime”. The
linenum
keyword is also entered to display the line number before each line of output.

Syntax Description

exprexpression

(-e) A regular expression,
whose type is determined by the -e and -f options. This form is used when only
one expression is specified on the command line. Any names specified after this
option are treated as input files.

scriptexpression-file

(-f) A file containing a
set of regular expressions, each separated by a new line. The type of the
expressions is determined by the -e and -f options. This form is used when more
than one expression is specified. You can specify more than one -f option.

The syntax
of the
expression-file
argument is:
device:[/directory-path]/filename

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 20.

count

(Optional)
(-c) Displays a count
of selected lines.

linenum

(Optional)
(-n) Before each
output line, displays the line's line number.

matchfile

(Optional)
(-l) (“el”) Displays
only the names of files containing the selected lines.

matchline

(Optional)
(-x) Includes only
input lines selected against an entire fixed string or regular expression.

(Optional)
(-h) Displays
results without a filename prefix attached to the matched lines. This option
applies only when more than one file is searched.

reverse

(Optional)
(-v) Selects only
those lines that don't match the specified patterns.

filesearch-file

(Optional)
The file used for the search. Replace the
search-file
argument with the device and directory path of the file. The syntax for the
search-file
argument is:
device:[/directory-path]/filename

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

The keyboard input
(standard input) is used if no files are specified.

If more than one
input file is specified, then the filename is displayed before each line.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

The
utility fgrep
command searches files for a fixed character string (as opposed to grep and
egrep, which search for a a pattern that matches an expression).

The results are
displayed to the standard output (terminal screen).

Note

The fgrep
utility options are entered using the displayed syntax, or with UNIX-equivalent
syntax. The UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. For example, the
count keyword
can also be entered using the UNIX-equivalent (-c). To display the
UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

The following
example, the
utility fgrep
command is used with the
nocase and
linenum
keywords:

Syntax Description

Specifies
the storage device and directory for the file search. The search is performed
for the specified directory and all subdirectories in that directory tree.

If a
directory path is not specified, then the search is performed in the current
directory (a path of . [dot] is assumed).

LINE

(Optional)
UNIX command-line expressions provided as a string.

namefilename-pattern

(Optional)
Searches for the name of the file. The
filename-pattern argument is a regular expression
string.

user
user-id

(Optional)
Searches for files belonging to a specific user. The
user-id
argument is the username of the file owner.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If a directory path
is not specified, then the search is performed in the current directory.

If a
namefilename-pattern is not specified, then the search
return all files in the specified directory.

If a user is not
specified, then the search is performed for all users.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Use the
utilityfind command to locate files within one or more
directories. You can perform the search for a specific directory (and its
subdirectories). If a directory is not specified, then the search is performed
for the current directory.

To search for a
regular expression string, use the
namefilename-pattern keyword and argument. Replace the
filename-pattern argument with the regular
expression string. If this option is not used, then all files within the
specified directory are displayed.

To search for
files belonging to a specific user, use the
user-id
argument. If this option is not used, then files belonging to all users are
displayed.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, theutilityfind command is used to locate the file named “c12k-fwdg-3.8.0”. The path is the root directory of disk0:.

Related Commands

utility head

To copy bytes or
lines at the beginning of a file or from the standard input, use the
utilityhead command in

EXEC mode or administration EXEC

mode.

utilityhead [ WORD | [bytes]
[ countnumber ] [ filesource ] | usage ]

Syntax Description

WORD

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

bytes

(Optional)
(-c) Copies the data
in bytes from the beginning of each specified file. The default setting is to
copy lines of data.

countnumber

(Optional)
(-n) Specifies the
number of lines (default) or bytes to be copied. The
number
argument is an unsigned decimal integer.

By default,
the
utility head
command copies the first ten units (lines or bytes) of the file. Use the
countnumber option to change the default.

file
source

(Optional)
Specifies the storage device, directory, and filename for the files.

If a file is
not specified, the standard input is used.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If the
utility head
command is entered without keywords or arguments, the first ten lines of the
file or standard output are copied.

If no file is
specified, then the standard input is used.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

The
utility head
command copies the beginning bytes (default) or lines of one or more files to
the standard output (usually the user interface display). Use the
bytes or
lines
keywords to copy the data based on lines or bytes. Use the
countnumber option to specify the number of bytes or
lines to copy. By default, the
utility head
command copies the first 10 lines of each file.

If more than one
file is selected, an identifying header is added before the output for each
file. If no file is specified, then the standard input (keyboard) is used.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utility head
command is used to display the first 15 lines from the output of the
show version
command:

(Optional)
(-j) Uses the line at
line-number on
the screen to position matched lines during a patter search.

startatstring

(Optional)
(-p) Starts at the
first occurrence of the pattern specified by the
string argument
in the file.

filesource-file

(Optional)
Specifies the storage device and directory path for the text file to be
displayed. The default is standard input.

The syntax
for the
source-file
argument is:
device:[/directory-path]/filename

Command Default

If no text file is
specified, standard input is assumed.

Command Modes

EXEC

Administration EXEC

Command History

Release

Modification

Release 3.5.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Use the
utilitylesscommand to display files page by page. You can
specify regular expressions for pattern matching using the
startat
keyword. You can scroll up as well as down. When you enter the less mode,
commands are similar to the “vi” editor.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

The following
example, the
utilityless command is used to display the file
“config_store”. Only part of the file is shown here.

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

force

(Optional)
(-f) Forces an
overwrite if the target file already exists. There is no confirmation prompt.

interactive

(Optional)
(-i) Specifies to
prompt for confirmation before renaming a file.

sourcesource-file

Specifies
the storage device, directory, and filename for the file to be moved.

targettarget-file

Specifies
the new storage device, directory, and filename for the file.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

No default behavior
or values

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilitymv command is used to move the file “aaa” from
disk0a: to disk1a:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

dict

(Optional)
(-d) Sorts in
dictionary order. Uses only alphanumeric and blank characters in the sort
operation.

fieldSepcharacter

(Optional)
(-t) Specifies a
character as the field separator.

ignoreblank

(Optional)
(-b) Ignores leading
blank characters in field comparisons.

keykey-definition

(Optional)
(-k) Defines a key to
be the sort key. The
key-definition
argument field is defined using the following syntax:

field_start [type_string] [,field_end] [type_string]

field_start and
field_end—Specifies the beginning and end of the
key field.

type_string—Specifies attributes specific to the
key.

The field_start and
field_end
arguments are each specified by a pair of digits of the form m.n, where the m
refers to the field starting after the mth field separator in a line. For
field_start, the .n refers to the nth character of the specified field, and is
taken as zero if not specified. For field_end, the .n refers to the nth
character after the last character of the specified field, and is taken as zero
if not specified.

The
type_string
argument may be formed from the characters bdfinr, which apply their defined
attributes to the determination of the key.

Note

When
ordering options appear independent of key field specifications, the requested
field ordering rules are applied globally to all sort keys. When attached to a
specific key, the specified ordering options override all global ordering
options for that key.

(Optional)
(-m) Merges sorted
files. Assumes that the files are already sorted and so does not sort the
files.

numeric

(Optional)
(-n) Interprets the
field as numeric and sorts in numeric order. Includes the sign and optional
thousands separator. This keyword also ignores leading blank characters in
field comparisons (implies the
ignoreblank
keyword).

outfilefilename

(Optional)
(-o) Writes the
results to a file. The
filename
argument is the destination disk, directory, and filename. The
filename argument can be the same as the source file.

printable

(Optional)
(-i) Ignores all
nonprintable characters.

reverse

(Optional)
(-r) Reverses the
sort order. The sort is ascending by default.

unique

(Optional)
(-u) Suppresses all
but one line in each set of lines having equal keys.

filefilename

(Optional)
Specifies a file to be sorted.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If no file is
specified, then the standard input (keyboard) is used.

If an
outfilefilename keyword and argument is not specified, then the standard
output (display) is used.

The file is sorted
in ascending order.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilitysort command is used to sort the contents of the
file “words.txt”:

RP/0/0/CPU0:router# utility sort file disk0:/usr/words.txt
The
few
inquires
A
Code.
Date
Done
This
best-selling
bestseller
book
come
concerning
fiction,
have
its
list
muscled
of
onto
our
the
way
way
work

In the following
example, only the unique characters in the file “words.txt” are displayed:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

bytes

(Optional)
(-c) Copies the end of
the file measured in bytes. The default is lines.

continuous

(Optional)
(-f) Continues to copy
data from the end of the file after the last line is reached. The operation
pauses for 1 second, and then resumes in a continuous loop.

The input
file must be a regular file, not a terminal or a FIFO special file (a named
pipe).

countnumber

(Optional)
(-n) Copies the number
of lines (default) or bytes specified with the
number
argument. The range is 0 to 4294967295. By default, the last 10 lines are
copied.

The
number argument
is a decimal integer that defines the location in the file to begin copying:

Include the plus (+)
character to copy from the beginning of the file.

Include the minus (-)
character to copy from the end of the file.

Do not include a character to
copy from the end of the file.

Note

Select the
bytes keyword
to copy the information measured in a count of bytes.

fileinput-file

(Optional)
Directory path and filename for the input file. If no file is specified, then
the standard input is used.

The syntax
for the
input-file
argument is:
device:[/directory-path]/filename

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If the
utility tail
command is entered without keywords or arguments, the last 10 lines of the
standard input are copied.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Use the
utility tail
command to copy data from the end of a file. By default, the last 10 lines are
copied. Use the
bytes keyword
to copy the data measured in bytes. Use the
count
number
option to define the number of lines or bytes to copy.
Use the
filefilename
option to specify an input file.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utility tail
command is used to display the last 10 lines of the output from the
show version
command:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

afterCharsnumber

(Optional)
(-s) Ignores the first
characters on each line of the input file. Use the
number argument
to specify the number of characters. The range is 0 to 4294967295.

afterFieldnumber

(Optional)
(-f) Ignores the first
fields on each line of the input file. Use the
number argument
to specify the number of fields. The range is 0 to 4294967295.

count

(Optional)
(-c) Displays the
number of times the line appeared in the input file at the beginning of each
output line.

nonrepeating

(Optional)
(-u) Displays only the
nonrepeating lines from the input file (repeating lines are not displayed).

repeating

(Optional)
(-d) Displays only the
repeating lines from the input file (nonrepeating lines are not displayed).

infileinput-file

(Optional)
Specifies an input file for processing. The
input-file
argument specifies the device, directory, and filename of the input file. If no
input file is specified, then the standard input (keyboard) is used.

The syntax of the
input-file
argument is:
device:[/directory-path]/filename.

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

outfileoutput-file

(Optional)
Specifies an output file. The
output-file
argument specifies the device, directory, and filename of the output file. If
no file is specified, then the standard output (display) is used.

The syntax
of the
output-file
argument is:
device:[/directory-path]/filename.

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If no input file
is specified, then the standard input is used.

If no output file
is specified, then the standard output is used.

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This
command was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Use the
utilityuniq command to display only lines that are
repeated in a file, or to display only lines that appear once. This utility
compares only adjacent lines, so the file or standard input must be sorted.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilityuniq command is used to display the repeating
lines in the output of the
showenvironment command:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

bytes

(Optional)
(-c) Displays the
number of bytes in each input file.

lines

(Optional)
(-l) (-œel-?) Displays
the number of lines in each input file.

words

(Optional)
(-w) Displays the
number of words in each input file.

fileinput-file

(Optional)
Specifies the input file. The
input-file
argument specifies the device, directory, and
filename of the input file. If no input file is specified, then the standard
input (keyboard) is used.

The syntax of the
input-file
argument is:
device:[/directory-path]/filename.

The
device
argument, followed by a colon, indicates the name of the device where the file
is located. Use the online help (?) function to display the available storage
devices and network protocols.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

Output is displayed
in the order bytes, words, and lines, even if the options are entered in a
different order.

Command Modes

EXEC, Administration EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Release 3.6.0

The
following devices were added:
disk0a:,
disk1a:, and
compactflasha:.

Usage Guidelines

Output is
displayed in the following order:

When keywords are entered,
the output appears in the order bytes, words, and lines.

When no keyword is entered,
the output appears in the order lines, words, and bytes.

When any UNIX equivalent
options are entered, the output appears in the order specified by the options.
For example, if the command
utility wc
-w -l -c is entered, the output appears in the order words, lines,
and bytes.

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilitywccommand is issued to display the number of
lines, words, and bytes in the output of the
showversion command:

RP/0/0/CPU0:router# show version | utility wc
221 1160 10820

The output
displays the following:

221 lines

1160 words

10820 bytes

In the following
example, the
utilitywc command is entered with the
words keyword
to display the number of words in the output of the
showversion command:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

all

(Optional)
(-a) Displays all
occurrences of the program specified by the
programpathname keyword and argument.

fullname

(Optional)
(-f) Displays the full
pathname of the program file.

long [link]

(Optional)
(-l) (“el”) Displays
the long format for each program found, and also displays link information if
the file is a symlink.

programprogram-name

Specifies
the name of the program file.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

None

Command Modes

EXEC, Admin EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Usage Guidelines

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage
keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, theutilitywhich command is entered without keywords or
arguments to display the location of the perl program:

RP/0/0/CPU0:router# utility which program perl
/pkg/bin/perl

In the following
example, the
utilitywhich command is entered with the
fullname keyword to display the full directory path of the perl
program:

Syntax Description

(Optional)
UNIX command-line option string. The maximum number of characters is 80.

trace

(Optional)
(-t) Prints each
program on standard error before executing.

program

(Optional)
Specifies the name of the program and initial arguments. If a program name is
not specified, then the echo utility is used.

program-name

(Optional)
Specifies the name of the program. If a program name is not specified, then the
echo utility is used.

initial-arguments

(Optional)
Specifies the initial arguments.

usage

(Optional)
Displays the UNIX options supported by this command.

Command Default

If no program is
specified, then the echo utility is used (the input lines are displayed).

Command Modes

EXEC, Administration EXEC

Command History

Release

Modification

Release 3.4.0

This command
was introduced.

Usage Guidelines

Note

Keywords are
entered using the displayed syntax, or with UNIX-equivalent syntax. The
UNIX-equivalent syntax is displayed in parentheses () in the syntax
description. To display the UNIX-equivalent syntax online, enter the
usage keyword.

Task ID

Task ID

Operations

universal

execute

Examples

In the following
example, the
utilityxargs command is used to display the egress lines: