CLI Command List

The following commands are available from ADSL router command line interfaces.

From Linux busybox:

From Linux public domain:

From USRobotics:

 

Control Key Support

  1. Command history scrolling (maximum 15 commands in history)

    UP: UP arrow key, or CTL+p
    DOWN: DOWN arrow key, or CTL+n

  2. Move cursor

    3. a. LEFT: LEFT arrow key, or CTL-b
    b. RIGHT: RIGHT arrow key, or CTL-f
    c. Beginning of line: CTL+a
    d. End of line: CTL+e

  3. Clear screen: CTL+l (lowercase letter of L)
  4. Clear to the beginning of line: CTL+u
  5. Clear to the end of line: CTL+k
  6. Delete: DEL key, or CTL+h
  7. Terminate CTL-c (can not terminate certain running application such as ping and traceroute)

 

ADSL

NAME

adsl – allow a user to control the USRobotics BCM63xx ADSL driver

SYNOPSIS

adsl start [options]
adsl stop
adsl connection [options]
adsl configure [options]
adsl bert [options]
adsl info [options]

DESCRIPTION

Adsl is used to control the USRobotics BCM63xx ADSL driver. This utility can:

start and stop the driver
activate, deactivate and control ADSL connection
configure ADSL driver and connection parameters
start, stop and monitor Bit Error Rate Test (BERT)
display status and information of ADSL driver and connection
display statistics for ADSL driver and connection

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output.

COMMANDS

start

Starts the USRobotics ADSL driver. This command calls BcmAdsl_Initialize to initialize the driver and BcmAdsl_ConnectionStart to start ADSL PHY connection if [--up] is specified. This command takes parameters that can specify various connection modes. These parameters are the same as in “configure” command.

stop

Stops ADSL connection and USRobotics ADSL driver. This command calls BcmAdsl_Uninitialize.

configure

Configures ADSL connection parameters. These command takes the same parameters as “start” command except for [--up] . This command will cause ADSL PHY to retrain.

connection

Controls ADSL connection modes, such as up and down and several special test modes. This command can also be used to specify tone selection for upstream and downstream.

bert

Controls ADSL bit error rate test (BERT). This command can start/stop the BERT test and monitor its results.

info

Display information about ADSL driver and PHY status.

OPTIONS

Options for the start and configure commands

adsl start [--up] [--mod <a|d|l|t>] [--lpair <(i)nner|(o)uter>] [--bm <(D)BM|(F)BM>] [--ccw]

adsl configure [--mod <a|d|l|t>] [--lpair <(i)nner|(o)uter>] [--bm <(D)BM|(F)BM>] [--ccw]

--up

Will call BcmAdsl_ConnectionStart to start ADSL PHY connection

--mod <a|d|l|t>

a – all modulations allowed.
d – G.DMT only
l – G.Lite only
t – T1.413 only
More than one mode letter can be given to specify several modes.

--lpair <(i)nner|(o)uter>

(i)nner –inner loop pair is used
(o)uter – outer loop pair is used

The following options apply to AnnexC only

--bm <(D)BM|(F)BM>

(D)BM - DBM mode
(F)BM - FBM mode

--ccw

Enables special CRC workaround for Centillium modems

Options for the stop command

adsl stop

Options for the connection command

adsl connection [--up] [--down] [--loopback] [--reverb] [--medley] [--noretrain] [--tones <xmtStart xmtNum xmtMap rcvStart rcvNum rcvMap>]

--up

Starts ADSL connection in normal mode

--down

Puts ADSL PHY in idle mode

--loopback

Puts ADSL PHY in ATM cell loopback mode. In this modem ADSL PHY will not try to establish connection

--reverb

Puts ADSL PHY in test mode in which it only sends REVERB signal

--medley

Puts ADSL PHY in test mode in which it only sends MEDLEY signal

--noretrain

In this mode ADSL PHY will be trying to establish connection as in normal mode, but once the connection is up it will not retrain even if the signal is lost.

--tones <xmtStart xmtNum smtMap rcvStart rcvNum rcvMap>

Specifies tones which can be used by ADSL PHY.
xmtStart – first tone used in upstream direction (usually 0)
xmtNum - number of tones in upstream direction (usually 32)
xmtMap - bitmap for tones used in upstream direction. Specified as a hexadecimal string. Bit value zero means the corresponding tone is not used, bit value one means it is used.
rcvStart – first tone used in downstream direction (usually 32)
rcvNum - number of tones in downstream direction (usually 224)
rcvMap - bitmap for tones used in downstream direction. Specified as a hexadecimal string. Bit value zero means the corresponding tone is not used, bit value one means it is used.

Tone configuration command does not cause ADSL PHY retrain automatically. To experience the effect of this command ADSL connection must be restarted using for example adsl connection –down followed by adsl connection –up command. Tone selection is not affected by adsl configure commands and has to be changed explicitly. Default tone configuration (all tones enabled) will be set by adsl tones 0 32 0xFFFFFFFF 32 224 0xFF… (repeated 28 times)

Options for the bert command

adsl bert [--start ] [--stop] [--show]

--start

Starts Bit Error Rate Test (BERT)
seconds – duration of BERT test in seconds

--stop

Stops the BERT test.

--show

Display BERT results to stdout in the following format:

BERT Status = [NOT] RUNNING BERT Total Time = 10 sec
BERT Elapsed Time = 10 sec
BERT Bits Tested = 0x00000000045A6380 bits
BERT Err Bits = 0x0000000000000002 bits
BERT Status indicates whether or not the BERT test is currently running. It can be used to monitor when the BERT test is complete after it is started. The numbers of total bit tested and errorred bits are displayed as 64 bit hexadecimal numbers.

Options for the info command

adsl info [--state] [--show] [--stats] [--reset]

--state

Displays the shortest message about ADSL PHY connection state, e.g.

adsl: ADSL driver and PHY status
Status: Showtime Channel: FAST, Upstream rate = 8064 Kbps, Downstream rate = 1024 Kbps

--show

Displays more statistics about ADSL connection.

--stats

Displays all available statistics about ADSL connection.

--reset

Clears all statistic counters in ADSL driver

EXIT CODES

Exit codes less than 100 are assigned by the ADSL driver. Exit codes of 100 or greater are assigned by the adsl utility.

BCMADSL_STATUS_SUCCESS 0
BCMADSL_STATUS_ERROR 1
ADSL_GENERAL_ERROR 100
ADSL_ALLOC_ERROR 101
ADSL_INVALID_COMMAND 102
ADSL_INVALID_OPTION 103
ADSL_INVALID_PARAMETER 104
ADSL_INVALID_NUMBER_OF_OPTIONS 105
ADSL_INVALID_NUMBER_OF_PARAMETERS 106

EXAMPLES

adsl connection –-reverb
adsl connection –-up

adsl connection –-tones 0 32 0xFEFFFF7F 32 224 0xFEFFFFFFFFFFFF7F
selects tones from 1 to 31 for upstream and from 33 to 95 for downstream

  Down Up
SNR (dB): 16.1 7.0
Attn(dB): 0.0 5.5
Pwr(dBm): 6.5 7.8
Max(Kbps): 11040 1088
Rate (Kbps): 0 0
K: 0(0) 0
R: 0 0
S: 1 1
D: 1 1
SF: 25288 25286
SFErr: 1 0
RS: 0 0
RSCorr: 0 0
RSUnCorr: 0 0
HEC: 1 0
OCD: 0 0
LCD: 0 0
ES: 1 0

 

ARP

NAME

arp – manipulate modem’s ARP (Address Resolution Protocol) table

SYNOPSIS

arp add <IP address> <MAC address>
arp delete <IP address>
arp show
arp --help

DESCRIPTION

arp is used to manipulate modem’s ARP table. Note that ARP entries added by this command are not saved in the flash memory by the save command. After system reboot, ARP entries need to be re-added.

EXAMPLES

Add a static ARP entry for IP address 192.168.1.2 with MAC address 00:11:22:33:44:55.
>arp add 192.168.1.2 00:11:22:33:44:55
Show ARP table.
> arp show

IP address HW type Flags HW address Mask Device
192.168.1.3 0x1 0x2 00:01:03:E3:4F:F9 * br0
192.168.1.2 0x1 0x6 00:11:22:33:44:55 * br0

° Delete ARP entry for IP address 192.168.1.2.
>arp delete 192.168.1.2

 

ATM

NAME

atm – allow a user to control the USRobotics BCM63xx ATM driver

SYNOPSIS

atm start [options]
atm stop
atm operate tdte|intf|vcc [options]

DESCRIPTION

Atm is used to control the USRobotics BCM63xx ATM driver. This utility can:

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output.

COMMANDS

Start

Starts the USRobotics ATM driver. This command calls BcmAtm_Initialize to initialize the driver and BcmAtm_SetTrafficDescrTable to add one UBR traffic descriptor table entry.

Stop

Stops the USRobotics ATM driver. This command calls BcmAtm_Uninitialize.

Operate

Operates on traffic descriptor table entries, ATM interfaces and VCCs. Depending on the options, this command calls BcmAtm_GetTrafficDescrTable, BcmAtm_SetTrafficDescrTable, BcmAtm_GetInterfaceCfg, BcmAtm_SetInterfaceCfg, BcmAtm_GetVccCfg, BcmAtm_SetVccCfg, BcmAtm_GetInterfaceStatistics or BcmAtm_GetVccStatistics.

OPTIONS

Options for the start command

atm start [--cqs <size>] [--pqs <size>] [--bs <size>] [--bo <offset>] [--intf <port> <type> <address>]

--cqs <size>
size – Size used to create the Free and Receive cell queues. Default value is 10.

--pqs <size>

size – Size used to create the Free and Receive packet queues. Default value is 200.

--bs <size>

size – Size of a buffer used in the Free and Receive packet queues. Default value is 1600.

--bo <offset>

offset - Offset into a receive buffer where data is to be received. Default value is 32.

--intf <port> <type> <address>

port – Port number starting at 0 to be configured.
type – adsl|loopback|utopia|tc
address – UTOPIA address. Only used if type is utopia.

More than one intf option can be specified to configure multiple ports. If no intf option is specified, the default value is "0, adsl, 0".

Options for the stop command

atm stop

Options for the operate tdte command

atm operate tdte [--add <type> [<pcr>] [<scr>] [<mbs>]] [--delete <index>] [-- show [<index>]]

--add <type> [<pcr>] [<scr>] [<mbs>]

type - ubr|ubr_pcr|cbr|rtvbr|nrtvbr
pcr – Peak Cell Rate (PCR) if type requires it
scr – Sustainable Cell Rate (SCR) if type requires it
mbs – Maximum Burst Size (MBS) if type requires it

--delete <index>

index – Traffic descriptor table entry index to delete. The show option displays the current index values.

--show [<index>]

index – Traffic descriptor table entry index to display information about.

If index is omitted, all traffic descriptor table entries are displayed.

Options for the operate intf command

atm operate intf [--state <port> <type> ] [--show [<port>]] [--stats [<port>] [reset]]

--state <port> <type>

port – Port number starting at 0 to enable or disable.
type – enable|disable

--show [<port>]

port – Port number starting at 0 to display configuration information about.

If port is omitted, configuration information is displayed for all configured ports.

--stats [<port>] [reset]

port – Port number starting at 0 to display statistics for.
reset – Resets statistics fields.

If port is omitted, statistics are displayed for all configured ports.

Options for the operate vcc command

atm operate vcc [--add <port.vpi.vci> <aal_type> <tdte_index> <encapsulation_type>] [--delete <port.vpi.vci>] [--addq <port.vpi.vci> <size> <priority> ] [--deleteq <port.vpi.vci> <size> <priority> ] [-- state <port.vpi.vci> <type> ] [--show [<port.vpi.vci>]] [--stats [<port.vpi.vci>] [reset]]

--add <port.vpi.vci> <type> <tdte_index> <encapsulation_type>

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to add.
type – aal5|aal2|aal0pkt|aal0cell|aaltransparent
tdte_index - Traffic descriptor table entry index to use for this VCC.

The command, atm operate tdte –-show, displays the current index values.

encapsulation_type – vcmux_routed|vcmux_bridged8023|llcencaps|other|unknown

--delete <port.vpi.vci>

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to delete.

--addq <port.vpi.vci> <size> <priority>

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to add a new queue for.
Size – Size of the queue.
Priority – Priority of the queue.

--deleteq <port.vpi.vci> <size> <priority>

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to delete a queue for.
size – Size of the queue.
priority – Priority of the queue.

--state <port.vpi.vci> <type>

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to enable or disable.
type – enable|disable

--show [<port.vpi.vci>]

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to display configuration information about.

If port.vpi.vci is omitted, configuration information is displayed for all configured VCCs.

--stats [<port.vpi.vci>] [reset]

port.vpi.vci – Port number, VPI and VCI that identifies the VCC to display statistics for.
reset – Resets statistics fields.

If port.vpi.vci is omitted, statistics are displayed for all configured VCCs.

EXIT CODES

Exit codes less than 100 are assigned by the ATM driver. Exit codes of 100 or greater are assigned by the atm utility.

ATMDRV_SUCCESS 0
ATMDRV_ERROR 1
ATMDRV_STATE_ERROR 2
ATMDRV_PARAMETER_ERROR 3
ATMDRV_ALLOC_ERROR 4
ATMDRV_RESOURCE_ERROR 5
ATMDRV_IN_USE 6
ATMDRV_VCC_DOWN 7
ATMDRV_INTERFACE_DOWN 8
ATMDRV_LINK_DOWN 9
ATMDRV_NOT_FOUND 10
ATMDRV_NOT_SUPPORTED 11
ATM_GENERAL_ERROR 100
ATM_ALLOC_ERROR 101
ATM_INVALID_COMMAND 102
ATM_INVALID_OPTION 103
ATM_INVALID_PARAMETER 104
ATM_INVALID_NUMBER_OF_OPTIONS 105
ATM_INVALID_NUMBER_OF_PARAMETERS 106

 

EXAMPLES


BRCTL

NAME

brctl – bridge administration utility

SYNOPSIS

brctl [ command ]

DESCRIPTION

brctl is used to set up, maintain, and inspect the bridge configuration.

A bridge is a device commonly used to connect different networks (Ethernet, USB, 802.11x wireless network or ATM) together, so that these networks will appear as one network to the participants.

Each of the networks being connected corresponds to one physical interface (port) in the bridge. These individual networks are bundled into one bigger ('logical') network, this bigger network corresponds to the bridge network interface such as “br0”.

COMMANDS

addbr <bridge>

Creates a new instance of the bridge. The network interface corresponding to the bridge will be called <bridge> .

delbr <bridge>

Deletes the instance <bridge> of the bridge. The network interface corresponding to the bridge must be down before it can be deleted.

show <bridge>

Shows the instance of the bridge.

show

Shows all current instances of the bridge.

addif <bridge> <device>

Makes the interface <device> a port of the bridge <bridge>. This means that all frames received <device> on will be processed as if destined for the bridge <bridge>. Also, when sending frames on <bridge>, <device> will be considered as a potential output interface.

delif <bridge> <device>

Detaches the interface from the bridge <bridge> .

showmacs <bridge>

Shows a list of learned MAC addresses for this bridge.

showstp <bridge>

Shows the STP (Spanning Tree Protocol) status of this bridge.

setageing <bridge> <time>

Sets the MAC address ageing time, in seconds. After

setbridgeprio <bridge> <priority>

Sets the bridge's priority to <priority>. The priority value is an unsigned 16-bit quantity (a number between 0 and 65535), and has no dimension. Lower priority values are 'better'. The bridge with the lowest priority will be elected 'root bridge'.

setfd <bridge> <time>

Sets the bridge's 'bridge forward delay' to

setgcint <bridge> <time>

Sets the garbage collection interval for the bridge <bridge> to

sethello <bridge> <time>

Sets the bridge's 'bridge hello time' to

setmaxage <bridge> <time>

Sets the bridge's 'maximum message age' to

setpathcost <bridge> <port> <cost>

Sets the port cost of the port <port> to <cost>. This is a dimensionless metric.

setportprio <bridge> <port> <prio>

Sets the port <port>'s priority to <priority>. The priority value is an unsigned 8-bit quantity (a number between 0 and 255), and has no dimension. This metric is used in the designated port and root port selection algorithms.

stp <bridge> <state>

Controls this bridge instance's participation in the spanning tree protocol. If is "on" or "yes" the STP will be turned on, otherwise it will be turned off. When turned off, the bridge will not send or receive BPDUs, and will thus not participate in the spanning tree protocol. If your bridge isn't the only bridge on the LAN, or if there are loops in the LAN's topology, DO NOT turn this option off. If you turn this option off, please know what you are doing.

OPTIONS

None.

EXAMPLES


CAT

NAME

cat – concatenates FILE(s) and prints them to standard output

SYNOPSIS

cat [FILE] ...

DESCRIPTION

Concatenates FILE(s) and prints them to standard output

COMMANDS

None.

OPTIONS

None.

EXAMPLES

Display system memory information.

cat /proc/meminfo

 

DEFAULTGATEWAY

NAME

defaultgateway – configure or show the default gateway or default route

SYNOPSIS

defaultgateway config auto
defaultgateway config static [<ipaddress>] [<interface>]
defaultgateway show
defaultgateway --help

DESCRIPTION

The primary use of defaultgateway command is to set up a static default gateway or default route, or to retrieve the default gateway information automatically from remote ISPs through DHCP protocol for a MER interface or through PPP protocol for a PPPoA or PPPoE interface. A PPPoA or PPPoE interface will always retrieve remote gateway information automatically. This command will save configuration to the Permanent Storage.

If the default gateway is configured with static data, it will override any remote gateway address received automatically from some WAN interface and become effective immediately in the runtime system. Ipaddress is optional if the default route is en route a PPPoE, PPPoA or IPoA interface. If the default gateway is en route a MER interface, ipaddress must be configured and the interface parameter is optional. If there is only one IPoA WAN interface, you must configure static default gateway or default route since IPoA does not support DHCP.

If the default gateway is configured with the "auto" option, the system needs to be rebooted before it can take effect. If there are multiple WAN interfaces with DHCP or PPP enabled, multiple remote gateway addresses may be received and the first received will be chosen to be the default gateway.

OPTIONS

ipaddress

the IP address of the default gateway in dotted decimal.

interface

force the default gateway to be associated with the specified device, as the kernel will otherwise try to determine the device on its own by checking already existing routes and devices.

EXAMPLES

 

DF

NAME

df – print the filesystem used space and available space

SYNOPSIS

df [OPTION]... [FILESYSTEM]...

DESCRIPTION

df displays the amount of disk space available on the file system of each filesystem name argument. If no file system name is given, the space available on all currently mounted filesystems is shown. Disk space is shown in 1 kb blocks by default.

COMMANDS

None.

OPTIONS

-h print sizes in human readable format (e.g., 1K 243M 2G )
-m print sizes in megabytes
-k print sizes in kilobytes (default)

EXAMPLES

DHCPSERVER

NAME

dhcpserver – allow a user to configure, or show the DHCP Server data

SYNOPSIS

dhcpserver config <start IP address> <end IP address> leased time (hour)>

dhcpserver show

dhcpserver --help

DESCRIPTION

dhcpserver is used to configure, or show the DHCP server data. This utility can:

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output.

COMMANDS

config

configure the DHCP server with the given data. Notice: the command saves the configuration data to the flash but does not take effect until the system is rebooted.

show

show the DHCP server configuration data.

--help

display usage.

OPTIONS

Options for the config command

dhcpserver config <start IP address> <end IP address> <leased time (hour)>.

<start IP address>

The IP address of the first address in the range. The value of range start must be less than or equal to the value of range end.

Valid values: any valid IP address.

Default value: 192.168.1.2.

<end IP address>

The IP address of the last address in the range. The value of range end must be greter than or equal to the value of range start.

Valid values: any valid IP address.

Default value: 192.168.1.254.

<leased time (hour)>

The lease period for which the server assigns an IP address to the client in case the client does not request for the specific lease period itself.

Valid values: 0 - 8760.

Default value: 24 hours (this equals a day).

Options for the show command

dhcpserver show

Options for the --help command

dhcpserver --help

EXAMPLES

 

DLTFTP

NAME

dltftp – allow a user to download a binary image from a TFTP server to the DSL router using TFTP protocol

SYNOPSIS

dltftp

DESCRIPTION

Download a binary image from a TFTP server to the DSL router using TFTP protocol.

OPTIONS

dltftp <ftp_server_ip_address> <file_name>

<ftp_server_ip_address>

The IP address of the TFTP server from which the file is to be downloaded.

Valid values: any valid IP address.

<file_name>

The name of the binary file to be downloaed. The filename contains the complete path in the TFPT server. The file must be a valid image file for the DSL router.

Valid values: String of up to 128 characters.

EXAMPLES

dltftp 192.168.1.2 bcm96345R_fs_kernel

 

DNSRELAY

NAME

dnsrelay – allow a user to configure or show the DNS relay data

SYNOPSIS

dnsrelay config auto
dnsrelay config static <primary DNS> [<secondary DNS>]
dnsrelay show
dnsrelay --help

DESCRIPTION

dnsrelay is used to configure, or show the DNS relay data. This utility can:

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output.

COMMANDS

config

configure the DNS relay with the given data. Notice: the command only saves the configuration data to the flash, and does not take effect until the system is rebooted.

show

show the DNS relay configuration data.

--help

display usage.

OPTIONS

Options for the config auto command

dnsrelay config auto

Options for the config static command

dnsrelay config static <primary DNS> [<secondary DNS>]

<primary DNS>

The IP address of the primary DNS server.

Valid values: any valid IP address.

[<secondary DNS>]

The IP address of the secondary DNS server. It’s optional and can be omitted.

Valid values: any valid IP address.

Options for the show command

dnsrelay show

Options for the --help command

dnsrelay –help

EXAMPLES

 

ECHO

NAME

echo – display a line of text or an environment variable’s value

SYNOPSIS

echo [OPTION]... [STRING]...

DESCRIPTION

echo displays a line of text, or an environment variable’s value. Notice that “ls” command is not supported in the CLI. Echo can be used to display files and subdirectories using wildcard ‘*’.

COMMANDS

None.

OPTIONS

-n suppress trailing newline -e interpret backslash-escaped characters (i.e., \t=tab) -E disable interpretation of backslash-escaped characters

EXAMPLES

 

HELP

NAME

help – list all of available CLI commands that the DSL router supports

SYNOPSIS

Help | ?

DESCRIPTION

list all of available CLI commands that the DSL router supports.

OPTIONS

None

EXAMPLES

 

IFCONFIG

NAME

ifconfig – configure a network interface

SYNOPSIS

ifconfig [interface] ifconfig interface [aftype] options | address ...

DESCRIPTION

Ifconfig is used to configure the kernel-resident network interfaces. It is used at boot time to set up interfaces as necessary. After that, it is usually only needed when debugging or when system tuning is needed.

If no arguments are given, ifconfig displays the status of the currently active interfaces. If a single interface argument is given, it displays the status of the given interface only; if a single -a argument is given, it displays the status of all interfaces, even those that are down. Otherwise, it configures an interface.

COMMANDS

None.

OPTIONS

interface

The name of the interface. This is usually a driver name followed by a unit number, for example eth0 for the first Ethernet interface.

address

The IP address to be assigned to this interface.

up

This flag causes the interface to be activated. It is implicitly specified if an address is assigned to the interface.

down

This flag causes the driver for this interface to be shut down.

[-]arp

Enable or disable the use of the ARP protocol on this interface.

[-]promisc

Enable or disable the promiscuous mode of the interface. If selected, all packets on the network will be received by the interface.

[-]allmulti

Enable or disable all-multicast mode. If selected, all multicast packets on the network will be received by the interface.

metric N

This parameter sets the interface metric.

mtu N

This parameter sets the Maximum Transfer Unit (MTU) of an interface.

dstaddr addr

Set the remote IP address for a point-to-point link (such as PPP). This keyword is now obsolete; use the pointopoint keyword instead.

netmask addr

Set the IP network mask for this interface. This value defaults to the usual class A, B or C network mask (as derived from the interface IP address), but it can be set to any value.

irq addr

Set the interrupt line used by this device. Not all devices can dynamically change their IRQ setting.

io_addr addr

Set the start address in I/O space for this device.

mem_start addr

Set the start address for shared memory used by this device. Only a few devices need this.

[-]broadcast [addr]

If the address argument is given, set the protocol broadcast address for this interface. Otherwise, set (or clear) the IFF_BROADCAST flag for the interface.

[-]pointopoint [addr]

This keyword enables the point-to-point mode of an interface, meaning that it is a direct link between two machines with nobody else listening on it. If the address argument is also given, set the protocol address of the other side of the link, just like the obsolete dstaddr keyword does. Otherwise, set or clear the IFF_POINTOPOINT flag for the interface.

[-]trailers

Set or clear the IFF_NOTRAILERS flag for the interface.

[-]dynamic

Set or clear the IFF_DYNAMIC flag for the interface.

hw class address

Set the hardware address of this interface, if the device driver supports this operation. The keyword must be followed by the name of the hardware class and the printable ASCII equivalent of the hardware address. Hardware classes currently supported include ether (Ethernet) only.

multicast

Set the multicast flag on the interface. This should not normally be needed as the drivers set the flag correctly themselves.

outfill N

This parameter sets the interface outfill timeout.

keepalive N

This parameter sets the interface keepalive timeout.

txqueuelen length

Set the length of the transmit queue of the device. It is useful to set this to small values for slower devices with a high latency (modem links, ISDN) to prevent fast bulk transfers from disturbing interactive traffic like telnet too much.

EXAMPLES

 

KILL

NAME

kill – send a signal to the specified process(es)

SYNOPSIS

kill [ -signal ] pid ...
kill -l [ signal ]

DESCRIPTION

kill sends the specified signal to the specified process or process group. If no signal is specified, the TERM signal is sent. The TERM signal will kill processes which do not catch this signal. For other processes, it may be necessary to use the KILL (9) signal, since this signal cannot be caught.

COMMANDS

None.

OPTIONS

pid... Specify the list of processes that kill should signal.
-signal given as a signal name or number.
-l List all signal names and numbers.

 

EXAMPLES

 

LAN

NAME

lan – allow a user to configure the IP layer for the LAN interfaces

SYNOPSIS

lan config [--ipaddr <primary|secondary> <IP address> <subnet mask> ] [--dhcpserver <enable|disable>]

lan delete –ipaddr <primary|secondary>

lan show [<primary|secondary> ]

lan --help

DESCRIPTION

Lan is used to configure the IP layer data for the primary and secondary LAN interfaces. A LAN interface is a logic interface toward IP stack from the Bridge module. Both primary and secondary LAN interfaces share the same MAC address from the physical Ethernet port. This utility can:

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output.

COMMANDS

config

configure IP layer for the primary or secondary LAN interface.

delete

delete the primary or secondary LAN interface configuration.

show

show configuration data for the primary and secondary LAN interfaces. --help display usage.

OPTIONS

Options for the config command

lan config [--ipaddr <primary|secondary> <IP address> <subnet mask> ] [--dhcpserver <enable|disable>]

--ipaddr <primary|secondary> <IP address> <subnet mask>

primary|secondary – specify which LAN interface will be configured.
Valid values: primary or secondary.

IP address - The IP address of the LAN interface.
Valid values: any valid IP address.
Default value: 192.168.1.1.

Subnet mask – The subnet mask of the LAN interface.
Valid values: 0.0.0.1 - 255.255.255.255.
Default value: 255.255.255.0

--dhcpserver <enable|disable>

enable|disable – specify DHCP server should be enabled or disabled. This option is only valid for the primary LAN interface.
Valid values: enable or disable.
Default value is enable for the primary LAN interface.

Options for the delete command

lan delete --ipaddr <primary|secondary>

--ipaddr <primary|secondary>

primary|secondary – specify which LAN interface will be deleted.
Valid values: primary or secondary.

Options for the show command

lan show [<primary|secondary> ]

primary|secondary – specify which LAN interface will be shown.
Valid values: primary or secondary.
If it is omitted, all LAN interfaces are displayed.

Options for the --help command

lan --help

EXAMPLES

 

LOGOUT

NAME

logout – log out current user console

SYNOPSIS

logout

DESCRIPTION

logout is used to log out current user console. After logout command is executed, a bye bye message appears. Hit return to see a new Login prompt.

EXAMPLES

 

PASSWD

NAME

passwd – allow a user to change password

SYNOPSIS

passwd <admin|support|user><password>

DESCRIPTION

passwd is a CLI command used to change password for user account admin, support or user.

EXAMPLES

 

PING

NAME

ping – send ICMP echo requests to target host

SYNOPSIS

Ping [-c <count>] [-s <size>] host

DESCRIPTION

Ping sends out ICMP echo requests over the ICMP protocol to a host on the network. The default number of the ICMP echo request packets ping sends out is four. To continually send out packets without stop, use "-c 0" option.

OPTIONS

count

The number of ICMP echo request packets ping command will send out.

size

force the ping to send out ICMP echo request packets with this number of data bytes.

Host

The name or ip address of the target host.

EXAMPLES

Ping -c 8 192.168.0.5

Send eight ICMP echo requests to 192.168.0.5.

 

ppp

NAME

ppp – allow a user to bring up or bring down a ppp connection

SYNOPSIS

ppp config <port.vpi.vci> up|down

DESCRIPTION

ppp is used to control the ppp interfaces. Ppp command brings up the ppp connection with "up" option, and brings down the connection with "down" option. For ppp connection in on-demand mode, in addition to the "up" option, traffic to the ppp interface needs to be initiated to bring the connection up.

<port.vpi.vci>

Port number, VPI and VCI that identifies the VCC where the ppp connection is established.

EXAMPLES

ppp config 0.0.35 down

 

PS

NAME

ps – report process status

SYNOPSIS

ps

DESCRIPTION

ps gives a snapshot of the current processes. The output consists of six columns:

PID The process ID
TTY The terminal device the process attaches to, such as /dev/ttyp0
Uid The user ID of the process owner
Size The amount of virtual memory taken by the process (kilobytes)
State The state of the process. (S-Sleeping, R-Running, W-Waiting)
Command The command that launches the process

 

COMMANDS

None.

OPTIONS

None.

EXAMPLES

 

PWD

NAME

pwd – print name of current working directory

SYNOPSIS

pwd

DESCRIPTION

pwd is a CLI command used to display name of current working directory.

EXAMPLES

 

REBOOT

NAME

reboot – reboot the system

SYNOPSIS

reboot

DESCRIPTION

Reboot the system.

COMMANDS

None.

OPTIONS

None.

EXAMPLES

 

REMOTEACCESS

NAME

remoteaccess – allow certain protocols to access the modem from the WAN side

SYNOPSIS

Usage: remoteaccess <enable|disable>
  remoteaccess show
  remoteaccess --help

DESCRIPTION

Remoteaccess sets security level to allow or disallow remote access into the route using telnet, http, snmp or ping from the WAN side. The options are enable, disable and show.

EXAMPLES

 

RESTOREDEFAULT

NAME

restoredefault – restore modem configuration to factory defaults

SYNOPSIS

restoredefault

DESCRIPTION

restoredefault is a CLI command used to erase all configurations made by user, and restore the modem back to factory default configuration. Once this command is executed, modem reboots automatically with default configuration.

EXAMPLES

 

ROUTE

NAME

route – show / manipulate the IP routing table

SYNOPSIS

route add <ipaddress> <subnetmask> <[<gateway>] [<interface>]>

route delete <ipaddress> <subnetmask>

route show

route --help

DESCRIPTION

route manipulates the IP routing table. Its primary use is to set up static routes to specific hosts or networks via an interface.

When the add or delete options are used, route modifies the routing tables. Show option displays the current contents of the routing tables.

Note default gateway route should use another “defaultgateway” command. If 0.0.0.0 is entered using route add command, it is treated the same as a static default gateway where a subnetmask must be entered.

COMMANDS

add

add a new route entry

delete

delete a route entry

show

show current content of routing table including static and dynamic route entries

OPTIONS

ipaddress

the destination network or host IP address in dotted decimal notation.

subnetmask

when adding a network route, the netmask must be specified. Target address must have zero matching with the zero portion in NM. Otherwise, command will fail and display message “netmask doesn't match route address”

gateway

route packets via a gateway.

NOTE: The specified gateway must be reachable first. This usually means that you have to set up a static route to the gateway beforehand. If you specify the address of one of your local interfaces, it will be used to decide about the interface to which the packets should be routed to.

interface

force the route to be associated with the specified device, as the kernel will otherwise try to determine the device on its own by checking already existing routes and devices.

EXAMPLES

OUTPUT

The output of the kernel routing table is organized in the following columns

Destination

The destination network or destination host.

Gateway

The gateway address or * if none set.

Genmask

The netmask for the destination net; 255.255.255.255 for a host destination and 0.0.0.0 for the default route.

Flags Possible flags include

U (route is up)
H (target is a host)
G (use gateway)
R (reinstate route for dynamic routing)
D (dynamically installed by daemon or redirect)
M (modified from routing daemon or redirect)

FILES

/proc/net/route /proc/net/rt_cache

 

SAVE

NAME

save – save current configuration to Permanent Storage on the flash memory

SYNOPSIS

save

DESCRIPTION

save is a CLI command used to save current configuration to flash.

EXAMPLES

 

SWVERSION

NAME

swversion – display current running software version

SYNOPSIS

swversion show

DESCRIPTION

swversion is a CLI command used to view the current running software version.

EXAMPLES

 

SYSINFO

NAME

sysinfo – display the general system information

SYNOPSIS

sysinfo

DESCRIPTION

sysinfo displays the number of processes in the system, system time, system uptime, the average system load in the past 1, 5 and 15 minutes, and the system memory consumption. The figures in the memory consumption table are in 1kb unit.

COMMANDS

None.

OPTIONS

None.

EXAMPLES

 

TOP

NAME

top – display the system and processes information periodically

SYNOPSIS

top [-d <seconds>]

DESCRIPTION

top provides an view of processor activity and system information in real time. This utility reads the status for all processes in /proc each and shows the status for however many processes will fit on the screen. This utility will not show processes that are started after program startup, but it will show the EXIT status for and PIDs that exit while it is running. Typing ‘q’ or CTRL+C will stop top

. COMMANDS

None.

OPTIONS

-d <seconds> setup the information update time interval

EXAMPLES

 

TRACEROUTE

NAME

traceroute – print the route packets take to network host SYNOPSIS traceroute [-dnrv] [-m max_ttl] [-p port#] [-q nqueries] [-s src_addr] [-t tos] [-w wait] host [data size]

DESCRIPTION

Traceroute utilizes the IP protocol `time to live' field and attempts to elicit an ICMP TIME_EXCEEDED response from each gateway along the path to some host.

COMMANDS

None.

OPTIONS

-d set SO_DEBUG options to socket
-d Print hop addresses numerically rather than symbolically
-r Bypass the normal routing tables and send directly to a host
-v Verbose output
-m max_ttl Set the max time-to-live (max number of hops)
-p port# Set the base UDP port number used in probes
  (default is 33434)
-q nqueries Set the number of probes per ``ttl'' to nqueries
  (default is 3)
-s src_addr Use the following IP address as the source address
-t tos Set the type-of-service in probe packets to the following value
  (default 0)
-w wait Set the time (in seconds) to wait for a response to a probe
  (default 3 sec.)

 

EXAMPLES

 

WAN

NAME

wan – allow a user to configure the WAN interfaces for the DSL router

SYNOPSIS

wan config

[--protocol <bridge|pppoe|pppoa|mer|ipoa>] [--encap <llc|vcmux>]
[--state <enable|diasble> ] [--service <servicename>]
[--firewall <enable|diasble>] [--nat <enable|diasble>]
[--username <username> --password <password>]
[--pppidletimeout <timeout>] [--pppipextension <disable|enable> ]
[--ipaddr <wanipaddress> <wansubnetmask>]
[--dhcpclient <enable|disable>]

wan delete <port.vpi.vci>

wan show [port.vpi.vci>]

wan --help <bridge|pppoe|pppoa|mer|ipoa>

DESCRIPTION

wan is used to configure the networking protocols for each WAN interface. Currently each WAN interface occupies one ATM PVC. It does not support multiple PPPoE sessions on one ATM PVC. Before using this command, the ATM PVC of which the WAN interface is based on, must be configured first by using the atm command. This command can:

All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout to a file and then parse the file in order to interpret the displayed output. Note that special characters are supported in all options of character string type.

COMMANDS

config

configure the WAN interface for the DSL router. Notice: the command only saves the configuration data to the flash, and does not take effect until the system is rebooted.

delete

remove the existed WAN interface. Notice: the command only saves the configuration data to the flash, and does not take effect until the system is rebooted.

show

show ATM PVC VPI/VCI, service category, WAN interface service name, WAN interface name, WAN protocol, WAN interface service state, WAN interface up/down status, and WAN IP address.

--help

display usage for WAN interface.

OPTIONS

Options for the config command

wan config <port.vpi.vci>

[--protocol <bridge|pppoe|pppoa|mer|ipoa>] [--encap <llc|vcmux>]

[--state <enable|disable>] [--service <servicename>]

[--firewall <enable|disable>] [--nat <enable|disable>]

[--username <username> --password <password>]

[--pppidletimeout <timeout>] [--pppipextension <enable|disable>]

[--ipaddr <wanipaddress> <wansubnetmask>]

[--dhcpclient <enable|disable>]

<port.vpi.vci>

port: port number of the ATM VCC to add.
Valid values: 0.

vpi: VPI of the VCC to add.
Valid values: 0 - 255.
Default value: 0

Vci: VCI of the VCC to add.
Valid values: 32 - 65535.
Default value: 35.

--protocol <bridge|pppoe|pppoa|mer|ipoa>

The protocol of the WAN interface.

Valid values: bridge, pppoe, pppoa, mer, or ipoa.

Default value: bridge.

--encap <llc|vcmux>

The encapsulation type over the ATM PVC.

Valid values: llc or vcmux.

llc -

For mer, pppoe or bridge, it’s RFC2684 bridged encapsulation

For pppoa, it’s RFC2364 LLC/NLPID encapsulation

Vcmux - RFC2684 VC-MUX (null encapsulation).

Default value:

llc for bridge, pppoe, mer, or ipoa.

Vcmux for pppoa.

--state <enable|disable>

The service state of the WAN interface.

Valid values: enable or disable.

Default value: enable.

--service <servicename>

The service name of the WAN interface.

Valid values: strings of 32 characters.

Default value: __.

--firewall <enable|disable>

The firewall state of the MER or IPoA interface.

Notice that firewall is always enabled on a PPPoE or a PPPoA interface.

Valid values: enable or disable.

Default value: enable.

--nat <enable|disable>

The NAT state of the MER or IPoA interface.

Notice that NAT is always enabled on a PPPoE or a PPPoA interface.

Valid values: enable or disable.

Default value: enable.

--username <username>

The login name of the PPPoE or PPPoA interface.

This option is only applied to a PPPoE or PPPoA interface.

The -–password option is also needed when this option is used.

Valid values: string of 32 characters.

--password <password>

The password of the PPPoE or PPPoA interface.

This option is only applied to a PPPoE or PPPoA interface.

The -–username option is also needed when this option is used.

Valid values: string of 256 characters.

--pppidletimeout <timeout>

The PPP timeout of a PPPoE or PPPoA interface.

This option is only applied to a PPPoE or PPPoA interface.

Valid values: 0 – 1090 (minutes).

0: PPP connection is always-on.

Greater than 0: WAN traffic will be monitored and PPP connection will be torn down when there is no user data activity over the WAN interface for more than this idle time period.

Default value: 30 minutes.

--pppipextension <enable|disable>

The PPP IP extension mode of a PPPoE or PPPoA interface.

This option is only applied to a PPPoE or PPPoA interface.

Valid values: disable or enable.

Default value: disable.

--ipaddr <wanipaddress> <wansubnetmask>

The WAN IP address and WAN subnet mask of a MER or IPoA interface.

This option should only be used for a MER or IPoA interface. PPPoE and PPPoA interface always receives the IP address, submask and DNS addresses automatically from the ISP through the PPP protocol. If this option is used and the dhcpclient value is “enable”, DHCP client will be disabled on this interface. In general principle, static configuration overwrites dynamically assigned data.

<wanipaddress> - the WAN IP address.
Valid values: any valid IP address.

<wansubnetmask> - the WAN subnet mask.
Valid values: 0.0.0.1 - 255.255.255.255.

--dhcpclient <enable|disable>

The DHCP client state of the MER interface. This option is only valid to a MER interface. DHCP client is not supported over any other type of WAN interface.

Valid values: enable or disable.

Default value: enable.

Options for the delete command

wan delete <port.vpi.vci>

<port.vpi.vci>

port: port number of the VCC to add.
Valid values: 0.

vpi: VPI of the VCC to add.
Valid values: 0 - 255.
Default value: 0

vci: VCI of the VCC to add.
Valid values: 32 - 65535.
Default value: 35.

Options for the show command

wan show [<port.vpi.vci>]

<port.vpi.vci>

port: port number of the VCC to add.
Valid values: 0.

vpi: VPI of the VCC to add.
Valid values: 0 - 255.
Default value: 0

vci: VCI of the VCC to add.
Valid values: 32 - 65535.
Default value: 35

If <port.vpi.vci> is obmitted then it will display summary state of all existing WAN interfaces. Notice, configuration needs to be saved to the Permanent Storage first and then become effective after reboot. The wan show command shows the WAN interfaces after reboot, the second stage.

Options for the --help command

wan –help [<bridge|pppoe|pppoa|mer|ipoa>]

<bridge|pppoe|pppoa|mer|ipoa>

Display only valid options for the specified protocol.
If it is obmitted then the help for all protocols is diplayed.

EXAMPLES