Chapter 1: Command Line Interface Command Summary

Command-Line Interface Command Summary

This chapter provides a summary of the command-line interface (CLI) commands included in the Cisco Global Site Selector 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.

Accessing the CLI

You can access the command-line interface by establishing a remote connection or by connecting directly to the device using a dedicated terminal.

Accessing the CLI Using a Remote Connection

You can establish a remote connection with a Global Site Selector (GSS) using Telnet or Secure Shell (SSH).

In a single Telnet or SSH session, you cannot connect to more than one device; you can have several Telnet or SSH sessions running in parallel for different devices.

SSH connections are strongly recommended because SSH lets you communicate securely over insecure channels and provides strong authentication.

Use your preferred SSH or Telnet client, entering the host name or IP address of the GSS device (Global Site Selector or Global Site Selector Manager) as the host name, and using your GSS administrative username and password to log on to the device through a remote connection.

Once you have logged on, you will be limited in your interaction with the GSS device to the commands described in this document.

Accessing the CLI Using a Serial Connection

Establish a serial connection between your terminal and the GSS device. For information on how to establish a serial connection with your device, refer to the Cisco Global Site Selector 4480 Hardware Installation Guide.

Once you are connected, you can use any terminal communications application to access the CLI. The following procedure uses HyperTerminal.

Step 1 Launch HyperTerminal.

The Connection Description window appears.

Step 2 Enter a name for your session in the Name field.

Step 3 Click OK.

The Connect To window appears.

Step 4 From the drop-down list, choose the COM port to which the device is connected.

Step 5 Click OK.

The Port Properties window appears. Set the port properties as follows:

•Baud Rate = 9600

•Data Bits = 8

•Flow Control = none

•Parity = none

•Stop Bits = 1

Step 6 Click OK to connect.

Step 7 Press Enter to display the command-line interface prompt.

Once a session is created, you can save the connection description by choosing File > Save As. Saving the connection description has the following two advantages:

•The next time you launch HyperTerminal, the session is listed as an option under Start > Programs > Accessories > HyperTerminal > Name_of_session. This option lets you reach the CLI prompt directly without going through the configuration steps.

•You can connect your cable to a different device without configuring a new HyperTerminal session. If you use this option, make sure that you connect to the same port on the new device as was configured in the saved HyperTerminal session. Otherwise, a blank screen appears without a prompt.

Using Command-Line Processing

GSS 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 Combination	Description
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

There are three command modes for the GSS CLI. The three modes are:

•EXEC

•Global configuration

•Interface configuration

EXEC Mode

The two EXEC access levels are 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.

Host> enable

Host#

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:

Host# exit

See the "EXEC Command Summary" section for a summary of EXEC-level commands.

Global Configuration Mode

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

Host# configure

Host(config)#

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

Host(config)# end

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

See the "Global Configuration Command Summary" section for a summary of Global configuration-level commands.

Interface Configuration Mode

To enter interface configuration mode, use the interface global configuration command. The following example demonstrates how to enter interface configuration mode:

Host# config

Host(config)# interface ethernet 0

Host(config-eth0)#

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

Host(config-eth0)# exit

Host(config)#

See the "Interface Configuration Command Summary" section for a summary of interface configuration-level commands.

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, a syntax error occurs in the process of setting the device clock. Context-sensitive help is then used to check the syntax for setting the clock and correct the mistake.

Host#clock 20:06:00 26 march 2002

% Invalid input detected at '^' marker.

Host#clock ?

  set       Set the time and date

  timezone  Set timezone

The help output shows that the set keyword is required. Press the Up Arrow to automatically repeat the previous command entry. Then add a space and question mark (?) to display the additional arguments:

Host#clock set ?

  <0-23>:  Current Time (hh:mm:ss)

Host#clock set 20:00:00

% Incomplete command.

Host#clock set 20:00:00?

<0-59>

Host#clock set 20:00:00 ?

  <1-31>     Day of Month

  april

  august

  december

  february

  january    Month of the Year

  july

  june

  march

may

  november

  october

  september

Host#clock set 20:00:00 march ?

  <1-31>  Day of Month

Host#clock set 20:00:00 march 26 ?

  <1993-2035>  Year

Host#clock set 20:00:00 march 26 2002

Controlling Command Output

You can control the output of your GSS CLI commands—filtering it, or saving it to a file—using special operators that are added to your command syntax. The following table presents information on the various command options that allow you to control the output generated by GSS commands.

Table 1-2 Command-Line Output Processing Syntax Options
Command Line Syntax	Description
\|grep text	Grep operator. When coupled with a CLI command, this operator filters command output to display only output containing words or text that you specify. For example, the following command would list only files containing "log" in a directory: `Host>ls` `platform.cfg` `props.cfg` `props.cfg.startup` `runmode-comment` `running.cfg` `squid` `sysMessages.log` `syslog-messages.log` `sysmsg` `sysout` `system.log` `tmp` `tomcat` `trace.log` `Host>ls \|grep log` `sysMessages.log` `syslog-messages.log` `system.log` `trace.log`
>	Redirect operator. When coupled with a CLI command, this operator saves command output to a file, for example: `Host# show processes >output`

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 (?).

Host# cl?

clear clock

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

Host# 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:

Host# copy running-config startup-config

Host# 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 GSS software EXEC commands are entered in EXEC mode. Table 1-3 lists the user-level EXEC commands. Table 1-4 lists the privileged-level EXEC commands.

Table 1-3 GSS Software User-Level EXEC Commands
User EXEC Command	Syntax	Description
cd	cd directoryname	Changes the current directory.
dir	dir [directory]	Displays files in long list format.
dnslookup	dnslookup {hostname \| domainname}	Resolves host name (DNS).
enable	enable	Accesses privileged EXEC commands.
end	end	Terminates the console or Telnet session.
exit	exit	Exits from terminal session.
ftp	ftp enable	Enables or disables FTP, or opens an FTP session.
help	help	Provides assistance for command line-interface.
lls	lls [directory]	Displays directory files in long list format.
ls	ls [directory]	Displays files in directory.
ping	ping {hostname \| ip-address}	Sends ICMP echo packets.
pwd	pwd	Displays path name of the present working directory.
scp	scp {source_path [source_filename] user@target:target_path} scp {user@source:/source_path [source_filename] target_path}	Securely copies files from or to a location.
tail	tail filename	Displays the last 10 lines of the named file.
telnet	telnet [enable] [hostname \| ip-address]	Opens a Telnet session.
type	type filename	Displays the contents of a file on the console.
?	?	Generates a list of user EXEC commands.

Table 1-4 GSS Software Privileged-Level EXEC Commands
Privileged EXEC Command	Syntax	Description
clear	clear statistics {boomerang \| dns \| keepalive {all \| cra \| http-head \| icmp \| kalap \| ns}}	Resets statistics for the named subsystem, for example: kale for keepalive engine.
clock	clock {set hh:mm:ss MONTH DD YYYY \| timezone timezonename}	Sets the device time or time zone.
configure	configure	Places the CLI session in configuration mode.
copy	copy {disk startup-config filename \| startup-config disk filename \| running-config [disk filename \| startup-config]}	Copies one of the following: •File from disk to the startup-config. •Startup configuration to a file on disk. •Running configuration to a file on disk. •Technical support information to a file on disk.
del	del filename	Deletes the named file.
disable	disable	Turns off privileged EXEC commands.
enable	enable	Accesses privileged EXEC commands.
exit	exit	Exits from the EXEC and configuration command levels to user level.
gss	gss {enable {gssm-primary \| gssm-standby {primary GSSM_hostname \| primary GSSM_IP_address} \| gss {primary GSSM_hostname \| primary GSSM_IP_address}} \| restart \| start \| status \| stop \| tech-report filename}	Manages your GSS devices.
gssm	gssm {backup {database filename \| full filename}\| database {create \| delete \| invalidate \| maintain \| purge-log-records {count number_records \| days number_days} \| report \| status \| validate}\| primary-to-standby \| restore filename \| standby-to-primary}	Manages your Global Site Selector Manager and its embedded database.
install	install filename	Installs a new version of the GSS software.
lsof	lsof	Lists open files.
reload	reload	Halts and performs a cold restart.
restore-factory-defaults	restore-factory-defaults	Sets the GSS configuration to the factory-default state.
rotate-logs	rotate-logs	Forces the GSS to rotate log files.
scp	scp {source_path [source_filename] user@target_host:target_path \| user@source_host:/source_path [source_filename] target_path}	Securely copies files from or to a location.
show	show {access-group \| access-list \| clock \| ftp \| interface {eth0 \| eth1} \| ip routes \| logging \| logs {follow \| tail} \| memory \| ntp \| processes \| properties \| running-config \| ssh \| startup-config \| statistics {boomerang {domain domain_name \| global } \| dns {answer-group {list \| group_name [verbose]} \| domain {list \| domain_name [verbose]}\| domain-group {list \| domain_group_name [verbose]}\| global \| rule {list \| rule_name [verbose]}\| source-address-group {list \| source-address_group_name [verbose]}} \| keepalive {all \| cra {IP_address \| list}\| global \| http-head {IP_address \| list} \| icmp {IP_address \| list} \| kalap {IP_address \| list} \| ns {IP_address \| list}}}\| system-status \| tech-support \| telnet \| terminal-length \| uptime \| user username \| users \| version}	Displays configuration information and system properties for your GSS device and its components, as well as global server load-balancing resources.
shutdown	shutdown	Shuts down the operating system.
tcpdump	tcpdump {eth0 \| eth1}	Outputs all traffic to and from a particular GSS interface
telnet	telnet {hostname \| ip-address}	Opens a Telnet session.
type	type filename	Displays the contents of a file.
write	write memory	Copies the running configuration as the new startup configuration.

Global Configuration Command Summary

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

Table 1-5 GSS Software Global Configuration Commands
Global Configuration Command	Syntax	Description
access-group	access-group name interface {eth0 \| eth1}	Assigns an access list to a GSS network interface.
access-list	access-list name {permit \| deny} protocol [source-address source-netmask \| host source-address \| any] operator port [port] [destination-port operator port [port]]	Configures access lists on the GSS.
end	end	Exits configuration and privileged EXEC modes.
exec-timeout	exec-timeout minutes	Configures the length of time that an inactive Telnet session remains open.
exit	exit	Exits configuration and privileged EXEC modes.
ftp	ftp enable	Enables or disables FTP on the GSS device, or opens an FTP session with a remote host device.
help	help	Provides assistance for the command-line interface.
hostname	hostname name	Configures the system's network name.
interface	interface Ethernet {0 \| 1}{autosense \| bandwidth mbits \| fullduplex \| halfduplex \| ip address {ip-address netmask} \| no \| gss-communications \| shutdown}	Configures the Ethernet interface on the GSS device.
ip	ip {default-gateway ip-address \| domain-name name \| name-server ip-addresses \| route destination_address netmask gateway}	Configures the Internet Protocol.
logging	logging {disk {enable \| priority loglevel \| subsystem name priority loglevel} \| host {enable \| ip ip_addresses\| priority loglevel \| subsystem name priority loglevel}}	Configures system logging (syslog).
no	no {access-group \| access-list \| copy \| exec-timeout \| ftp \| help \| hostname \| interface \| ip \| logging \| ntp-server \| property \| show \| ssh \| telnet \| terminal-length \| username \| write}	Undoes a global configuration command or sets its defaults.
ntp	ntp {server {hostname \| ip-address} \| enable}	Configures the Network Time Protocol (NTP).
property	property set property_name property_value	Enables, disables, or modifies one of a variety of GSS system configuration options. Use this command only under the direct supervision of Cisco Technical Support.
snmp	snmp enable	Enables or disables Simple Network Management Protocol (SNMP) on your GSS device.
ssh	ssh enable	Configures SSH service parameters.
telnet	telnet [enable] [hostname \| ip-address]	Enables or disables Telnet or opens a new Telnet session.
terminal	terminal length number	Sets the number of rows displayed on a terminal, between 0 (meaning no pauses in screen output) and 512.
username	username name {password word privilege {user \| admin} \| delete}	Creates or removes a user account.
write	write memory	Copies the running configuration as the new startup configuration.

Interface Configuration Command Summary

The interface configuration commands are entered in the interface configuration mode. Enable interface configuration mode by entering the interface command in global configuration mode.

For example:

Host# config

Host(config)# interface

Host(config-if)# autosense

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

Host(config-if)# exit

Host(config)#

Table 1-6 lists the interface configuration commands.

Table 1-6 GSS Software Interface Configuration Commands
Interface Command	Syntax	Description
autosense	autosense	Sets current interface to autosense.
bandwidth	bandwidth mbits	Sets specified interface line speed (10, 100 Mbps).
exit	exit	Exits from interface mode.
fullduplex	fullduplex	Sets current interface to full-duplex mode.
gss-communications	gss-communications	Configures the interface for communication between GSS devices.
gss-tcp-keepalives	gss-tcp-keepalives	Configures the interface for use receiving TCP keepalive information.
halfduplex	halfduplex	Sets current interface to half-duplex mode.
ip address	ip address ip-address ip-subnet	Configures the Internet Protocol parameters for the specified interface.
no	no {autosense \| bandwidth \| fullduplex \| gss-communications \| gss-tcp-keepalives \| halfduplex \| ip \| show \| shutdown }	Negates a command or sets its defaults.
shutdown	shutdown	Shuts down the specified interface.

Table Of Contents