cc/td/doc/product/webscale/webcache/ce23
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Command-Line Interfaces

Command-Line Interfaces

This chapter provides a summary of the commands included in Cisco Cache software Release 2.3.0 for the Cisco Content Engines and Cisco Cache Engines. The command summary tables are grouped alphabetically in five categories: user level (EXEC) commands, privileged level (EXEC) commands, interface configuration commands, global configuration commands, and show (EXEC) commands. To simplify terminology, both the Cache Engine and the Content Engine are referred to as the "CE."

EXEC Mode

To execute a command, enter the command at the EXEC system prompt and press the Return key.

There are two EXEC prompt 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 (#). 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

ip

no

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 set 1222 ^ %Invalid input detected at `^' marker. Console# clock ? set Set the time and date Console# clock

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

Console# clock set ? hh:mm:ss Current time Console# clock set

Enter the current time:

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 reveal the additional arguments:

Console# clock set 13:32:00 ? <1-31> Day of the month January Month of the year

Now you can complete the command entry:

Console# clock set 13:32:00 23 February 97 ^ %Invalid input detected at '^' marker.

The caret symbol (^) and help response indicate an error at 97. To list the correct syntax, enter the command up to the point where the error occurred and then enter a question mark (?):

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

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

Console# clock set 13:32:00 23 February 1997

System Help

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

    Console# cl? clear clock
    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 Configuration 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

or

Console# write

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

EXEC Commands

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


Table 1-1: Cache Software 2.3.0 User Level EXEC Commands
User EXEC Commands Syntax Description

cd

cd {directoryname}

Changes directory

cpfile

cpfile oldfilename newfilename

Copies dosfs files

del

del filename

Removes file

deltree

deltree directory

Removes directory recursively

dir

dir [directory]

Displays long list files in directory

disable

disable

Turns off privileged EXEC commands

dnslookup

dnslookup {host | domain-name}

Resolves host name (DNS)

enable

enable

Turns on privileged EXEC commands

exit

exit

Exits from the EXEC command line

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

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 name


Table 1-2: Cache Software 2.3.0 Privileged Level EXEC Commands
Privileged EXEC Commands Syntax Description

cache

cache {clear [force] | reset | sync}

Cache commands

cd

cd {directoryname}

Changes directory

cfs

cfs {clear volname [force] | format volname | mount volname | reset volname | sync volname | unmount volname}

Cache file system commands

check

check superuser passwords

Checks whether superuser accounts are password-protected

clear

clear {bypass {all | counters | list} | cache [force] | dns-cache | interface serial number | ldap authcache | logging | statistics {all | authentication | dns-cache | ftp | history | http {all | ims | object | proxy outgoing | requests | response | savings} | https | icp {all | client | cluster | server} | ip | ldap {authcache | server {all | interface | protocol}} | radius-server | rule {action action-type {all | pattern pattern-type | all}} | running | services | tacacs | tcp | transaction-logs | url-filter websense} | transaction-log}

Resets functions

clock

clock {clear | save | set hh:mm:ss day month year}

Sets system clock

configure

configure

Enters global configuration mode

copy

copy {disk {flash imagename | startup-config filename} | flash {disk imagename} | running-config {disk filename | startup-config | tftp}| startup-config {disk filename | tftp} | tech-support {disk filename | tftp} | tftp {disk | flash}}

Copies configuration or image data

cpfile

cpfile oldfilename newfilename

Copies dosfs files

debug

debug

Debugging functions

del

del filename

Removes file

deltree

deltree directory

Removes directory recursively

dir

dir [directory]

Displays long list files in directory

disable

disable

Turns off privileged EXEC commands

disk

disk {erase-all-partitions devname | manufacture devname | partition devname | prepare devname}

Disk management commands

dnslookup

dnslookup {host | domain-name}

Resolves host name (DNS)

dosfs

dosfs {check volname [force | verbose [force]] | format volname | label volname vol-label | mount volname {rdonly | rdwr} | repair {automatic | interactive} volname [force | verbose [force]] | sync syncdevice | unmount volname}

DOS file system commands

enable

enable

Turns on privileged EXEC commands

exit

exit

Exits from the EXEC command line

help

help

Assistance for command line-interface

install

install paxfilename

Installs a new version of the system software

lls

lls [directory]

Displays directory files in long list format

ls

ls [directory]

Displays files in directory

mfs

mfs {clear [force] | mount [size [objects]] | sync | unmount}

Memory file system commands

mkdir

mkdir directory

Makes directory

mkfile

mkfile filename

Makes file (for testing)

no debug

Disables debugging functions

ntpdate

ntpdate {hostname | ip-address}

Sets the Network Time Protocol (NTP) server name

ping

ping {hostname | ip-address}

Sends echo packets

pwd

pwd

Present working directory

reload

reload

Halts and performs a cold restart

rename

rename sourcefile destinationfile

Renames a file (pathname)

rmdir

rmdir directory

Removes directory

tclsh

The tclsh command is for Cisco Systems internal use only.

Shell for TCL

terminal

terminal monitor

Current terminal commands

transaction-log

transaction-log force {archive | export}

Transaction-logging commands

type

type filename

Displays 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 Commands

The Cache Software global configuration commands are entered in global configuration mode. The global configuration commands are listed in Table 1-3.


Table 1-3: Cache Software Release 2.3.0 Global Configuration Commands
Global Configuration Command Syntax Description

authentication

authentication {configuration {local enable | tacacs enable [primary]} | login {local enable | tacacs enable [primary]}}

Configures authentication

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

clock timezone

clock timezone {zone hours} [minutes]

Configures time-of-day clock

cron

cron {del-tab entryid | file tabfile | save-tab | tab-entry tabentry}

cron commands

dns-cache

dns-cache size maxsize

Configures DNS cache

end

end

Exits configuration mode

error-handling

error-handling {reset-connection | send-cache-error | transparent}

Customizes how CE should handle errors

exception

exception debug

Exception handling

exec-timeout

exec-timeout timeout

Configures Exec mode timeout interval

exit

exit

Exits configuration mode

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-related parameters

gui-server

gui-server {enable | port port}

Configures GUI server

help

help

Assistance for command-line interface

hostname

hostname name

Configures the CE network name

http

http {age-multiplier {text texttime binary bintime} | append {ldap-proxy-auth-header {hostname | ipaddress}| 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} | cluster max-delay delayseconds misses totalmisses | l4-switch enable | 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 {enable | max-idle connections | timeout secs [max-idle connections]} | proxy {incoming port | outgoing {host {hostname | ipaddress} port [primary]} | monitor seconds | origin-server} | reval-each-request {all | none | text} | serve-ims text textpercentage binary binpercentage}

Configures HTTP-related parameters

https

https {destination-port {allow {port | all} | deny {port | all}} | proxy {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 | http-port httpport | port icpport | remote-client {hostname | ipaddress} {fetch | no-fetch}}}

Configures Internet Cache Protocol parameters

inetd

inetd {enable service}

Configures inetd

interface

interface ethernet number

Configures an Ethernet or SCSI interface

ip

ip {default-gateway ipaddress | domain-name domainname | name-server ipaddress | route destaddrs netmask gateway}

Internet Protocol configuration commands

ldap

ldap {authcache {auth-timeout minutes | max-entries entries} | client auth-header {401 | 407} | server {allow-mode | base baseword | filter filterword | host {hostname | hostipaddress} port portnumber | retransmit retries | timeout seconds | user-id-attribute useidword}}

Configures LDAP

logging

logging{{hostname | ip-address} | console loglevels | disk filename loglevels | event-export events loglevels facility | facility facility | on | recycle size | trap loglevels}

Configures system logging (syslog)

no

no command

Negates a global configuration command or sets its defaults

ntp

ntp server {hostname | ip-address}

Configures Network Time Protocol (NTP)

proxy-protocols

proxy-protocols {outgoing-proxy exclude {domains-only | enable | list word} | transparent {default-server | original-proxy}}

Configures proxy protocols-related parameters

radius-server

radius {auth-timeout value | exclude {enable | list domainlist} | host {hostname | hostipaddr} [auth-port port] | key keyword | retransmit retries | timeout seconds}

Configures RADIUS authentication

rule

rule {block options | enable | no-auth options | no-cache options | no-proxy options | refresh options | selective-cache options | use-proxy options}

Configures rules

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 traps

snmp-server enable traps
[snmp authentication]

Enables SNMP traps

snmp-server host

snmp-server host {hostname | ip-address} communitystring

Specifies SNMP trap host

snmp-server location

snmp-server location line

Text for MIB object sysLocation

tacacs

tacacs {key keyword | retransmit retries | server {hostname | ipaddress} [primary] | timeout seconds}

Configures TACACS authentication

tcp

tcp {client-mss maxsegsize | client-receive-buffer kbytes | client-rw-timeout seconds | client-satellite | client-send-buffer kbytes | cwnd-base factor | init-ssthresh value | keepalive-probe-cnt count | keepalive-probe-interval seconds | keepalive-timeout seconds | listen-queue length | server-mss maxsegsize | server-receive-buffer kbytes | server-rw-timeout seconds | server-satellite | server-send-buffer kbytes}

Configures TCP parameters

terminal

terminal length lines

Current terminal commands

tftp-server

tftp-server dir directory

Configures TFTP server

transaction-logs

transaction-logs {archive {files maxnumfiles | interval {seconds | every-day {at time | every hour} | every-hour {at minute | every interval} | every-week [on days [at time]]} | enable | export {enable | ftp-server {hostname | servipaddrs} login passw directory} | interval {minutes | every-day {at time | every hour} | every-hour {at minute | every interval} | every-week [on days [at time]]}}} | file-marker | sanitize}

Configures transaction logging

trusted-host

trusted-host {hostname | ip-address | domain-lookup}

Configures a trusted host

url-filter

url-filter {bad-sites-block [custom-message] | good-sites-allow [custom-message] | websense {allowmode enable | server {hostname | ipaddrs} [port port] [timeout seconds]}}

Configures URL filtering

user add

user add username [password [ 0 | 1] password] [capability [admin-access | ftp-access | http-access | telnet-access]] [uid userid]

Adds 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 | ftp-access | http-access | telnet-access]] | [del-capability [admin-access | ftp-access | http-access | telnet-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] [l2-redirect] [password passw] [weight percentage]]

Custom Web caching service

wccp flow-redirect

wccp flow-redirect enable

Redirects moved flows

wccp home-router

wccp home-router ip-address

WCCP Version 1 home router IP address

wccp port-list

wccp port-list listnum portnum

Port list for use in WCCP services

wccp reverse-proxy

wccp reverse-proxy router-list-num number [l2-redirect] [password key] [weight percentage]

Reverse proxy Web caching service

wccp router-list

wccp router-list number ip-address

Router list for use in WCCP services

wccp service-number

wccp service-number servnumber router-list-number routnumber port-list-number plistnumber [hash-destination-ip] [hash-destination-port] [hash-source-ip] [hash-source-port] [l2-redirect] [password passw] [weight percentage]

WCCP Version 2 service number

wccp shutdown

wccp shutdown max-wait seconds

WCCP shutdown parameter

wccp slow-start

wccp slow-start enable

Accepts load in slow-start mode

wccp version

wccp version {1 | 2}

WCCP version number

wccp web-cache

wccp web-cache router-list-num number [l2-redirect] [password key] [weight percentage]

Standard Web caching service

Interface Configuration Commands

The Cache Software interface configuration commands are entered in interface configuration mode.

To enter interface configuration mode, enter the following commands:

Console# config Console(config)# interface ? ethernet Select an ethernet interface to configure Console(config)# interface ethernet 0 Console(config-if)# ? Configure Interface commands: autosense Interface autosense bandwidth Interface speed exit Exit from interface mode fullduplex Interface fullduplex halfduplex Interface halfduplex ip Interface Internet Protocol Config commands no Negate a command or set its defaults

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

Console(config-if)# exit Console(config)#

Interface configuration commands are listed in Table 1-4.


Table 1-4: Cache Software Release 2.3.0 Interface Configuration Commands
Interface Command Syntax Description

autosense

autosense

Enables autosense on an interface

bandwidth

bandwidth mbits

Interface speed

exit

exit

Exits from interface mode

fullduplex

fullduplex

Interface full-duplex mode

halfduplex

halfduplex

Interface half-duplex mode

ip

ip {address ip-address ip-subnet | broadcast-address ip-address}

Interface Internet Protocol configuration commands

no

no {autosense | bandwidth | fullduplex | halfduplex | ip}

Negates a command or sets its defaults

show Commands

The Cache software show commands are entered in the EXEC mode. The show commands are listed in Table 1-5.


Table 1-5: Cache Software Release 2.3.0 show Commands
EXEC show Command Syntax Description

show arp

show arp

Displays ARP entries

show authentication

show authentication

Displays authentication information

show bypass

show bypass [list] [statistics {auth-traffic | load}] [summary]

Displays bypass configuration

show cfs

show cfs {statistics | volumes}

Displays cache file system information

show clock

show clock [detail]

Displays the system clock

show cron

show cron

Displays cron information

show debugging

show debugging

Displays the state of each debugging option

show disk-partitions

show disk-partitions devname

Displays disk partitions

show disks

show disks

Displays disk names

show dns-cache

show dns-cache

Displays DNS cache information

show events

show events number {all | critical | notice | warning}

Displays system events

show file-descriptors

show file-descriptors

Displays file descriptors

show flash

show flash

Displays Flash memory content

show ftp

show ftp

Displays FTP caching parameters

show gui-server

show gui-server

Displays GUI server parameters

show hardware

show hardware

Displays system hardware status

show hosts

show hosts

Displays IP domain name, name servers, and host table

show http

show http {age-mult | all | append | authenticate-strip-ntlm | cache-authenticated | cache-cookies | cache-miss | cache-on-abort | cluster | object | persistent-connections | proxy | reval-each-request | serve-ims | ttl}

Displays HTTP-related caching parameters

show https

show https {all | destination-port | proxy}

Displays HTTPS-related parameters

show icp

show icp {client | root | server}

Displays Internet Cache Protocol (ICP) information

show inetd

show inetd

Displays the inetd daemon activity information

show interface

show interface {ethernet number | scsi number}

Displays hardware interface information

show ip routes

show ip routes

Displays IP routing table

show ldap

show ldap {authcache | server}

Displays LDAP information

show logging

show logging

Displays system logging (syslog)

show memory

show memory [free]

Displays memory blocks and statistics

show mfs statistics

shows mfs statistics

Displays memory file system 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 radius-server

show radius-server

Displays RADIUS information

show rule

show rule {action {action-type {all | pattern pattern-type}} | all}

Displays access control (rules) information

show running-config

show running-config

Displays current operating configuration

show services

show services {ports port_number | summary}

Displays services information

show snmp

show snmp

Displays SNMP statistics

show stacktrace

show stacktrace {task-ID | exception}

Displays task stack trace

show startup-config

show startup-config

Displays startup configuration

show statistics

show statistics {authentication | bypass [auth-traffic | load | summary] | cfs | dns-cache | ftp | http {ims | object | performance | proxy outgoing | requests | savings | usage} | https | icmp | icp {client | cluster | server} | ip | ldap {authcache | server {interface | protocol} | mbuf | netstat | radius-server | routing | rule {action {action-type {all | pattern pattern-type}} | all} | services | tcp | tacacs | transaction-logs | udp | url-filter websense}

Displays statistics

show tacacs

show tacacs

Displays TACACS configuration information

show tcp

show tcp

Displays TCP configuration information

show tech-support

show tech-support [page]

Displays system information for Cisco technical support

show tftp-server

show tftp-server

Displays TFTP server configuration

show transaction-logging

show transaction-logging [entries number]

Displays transaction logging information

show trusted-hosts

show trusted-hosts

Displays system hardware and software status

show url-filter

show url-filter [statistics websense]

Displays URL filter information

show user

show user {uid number | username name}

Displays information for a particular user

show users

show users

Displays all users

show version

show version

Displays system version

show wccp

show wccp {cache-engines | flows {custom-web-cache | reverse-proxy | web-cache} routers | services | slowstart {custom-web-cache | reverse-proxy | web-cache}| status}

Displays WCCP information


hometocprevnextglossaryfeedbacksearchhelp
Posted: Tue Jun 5 21:58:48 PDT 2001
All contents are Copyright © 1992--2001 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.