Command Line Reference

4.1 Introduction
4.1 Command Syntax Conventions
4.2 help
4.3 ping
4.4 quit/exit
4.5 reboot
4.6 set errors
4.7 set interface
4.8 set nvram
4.9 set password
4.10 set prompt
4.11 set rip
4.12 set route
4.13 set serial
4.14 set telnet
4.15 set timeout
4.16 set tftp
4.17 show
4.18 stats
4.19 write

Command Line Reference

4.1 Introduction

This section documents the Cisco Broadband Operating System (CBOS) commands and command arguments that manage and monitor the Cisco 626. It also provides information on: how to use the cpe626 implementation of the CBOS; and the CBOS command syntax.

The CBOS runs in two modes: exec and enable. The table below lists the commands for each mode.

Table 4-1: Cisco Broadband Operating System Commands

Exec Mode	Enable Mode
help/?	help/?
quit/exit	quit/exit
ping	ping
reboot	reboot
show	show
enable	exec
stats	stats
	set
	write

4.1 Command Syntax Conventions

The list below defines all syntax conventions used in this chapter. Syntax examples are presented below the list.

Vertical bars ( | ) separate alternative, mutually exclusive elements. You choose one but not all of the elements separated by a vertical bar.
Square brackets ( [...] ) indicate optional elements. You can choose one, all, or none of the elements enclosed within the square brackets.
Braces ( {...} ) indicate a required choice. You must choose exactly one of the elements enclosed within the braces.
Braces within square brackets ( [{...}] ) indicate a required choice within an optional element. If the option is chosen, you must choose one of the elements enclosed within the braces.
Square brackets within braces ( {[...]} ) indicate an optional choice within a required element. If the required element is chosen, you can choose one, all, or none of the optional elements enclosed within the square brackets.
Boldface indicates commands and keywords that you enter literally as shown.
Italics indicate argument variables that require a value.
Arguments are also shown as: <argument-variable>.

Some syntax examples are:

Example: offset-list {in | out} offset

Definition: The command offset-list is entered literally as shown. Mandatory command options (keywords) are shown as {in | out}; where you must enter either the in or out keyword exactly as shown. The variable (requiring a value to be entered in place of the word) is shown as offset.

Example: set bridging {rfc1483 | management | ppp} enabled | disabled

Definition: The command set bridgingis to be entered literally as shown. Mandatory keywords are shown as {rfc1483 | management | ppp}; where you have to specify bridging mode in either rfc1483 mode, management mode, or ppp mode, choosing only one. Mandatory keywords are shown as enabled | disabled in boldface. You must enter either enable or disable as part of the command string.

4.2 help

To get help on a particular command:

help command-name

You can also do:

? command-name

Syntax Description

command-name

Specifies the precise command.

Command Mode

Exec and Enable

Example

cpe626# help stats

cpe626# ? stats

4.3 ping

To send one or more echo ICMP (Internet Control Message Protocol) request message(s) to another host for a reply:

ping ip-address [-t | -n number] [-w seconds] [-i ]

Syntax Description

ip-address	Specifies the destination IP address to be pinged.
-i	Specifies the Time to Live.
-n number	Specifies the number of pings to send to host.
-t	Specifies to ping host IP continuously until the user interrupts. On a PC, press the Control-C sequence to stop the ping command.
-w	Specifies the amount of time (in seconds) to wait for response.

Command Mode

Exec and Enable

Example

The following example pings IP address 208.203.234.26 three times.

cpe626# ping 208.203.234.26 -n 3

The following example pings IP address 208.203.234.26 infinitely allowing for a 3 second wait response until the command string times itself out.

cpe626# ping 208.203.234.26 -t -w 3

4.4 quit/exit

To quit or exit the CBOS:

quit | exit

Syntax Description

This command has no keywords or arguments.

Command Mode

Exec and Enable

Example

The following examples quit the CBOS.

cpe626# quit
cpe626# exit

4.5 reboot

To reboot the CBOS:

reboot

Syntax Description

This command has no keywords or arguments.

Command Mode

Exec and Enable

Example

The following example reboots CBOS.

cpe626# reboot

4.6 set errors

To implement the set errors command:

set errors {client | debug {enabled | disabled} | module { all | atm | ip | none | telnet } | clear }

Syntax Description

client	Enables the system on which this command is running to display all errors.
clear	Clears all errors from the error log.
debug	Enables error debug mode.
module	Specifies which module on which to track all errors.
all	Selects all modules for error reporting; excluding packet-dumping modules.
atm	Reports errors only for the ATM module.
ip	Reports errors only for the IP module.
none	Disables error reporting for all modules.
telnet	Reports errors only for the telnet module.

Command Mode

Enable

Example

The following example clears errors.

cpe626# set errors clear

The following example sets error reporting for all modules in your system.

cpe626# set errors module all

The following example sets error reporting to be displayed on the current client.

cpe626# set errors client enable

4.7 set interface

To set the interface:

set interface {atm0 | atm1}

Syntax Description

atm0	Sets the interface to be atm0.
atm1	Sets the interface to be atm1.

Command Mode

Enable

Example

The following example sets the interface to be atm0:

cpe626# set interface atm0

4.8 set nvram

To configure NVRAM settings.

set nvramcpe626# erase | addparameter | del parameter}

Syntax Description

erase	Erases current configuration.
add parameter	Adds parameter manually to NVRAM.
del parameter	Removes parameter manually from NVRAM.

Command Mode

Enable

Example

The following example erases NVRAM.

cpe626# set nvram erase

4.9 set password

To set the password:

set password { [ mode | clear ] [ new password | mode ] }

Note Passwords are limited to 16 characters or less.

Syntax Description

mode	Defines either the enable of exec mode.
new password	Defines the new password for a specified mode.
clear	Clears the password for a specified mode.

Command Mode

Enable

Example

The following example sets a new password for the enable mode:

cpe626# set password 55MyPass22 enable

The following example clears the password for the enable mode:

cpe626# set password enable clear

4.10 set prompt

To change the command line prompt:

set prompt new-prompt-name

Syntax Description

new-prompt-name

Specifies the new name of the command line prompt.

Command Mode

Enable

Example

The following example resets the CBOS prompt.

cpe626# set prompt cisco626

4.11 set rip

The set rip command automatically adds routes to your stream. To configure Routing Information Protocol (RIP) settings:

set rip enabled disabled atmX aging value < 65000 {disabled | enabled} deltimeouted timeout-value {disabled | enabled} garbage value < 65000 {disabled | enabled} update value < 65000 {disabled | enabled}

Syntax Description

enabled	Enables the set rip command.
disabled	Disables the set rip command.
atmX	Defines RIP for the atm interface; where the atm interface is either atm0 or atm1.
deltimedout timeout-value	Delete RIP2 time-outed entries. Expressed in seconds.
aging value	Route aging timeout value (default is 180 seconds).
garbage value	Route garbage collection timeout value (default is 120 seconds).
update value	Update time interval (default is 30 seconds).

Command Mode

Enable

Example

The following example sets rip for the atm1 interface:.

cpe626# set rip atm1 enabled

The following example sets route aging timeout value for the atm1 interface:

cpe626# set rip aging 2500 atm1 enabled

The following example sets the time interval update value for the atm0 interface:.

cpe626# set rip update 25 atm0 enabled

4.12 set route

To build a routing table by manually adding or deleting entries in a routing table.

set route default ip-address | delete ip-address | add [{ip address | gw address} |
mask netmask | metric hops]

Syntax Description

default ip-address	Sets a default route using an actual IP address..
delete ip-address	Deletes an existing route using an actual IP address.
add	Adds a new route.
ip address	Specifies the IP address of the host you are trying to reach. The IP host address is specified by the keyword argument variable, address.
gw address	Specifies the IP address of an external gateway. Data is sent through the external gateway to the destination address. Therefore, this address must be the address of a gateway physically linked to your network. The gateway address is specified by the keyword argument variable, address.
mask netmask	Specifies the netmask of the host you are trying to reach.
metric hops	Specifies the distance in hops between the destination address and the gateway. The default value is 1.This value is required when you add a route.

Command Mode

Enable

Examples

The following example shows how to add a route without specifying a netmask or metric.

cpe626# set route add ip 192.9.9.1 gateway 192.168.10.250

The following example shows how to delete a route.

cpe626# set route delete 192.168.10.1

The following example shows how to add a route specifying a netmask and a gateway.

cpe626# set route add ip 192.10.10.0 mask 255.255.255.0 
gateway 208.203.245.228

The following example shows how to add a default route.

cpe626# set route default 208.203.245.228

The following example shows how to add a route add a route specifying a netmask, gateway and a metric.

cpe626# set route add ip 192.10.10.0 mask 255.255.255.0 
gateway 208.203.245.228 metric 1

Note Press Enter only after entering all command parameters. Command examples appear on two lines for readability.

4.13 set serial

To configure serial port settings.

set serial timeout timeout-value more lines-number

Syntax Description

timeout timeout-value	Sets the value in seconds to disconnect the serial connection. The value must be less than or equal to 65334.
more lines-number	Sets the number of lines for the more output. Enter a numeric value of `0' to disable this command.

Command Mode

Enable

Example

The following example set the timeout value for the serial port.

cpe626# set serial timeout 50000

4.14 set telnet

To configure the telnet daemon settings.

set telnet remoteip-address | timeout# | portudp-port-number

Syntax Description

remote ip-address	Specifies the IP address for the remote location running the Telnet server.
timeout #	Specifies the timeout value, in seconds, for a Telnet connection.
port udp-port-number	Specifies the Telnet port number.

Command Mode

Enable

Example

The following example sets the remote address for the Telnet application.

cpe626# set telnet remote 1.1.1.1

The following example sets the number of seconds for the Telnet connection to timeout.

cpe626# set telnet timeout 300

4.15 set timeout

To configure timeout settings.

set timeout idle seconds sessionseconds resetseconds

Syntax Description

idle seconds	Enter number of seconds to disconnect after idle.
session seconds	Enter number of seconds to disconnect after session uptime.
reset seconds	Enter number of seconds to wait to reopen connection.

Command Mode

Enable

Example

The following example sets the timeout values for the idle and session timeouts.

cpe626# set timeout idle 60 session 60 reset 60

4.16 set tftp

To configure the TFTP settings.

set tftp remoteip-address | timeout# | portudp-port-number

Syntax Description

remote ip-address	Specifies the IP address for the remote location running the TFTP server.
timeout #	Specifies the timeout value in seconds for a TFTP connection.
port udp-port-number	Specifies the TFTP port number.

Command Mode

Enable

Example

The following example sets the remote address for the TFTP application.

cpe626# set tftp remote 198.162.58.23

4.17 show

To display statistics on a particular application or interface.

show arp | errors | interface [atm0 | atm1] | nvram | nvram# | rarp | rip {status | atm0 | atm1}| running | running# | serial | telnet | tftp | timeout | uptime | version

Syntax Description

arp	Displays ARP Table.
errors	Displays list of errors that have occurred.
interface	Displays all physical and/or logical interface settings.
nvram	Displays the configuration file located in NVRAM.
nvram#	Displays the written configuration file in NVRAM without any comments you may have entered in the configuration file.
rarp	Displays RARP Table.
rip {status \| atm0 \| atm1}	Displays RIP settings and status on specified interfaces.
running	Displays configuration settings that are currently running, but not saved to NVRAM through the write command.
running#	Displays configuration settings that are currently running without comments, but not saved to NVRAM through the write command.
serial	Displays serial port setting.
telnet	Displays telnet daemon settings.
tftp	Displays tftp settings.
timeout	Displays Idle and Session timeout settings.
uptime	Displays uptime.
version	Displays the CBOS version number and release information.

Command Mode

Exec and Enable

Examples

The following example displays an application's configuration settings.

cpe626# show nvram
cpe626# show nvram#

The following example displays the port setting for atm0.

cpe626# show interface atm0

The following example displays the IP address and subnet mask settings for both ports (atm0 and atm1).

cpe626# show interface

The following example displays the status of all rip settings.

cpe626# show rip status

cpe626#

cpe626# show rip atm0

4.18 stats

To show operating statistics.

stats ip [general | rip | atm0 | atm1] | atm0 | atm1 | telnet | tftp | serial

Syntax Description

ip	Displays IP statistics.You must enter the actual IP address as in: `cpe626#`
general	Displays general statistics on the WAN interface.
atm0	Displays RIP statistics on the WAN interface.
atm1	Displays atm1 statistics on the WAN interface.
telnet	Displays statistics on telnet.
tftp	Displays statistics on tftp.
serial	Displays statistics on the serial port.

Command Mode

Exec and Enable

Example

The following command displays the statistics for the atm0 interface:

cpe626# stats ip atm0

4.19 write

To write configuration changes to NVRAM.

write

Syntax Description

This command has no arguments or keywords.

Command Mode

Enable

Example

The following command writes all configuration changes you make to NVRAM.

cpe626# write

Table of Contents