cc/td/doc/product/dsl_prod/c600s/c627
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Command Reference

Command Reference

4.1 Introduction

This chapter describes the Cisco Broadband Operating System (CBOS) commands and command arguments that manage and monitor the Cisco 627 asymmetric digital subscriber line (ADSL) Discrete Multi-Tone (DMT) modem. This chapter also provides information on how to use the Cisco 627 implementation of the CBOS and the CBOS command syntax.

The CBOS runs in two modes: exec and enable. Table 4-1 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.2 Command Syntax Conventions

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

Some syntax examples are:

Example: offset-list {in | out} offset

Definition: The command offset-list is entered 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 nvram {erase | add parameter | del parameter}

Definition: The command set nvram is entered as shown. Mandatory command keywords are shown as {erase | add | del}; where you must enter either the erase, add or del keyword exactly as shown. If you enter add or del you must enter the variable (requiring a value to be entered in place of the word) parameter.

4.3 help

To get information about one or more commands, use the help command:

help command-name

You can also enter:

? command-name

Syntax Description

command-name

(Optional) Specifies the precise command.

Command Mode

Exec and enable

Example
cpe627# help stats

or

cpe627# ? stats

4.4 ping

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

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

Syntax Description

ip-address

Specifies the destination IP address to be pinged.

-i

Specifies the Time to Live (in seconds).

-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 Control-c 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 192.168.234.26 three times:

cpe627# ping 192.168.234.26 -n 3

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

cpe627# ping 192.168.234.26 -t -w 3

4.5 quit/exit

To quit or exit the CBOS, use the quit or exit command:

quit | exit

Syntax Description

This command has no keywords or arguments.

Command Mode

Exec and enable

Example

The following examples quit the CBOS:

cpe627# quit
cpe627# exit

4.6 reboot

To reboot the CBOS, use the reboot command:

reboot

Syntax Description

This command has no keywords or arguments.

Command Mode

Exec and enable

Example

The following example reboots CBOS:

cpe627# reboot

4.7 set errors

To configure error reporting, use 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:

cpe627# set errors clear
 

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

cpe627# set errors module all

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

cpe627# set errors client enable

4.8 set interface

To configure an interface, use the set interface command:

set interface {atm0 | atm1} {address ip-address | disabled | enabled | netmask netmask | retrain | scramble {enabled | disabled} | vci vci-number | vpi vpi-number | overhead-framing mode-number | trellis-coding {enabled | disabled} | splitterless {enabled | disabled}}

Syntax Description

atm0

Sets the interface to be atm0.

atm1

Sets the interface to be atm1.

address ip-address

Specifies the destination IP address for the virtual interface.

enabled

Enables a command or functionality.

disabled

Disables a command or functionality.

netmask netmask

Specifies the netmask address for the virtual interface.

retrain

Retrains the ADSL line.

scramble

Enables or disables ATM cell scrambling.

vci vci-number

Sets the number of the virtual channel identifier.

vpi vpi-number

Sets the number of the virtual path identifier.

overhead-framing

Configures the requested ATM framing structure. A retrain is required to negotiate the new overhead framing mode with the central office equipment.

mode-number

Specifies the overhead framing mode. The Cisco 627 supports ATM overhead framing modes 1-3.

trellis-coding

Enables or disables trellis coding on the atm0 interface. A retrain is required to negotiate trellis coding with central office equipment.

splitterless

Configures the modem for splitterless G.Lite operation.

Command Mode

Enable

Example

The following example sets the interface to be atm0:

cpe627# set interface atm0 enable
 

The following example configures ATM overhead framing mode 3 on interface atm0:

cpe627# set interface atm0 overhead-framing mode-3

4.9 set nvram

To configure NVRAM settings, use the set nvram command.

set nvram {erase | add parameter | 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.

cpe627# set nvram erase 

4.10 set password

To set the password, use the set password command:

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


Note Passwords are limited to 18 characters or less.
Syntax Description

mode

Defines either the enable or 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:

cpe627# set password enable 55MyPass22
 

The following example clears the password for the enable mode:

cpe627# set password clear enable

4.11 set prompt

To change the command-line prompt, use the set prompt command:

set prompt new-prompt-name


Note Prompts are limited to 8 characters or less.
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:

cpe627# set prompt cisco627

4.12 set rip

To automatically add routes to your system, use the set rip command . 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:

cpe627# set rip atm1 enabled


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

cpe627# set rip atm1 aging 2500 enabled


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

cpe627# set rip atm0 update 25 enabled

4.13 set route

To build a routing table by manually adding or deleting entries in a routing table, use the set route command.

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

Syntax Description

default ip-address | interface

Sets a default route using an actual IP address or interface.

delete ip-address

Deletes an existing route using an actual IP address.

add

Adds a new route.

ip 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, ip-address.

gw ip-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, ip-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:

cpe627# set route add ip 192.168.9.1 gw 192.168.10.250
 

The following example shows how to delete a route:

cpe627# set route delete 192.168.10.1
 

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

cpe627# set route add ip 192.168.10.0 mask 255.255.255.0 
gw 192.168.245.228

The following example shows how to add a default route:

cpe627# set route default 192.168.245.228
 

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

cpe627# set route add ip 192.168.10.0 mask 255.255.255.0 
gw 192.168.245.228 metric 1

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

4.14 set serial

To configure serial port settings, use the set serial command.

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 sets the timeout value for the serial port:

cpe627# set serial timeout 50000

4.15 set telnet

To configure the telnet daemon settings, use the set telnet command.

set telnet remote ip-address | timeout # | port udp-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:

cpe627# set telnet remote 192.168.1.1 
 

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

cpe627# set telnet timeout 300

4.16 set tftp

To configure the TFTP settings, use the set tftp command.

set tftp remote ip-address | timeout # | port udp-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:

cpe627# set tftp remote 192.168.58.23

4.17 show

To display statistics on a particular application or interface, use the show command.

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 might 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:

cpe627# show nvram
cpe627# show nvram#
 

The following example displays the port setting for atm0:

cpe627# show interface atm0
 

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

cpe627# show interface
 

The following example displays the status of all RIP settings:

cpe627# show rip status
 

The following example displays all RIP settings for port atm0:

cpe627# show rip atm0

4.18 stats

To show operating statistics, use the stats command.

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

Syntax Description

ip

Displays IP statistics.

general

Displays general IP statistics on the WAN interface.

rip

Displays IP RIP statistics.

atm0

Displays atm0 IP statistics on the ATM-25 interface.

atm1

Displays atm1 IP 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:

cpe627# stats ip atm0

4.19 write

To write configuration changes to NVRAM, use the write command.

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:

cpe627# write


hometocprevnextglossaryfeedbacksearchhelp
Posted: Mon Oct 4 13:06:07 PDT 1999
Copyright 1989-1999©Cisco Systems Inc.