Command-Line Interface

Using Command-Line Processing

Command Modes

EXEC Mode

Global Configuration Mode

Interface Configuration Mode

Check Command Syntax

System Help

Save Configuration Changes

EXEC Command Summary

Global Configuration Command Summary

Interface Configuration Command Summary

show Command Summary

Command-Line Interface

This chapter provides a summary of the command-line interface (CLI) commands included in the Cisco Cache Software Command Reference. The command summary tables are grouped alphabetically in five categories: user level EXEC commands, privileged level EXEC commands, global configuration commands, interface configuration commands, and show EXEC commands. The CLI can be accessed through the console port or Telnet.

Using Command-Line Processing

Cache software commands are not case sensitive. You can abbreviate commands and parameters as long as they contain enough letters to be different from any other currently available commands or parameters. You can scroll through the last 20 commands stored in the history buffer, and enter or edit the command at the prompt. (See Table 1-1.)

Table 1-1: Command-Line Processing Keystroke Combinations

Keystroke Combinations	Function
Ctrl-A	Jumps to the first character of the command line.
Ctrl-B or the left arrow key	Moves the cursor back one character.
Ctrl-C	Escapes and terminates prompts and tasks.
Ctrl-D	Deletes the character at the cursor.
Ctrl-E	Jumps to the end of the current command line.
Ctrl-F or the right arrow key¹	Moves the cursor forward one character.
Ctrl-K	Deletes from the cursor to the end of the command line.
Ctrl-L	Repeats the current command line on a new line.
Ctrl-N or the down arrow key¹	Enters the next command line in the history buffer.
Ctrl-P or the up arrow key¹	Enters the previous command line in the history buffer.
Ctrl-T	Transposes the character at the cursor with the character to the left of the cursor.
Ctrl-U; Ctrl-X	Deletes from the cursor to the beginning of the command line.
Ctrl-W	Deletes the last word typed.
Esc-B	Moves the cursor back one word.
Esc-D	Deletes from the cursor to the end of the word.
Esc-F	Moves the cursor forward one word.
Delete key or Backspace key	Erases a mistake when entering a command; reenter the command after using this key.

¹The arrow keys function only on ANSI-compatible terminals such as VT100s.

Command Modes

EXEC Mod e

There are two EXEC access levels: privileged and user. The enable and disable commands switch between the two levels. The user level EXEC command line is available to users if they enter a valid password. The user level EXEC commands are a subset of the privileged level EXEC commands. The user level EXEC prompt is the host name followed by a right angle bracket (>). The prompt for the privileged level EXEC command line is the pound sign (#). To execute an EXEC command, enter the command at the EXEC system prompt and press the Return key. In the following example, a user accesses the privileged level EXEC command line from the user level.

Console> enable

Console#

Use the Delete or Backspace key sequences to edit commands when you type commands at the EXEC prompt.

As a shortcut, you can abbreviate commands to the fewest letters that make them unique. For example, the letters sho can be entered for the show command.

Certain EXEC commands display multiple screens with the following prompt at the bottom of the screen:

--More--

Press the Spacebar to continue the output, or press Return to display the next line. Press any other key to return to the prompt. Also, at the --More-- prompt, you can enter a ? to display the help message.

To leave EXEC mode, use the exit command at the system prompt:

Console# exit

Global Configuration Mode

To enter the global configuration mode, use the configure EXEC command. You must be in global configuration mode to enter global configuration commands.

Console# configure

Console(config)#

To exit global configuration mode, use the end global configuration command:

Console(config)# end

You can also exit global configuration mode by entering the exit command or pressing Ctrl-Z.

Interface Configuration Mode

To enter the interface configuration mode, from the global configuration mode prompt enter the interface you wish to configure:

Console(config)# interface ethernet 0

Console(config-if)#

The interface configuration commands are:

autosense

bandwidth

exit

fullduplex

halfduplex

shutdown

These commands are described in the section following the global configuration commands.

To exit interface configuration mode, enter exit to return to global configuration mode:

cache4J(config-if)# exit

cache4J(config)#

Check Command Syntax

The user interface provides error isolation in the form of an error indicator, a caret symbol (^). The ^ symbol appears at the point in the command string where you have entered an incorrect command, keyword, or argument.

In the following example, suppose you want to set the clock. Use context-sensitive help to check the syntax for setting the clock.

An example of a mistake is:

Console# clock 1222

               ^
%Invalid input detected at `^' marker.
Console# clock ?

read-calendar    Read the calendar and update system clock
set              Set the time and date
update-calendar  Update the calendar with system clock 
Console# clock

The help output shows that the set keyword is required. Check the syntax for entering the time:

Console# clock set ?

<0-23>:  Current Time (hh:mm:ss)
Console# clock set

Enter the current time in 24-hour format with hours, minutes, and seconds separated by colons:

Console# clock set 13:32:00

% Incomplete command.

The system indicates that you need to provide additional arguments to complete the command. Press the Up Arrow to automatically repeat the previous command entry. Then add a space and question mark (?) to display the additional arguments:

Console# clock set 13:32:00 ?

<1-31> Day of the month
January Month of the year
February
March
. . .

Enter the day and month as prompted and use the question mark for additional instructions:

Console# clock set 13:32:00 23 December ?

  <1993-2035>  Year

Now you can complete the command entry by entering the year:

Console# clock set 13:32:00 23 December 00

                                        ^
%Invalid input detected at '^' marker.
Console#

The caret symbol (^) and help response indicate an error with the 00 entry. To display the correct syntax, press Ctrl-P or the Up Arrow. You can also reenter the command string, and then enter a space character, a question mark, and press Enter:

Console# clock set 13:32:00 23 December ?

<1993-2035> Year
Console# clock set 13:32:00 23 December

Enter the year using the correct syntax and press Return to execute the command:

Console# clock set 13:32:00 23 December 2000

WARNING: Setting the clock may cause a temporary service interruption.
Do you want to proceed? [no] yes

Sat Dec 23 13:32:00 EST 2000 
Console#

System Help

You can obtain help when you enter commands by using the following methods:

For a brief description of the context-sensitive help system, enter help.
To list all commands for a command mode, enter a question mark (?) at the system prompt.
To obtain a list of commands that start with a particular character set, enter an abbreviated command immediately followed by a question mark (?).

Console# cl?

clear  clock

To list the command keywords or arguments, enter a space and a question mark (?) after the command:

Console# clock ?

  clear  Clear the current time from the battery-backed clock
  save   Save the current time into the battery-backed clock
  set    Set the local time and date

Save Configur ation Changes

To avoid losing new configurations, save them to NVRAM using the copy or write commands, as shown in the following example:

Console# copy running-config startup-config

Console# write

See the command description for the copy running-config startup-config command for more information on "running" and "saved" configuration modes.

EXEC Command Summary

The EXEC commands are entered in the EXEC mode. Table 1-2 lists the user level EXEC commands. Table 1-3 lists the privileged level EXEC commands.

Table 1-2: Cache Software 3.0.0 User Level EXEC Commands

User EXEC Command	Syntax	Description
cd	cd directoryname	Changes the current directory.
cpfile	cpfile oldfilename newfilename	Copies sysfs files.
delfile	del filename	Removes a file.
deltree	deltree directory	Removes directory and all subdirectories.
dir	dir [directory]	Displays files in long list format.
dnslookup	dnslookup {host \| domain-name}	Resolves host name (DNS).
enable	enable	Accesses privileged EXEC commands.
exit	exit	Exits from terminal session.
help	help	Assistance for command line-interface.
lls	lls [directory]	Displays directory files in long list format.
ls	ls [directory]	Displays files in directory.
mkdir	mkdir directory	Makes directory.
mkfile	mkfile filename	Makes file (for testing).
ping	ping {hostname \| ip-address}	Sends echo packets.
pwd	pwd	Displays pathname of the present working directory.
rename	rename sourcefile destinationfile	Renames a file (pathname).
rmdir	rmdir directory	Removes directory.
type	type filename	Displays a file.
whoami	whoami	Displays current user's login name.

Table 1-3: Cache Software 3.0.0 Privileged Level EXEC Commands

Privileged EXEC Command	Syntax	Description
cache	cache {clear [force] \| reset \| synchronize}	Cache commands.
cd	cd directoryname	Changes directory.
cfs	cfs {clear diskname [force] \| format diskname \| mount diskname \| reset diskname \| sync diskname \| unmount diskname}	Cache file system commands.
check	check superuser passwords	Checks whether superuser accounts are password-protected.
clear	clear {bypass {counters \| list} \| cache [force] \| dns-cache \| interface serial number \| logging \| statistics {all \| dns-cache \| ftp \| history \| http {all \| errors \| ims \| object \| requests \| response \| savings} \| https \| icp {all \| client \| cluster \| server}} \| running \| tcp \| transaction-logs} \| transaction-log}	Resets functions.
clock	clock {read-calendar \| set time day month year \| update-calendar}	Sets system clock.
configure	configure	Enters configuration mode from privileged EXEC mode.
copy	copy {disk {flash imagename \| startup-config filename} \| flash disk imagename \| ftp flash {hostname \| ipaddress} remotedir remotefilename \| running-config {disk filename \| startup-config \| tftp {hostname \| ipaddress} filename} \| startup-config {disk filename \| tftp {hostname \| ipaddress} filename} \| tech-support {disk filename \| tftp {hostname \| ipaddress} filename}} \| tftp {disk {hostname \| ipaddress} remotefilename localfilename \| flash {hostname \| ipaddress} imagename}}	Copies configuration or image files to and from Flash memory, disk, or remote hosts.
cpfile	cpfile oldfilename newfilename	Copies a file.
debug	debug	Configures debugging functions.
delfile	del filename	Removes a file.
deltree	deltree directory	Removes a directory and its subdirectories.
dir	dir [directory]	Displays files in long list format.
disable	disable	Turns off privileged EXEC commands.
disk	disk {erase-all-partitions disk name \| manufacture disk name \| partition disk name {cfs \| sysfs} \| prepare disk name}	Disk management commands.
dnslookup	dnslookup {host \| domain-name}	Resolves a hostname (DNS).
enable	enable	Accesses privileged EXEC commands.
exit	exit	Exits from the EXEC and configuration command levels to user level.
help	help	Assistance for command-line interface.
install	install paxfilename	Installs a new version of the Cache software.
lls	lls [directory]	Displays files in long list format.
ls	ls [directory]	Lists files in directory.
mkdir	mkdir directory	Makes a directory.
mkfile	mkfile filename	Makes a file (for testing).
ntpdate	ntpdate {hostname \| ip-address}	Sets the NTP server name.
ping	ping {hostname \| ip-address}	Sends echo packets.
pwd	pwd	Displays present working directory.
reload	reload	Halts and performs a cold restart.
rename	rename sourcefile destinationfile	Renames a file (pathname).
rmdir	rmdir directory	Removes a directory.
sysfs	sysfs {check disk name \| format disk name \| mount {disk name {local1 \| local2}} \| repair disk name \| sync \| unmount {local1 \| local2}}	Maintains system file system.
terminal	terminal monitor	Configures current console debug command output.
transaction-log	transaction-log force {archive \| export}	Forces archive of working log file to make a transaction log file.
type	type filename	Displays contents of a file.
undebug		Disables debugging functions (see also debug).
whoami	whoami	Displays current user's name.
write	write [erase \| memory \| terminal]	Writes running configuration to memory or terminal.

Global Configuration Command Summary

The global configuration Content Engine commands are entered in the global configuration mode. Table 1-4 lists the global configuration commands.

Table 1-4: Cache Software 3.0.0 Global Configuration Commands

Global Configuration Command	Syntax	Description
bypass	bypass {auth-traffic enable \| load {enable \| in-interval seconds \| out-interval seconds \| time-interval minutes} \| static {clientipaddress {clientipaddress \| any-server} \| any-client serveripaddress} \| timer minutes}	Configures bypass functions.
clock timezone	clock timezone {timezone hoursoff minutesoff}	Configures time-of-day clock.
dns-cache	dns-cache size maxsize	Configures DNS cache.
end	end	Exits configuration and privileged EXEC modes.
error-handling	error-handling {reset-connection \| send-cache-error \| transparent}	Customizes how Content Engine handles errors.
exec-timeout	exec-timeout timeout	Configures exec timeout.
exit	exit	Exits configuration and privileged EXEC modes.
ftp	ftp {age-multiplier directory-listing dl_time file fo_time \| max-ttl {days directory-listing dlmax_days file fmax_days \| hours directory-listing dlmax_hours file fmax_hours \| minutes directory-listing dlmax_ min file fmax_min \| seconds directory-listing dlmax_ sec file fmax_sec} \| min-ttl min_minutes \| object max-size size \| proxy {anonymous-pswd passwd \| incoming port \| outgoing host {hostname \| ipaddress} port \| reval-each-request {all \| directory-listing \| none} \| serve-ims directory-listing age_percent file age_percent}	Configures FTP caching services.
gui-server	gui-server {enable \| port port}	Configures GUI server.
help	help	Assistance for command-line interface.
hostname	hostname name	Configures the system's network name.
http	http {age-multiplier {text texttime binary bintime} \| anonymizer enable \| append {via-header \| x-forwarded-for-header} \| authenticate-strip-ntlm \| cache-authenticated \| cache-cookies \| cache-miss revalidate \| cache-on-abort {enable \| max maxthresh \| min minthresh \| percent percenthresh} \| max-ttl {days text textdays binary bindays \| hours text texthours binary binhours \| minutes text textminutes binary binminutes \| seconds text textseconds binary binseconds} \| min-ttl minutes \| object {max-size maxsize \| url-validation enable} \| persistent-connections {all \| client-only \| server-only} \| proxy {incoming port \| outgoing host {hostname \| ipaddress} port} \| reval-each-request {all \| none \| text}}	Configures HTTP-related parameters.
https	https {incoming port \| outgoing {host hostname \| address} port}	Configures HTTPS-related parameters.
icp	icp {client {{add-remote-server {hostname \| ipaddress} {parent \| sibling} icp-port icpport http-port httpport [restrict domainnames]} \| enable \| exclude domainnames \| max-fail retries \| max-wait timeout \| modify-remote-server {hostname \| ipaddress} {http-port port \| icp-port port \| parent \| restrict domainnames \| sibling}} \| server {enable \| port icpport \| remote-client {hostname \| ipaddress} {fetch \| no-fetch}}}	Configures Internet Cache Protocol parameters.
interface	interface {FastEthernet slot/port [autosense \| bandwidth linespeed \| fullduplex \| halfduplex \| ip address ipaddress netmask \| shutdown] \| GigabitEthernet slot/port [autosense \| bandwidth linespeed \| fullduplex \| halfduplex \| ip address ipaddress netmask \| shutdown]}	Configures a Fast Ethernet or Gigabit Ethernet interface.
ip	ip {default-gateway ipaddress \| domain-name domainname \| name-server ipaddress \| route destaddrs netmask gateway}	Internet Protocol configuration commands.
logging	logging {console {enable \| priority loglevels} \| disk {enable \| filename filename \| priority loglevels \| recycle size}\| facility facility \| host {ip-address \| priority loglevels}	Configures system logging (syslog).
no	no command	Negates a command or sets its defaults.
ntp	ntp server {hostname \| ip-address}	Configures Network Time Protocol (NTP).
proxy-protocols	proxy-protocols {outgoing-proxy exclude domain \| transparent {default-server \| original-proxy}}	Configures proxy protocols-related parameters.
snmp-server community	snmp-server community string	Enables SNMP; sets community string.
snmp-server contact	snmp-server contact line	Text for MIB object sysContact.
snmp-server enable	snmp-server enable traps [snmp authentication]	Enables SNMP traps.
snmp-server host	snmp-server host {hostname \| ip-address} communitystring	Specifies hosts to receive SNMP traps.
snmp-server location	snmp-server location line	Species path for MIB object sysLocation.
tcp	tcp {client-mss maxsegsize \| client-receive-buffer kbytes \| client-rw-timeout seconds \| client-satellite \| client-send-buffer kbytes \| keepalive-probe-cnt count \| keepalive-probe-interval seconds \| keepalive-timeout seconds \| server-mss maxsegsize \| server-receive-buffer kbytes \| server-rw-timeout seconds \| server-satellite \| server-send-buffer kbytes \| type-of-service enable}	Configures TCP parameters.
terminal	terminal length lines	Sets current terminal line length.
transaction-logs	transaction-logs {archive {interval {every-day {at time \| every hour} \| every-hour {at minute \| every interval}} \| max-file-size filesize} \| enable \| export {enable \| ftp-server {hostname \| servipaddrs} login passw directory} \| file-marker \| sanitize}	Configures transaction logging.
user add	user add username {password [0 \| 1] password} [capability [admin-access]] [uid userid]	Configures new user accounts.
user delete	user delete {username username \| uid userid}	Deletes user accounts.
user modify	user modify {uid number \| username name}{add-capability admin-access \| del-capability admin-access \| password [0 \| 1] password}	Modifies user accounts.
wccp custom-web-cache	wccp custom-web-cache router-list-num num port port [[hash-destination-ip] [hash-destination-port] [hash-source-ip] [hash-source-port] [password passw] [weight percentage]]	Configures custom Web caching service.
wccp flow-redirect	wccp flow-redirect enable	Redirects moved flows.
wccp home-router	wccp home-router ip-address	Specifies WCCP Version 1 home router IP address.
wccp reverse-proxy	wccp reverse-proxy router-list-num number [password key] [weight percentage]	Configures reverse proxy Web caching service.
wccp router-list	wccp router-list number ip-address	Creates a router list for use in WCCP services.
wccp shutdown	wccp shutdown max-wait seconds	Sets the maximum time interval over which the Content Engine will perform a clean shutdown.
wccp slow-start	wccp slow-start enable	Accepts load in slow-start mode.
wccp version	wccp version {1 \| 2}	Specifies WCCP version number.
wccp web-cache	wccp web-cache router-list-num number [password key] [weight percentage]	Configures standard Web caching service.

Interface Configuration Command Summary

The interface configuration Content Engine commands are entered in the interface configuration mode.

The following example demonstrates how to enter the interface configuration mode for a Fast Ethernet port:

Console# config

Console(config)# interface ?

FastEthernet     Select a fast ethernet interface to configure
GigabitEthernet  Select a gigabit ethernet interface to configure 
Console(config)# interface fastethernet ?

<0-3>/  FastEthernet slot/port 
Console(config)# interface fastethernet 0/1

Console(config-if)#
Console(config-if)# ?

Configure Interface commands:
autosense    Interface autosense
  bandwidth    Interface bandwidth
  exit         Exit from this submode
  full-duplex  Interface fullduplex
  half-duplex  Interface halfduplex
  ip           Interface Internet Protocol Config commands
  no           Negate a command or set its defaults
  shutdown     Shutdown the specific interface

To exit the interface configuration mode, enter exit to return to the global configuration mode.

Console(config-if)# exit

Console(config)#

Table 1-5 lists the interface configuration commands.

Table 1-5: Cache Software 3.0.0 Interface Configuration Commands

Interface Command	Syntax	Description
autosense	autosense	Sets current interface to autosense.
bandwidth	bandwidth mbits	Sets current interface linespeed (10, 100, 1000 Mbps).
exit	exit	Exits from interface mode.
fullduplex	fullduplex	Sets current interface to full-duplex mode.
halfduplex	halfduplex	Sets current interface to half-duplex mode.
help	help	Assistance for command-line interface.
ip	ip {address ip-address ip-subnet}	Configures current interface Internet Protocol parameters.
no	no {autosense \| bandwidth \| fullduplex \| halfduplex \| ip \| shutdown}	Negates a command or set its defaults.
shutdown	shutdown	Shuts down the specified interface.

show Command Summary

The Content Engine show commands are entered in the EXEC mode. Table 1-6 lists the show commands.

Table 1-6: Cache Software 3.0.0 show Commands

EXEC Show Command	Syntax	Description
show arp	show arp	Displays ARP entries.
show bypass	show bypass [list] [statistics {auth-traffic \| load}] [summary]	Displays Content Engine bypass configuration.
show cfs	show cfs {statistics \| volumes}	Displays cache file system status.
show clock	show clock [detail]	Displays the system clock.
show debugging	show debugging	Displays the state of each debugging option.
show disk-partitions	show disk-partitions diskname	Displays disk partition information.
show disks	show disks	Displays disk names and SCSI identifiers.
show dns-cache	show dns-cache	Displays DNS cache information.
show flash	show flash	Displays Flash memory information.
show ftp	show ftp	Displays the configuration of the File Transfer Protocol (FTP) on the Content Engine.
show gui-server	show gui-server	Displays the GUI server parameters.
show hardware	show hardware	Displays system hardware configuration.
show hosts	show hosts	Displays IP domain name, name servers, and host table.
show http	show http {age-mult \| all \| anonymizer \| append \| authenticate-strip-ntlm \| cache-authenticated \| cache-cookies \| cache-miss \| cache-on-abort \| object \| persistent-connections \| proxy \| reval-each-request \| ttl}	Displays HTTP-related caching parameters.
show https	show https proxy	Displays HTTPS-related parameters.
show icp	show icp {client \| root \| server}	Displays Internet Cache Protocol (ICP) information.
show interface	show interface {FastEthernet slot/port \| GigabitEthernet slot/port \| scsi number}	Displays hardware interface information.
show ip routes	show ip routes	Displays IP routing table.
show logging	show logging	Displays system logging (syslog) criteria.
show memory	show memory	Displays memory blocks and statistics.
show ntp	show ntp status	Displays the NTP parameters.
show processes	show processes [cpu \| memory]	Displays processes.
show proxy-protocols	show {all \| outgoing-proxy \| transparent}	Displays proxy protocols-related parameters.
show running-config	show running-config	Displays current operating configuration.
show snmp	show snmp	Displays SNMP statistics.
show startup-config	show startup-config	Displays startup configuration.
show statistics	show statistics {bypass [auth-traffic \| load \| summary] \| cfs \| dns-cache \| ftp \| http {ims \| object \| performance \| requests \| savings \| usage} \| https \| icmp \| icp {client \| server} \| ip \| netstat \| routing \| snmp \| tcp \| transaction-logs \| udp}	Displays statistics.
show tcp	show tcp	TCP configuration.
show tech-support	show tech-support [page]	Displays system information for Cisco technical support.
show transaction-logging	show transaction-logging	Displays transaction logging information.
show user	show user username name	Displays user information.
show users	show users	Displays all users.
show version	show version	Displays system version.
show wccp	show wccp {content-engines \| flows {custom-web-cache \| reverse-proxy \| web-cache}[summary] \| routers \| services [detail] \| slowstart {custom-web-cache \| reverse-proxy \| web-cache}\| status}	Displays WCCP information.

Table of Contents

Command-Line Interface