Atlantis Land I-Storm A02-RA(Atmos)_ME01 Installation manual

I-Storm ADSL Router
Console
Commands Reference
Manual(v1.01)
A02-RA(Atmos)_ME01

Contents
1. About this Guide
1.1 Introduction
1.2 Scope
1.3 Typographical conventions
2. ATMOS Console commands
2.1 General notes
2.2 event
2.3 restart
2.4 uptime
2.5 version
2.6 <process>, <process> <command>
2.7 . (history mechanism)
2.8 @ commands
2.9 Special-purpose commands
2.10 list
2.11 echo
2.12 tell <process>
2.13 exit, exit!
2.14 debug
2.15 crlf, nocrlf
2.16 bind <process>, unbind
2.17 Commands for the chips process
2.18 cpu
2.19 debug
2.20 exit
2.21 help
2.22 info
2.23 mem
2.24 rb, rh, rw, wb, wh, ww
2.25 steal
2.26 tell
3. Bridge Console commands
3.1 device add
3.2 device delete
3.3 device list

3.4 ethertype
3.5 filter
3.6 filterage
3.7 flush
3.8 info
3.9 interface
3.10 portfilter
3.11 spanning
3.12 status
3.13 version
4. BUN Console commands
4.1 Introduction
4.2 help
4.3 version
4.4 build
4.5 config
4.6 list config
4.7 list devices
4.8 show device
4.9 list classes
4.10 show class
4.11 list ports
4.12 show port
4.13 set port
4.14 list channels
4.15 list all open channels
4.16 show channel
4.17 set channel
4.18 reset port
5. DHCP-client Console commands
5.1 config
5.2 help
5.3 pool
5.4 status
5.5 trace
5.6 DHCP-related IP process commands
5.7 ip device
6. DHCP-server Console commands

6.1 config
6.2 help
6.3 pool
6.4 reset
6.5 status
6.6 trace
6.7 version
7. NAT Console commands 91
7.1 event
7.2 help
7.3 interfaces
7.4 inbound
7.5 info
7.6 protocol
7.7 sessions
7.8 stats
7.9 version
7.10 dump
7.11 fragments
7.12 hashtable
8. PPP Console commands
8.1 Console object types
8.2 Console examples
8.3 <channel> clear
8.4 <channel> disable
8.5 <channel> discard
8.6 <channel> echo
8.7 <channel> echo every
8.8 <channel> enable
8.9 <channel> event
8.10 <channel> hdlc
8.11 <channel> info
8.12 <channel> interface
8.13 <channel> lcpmaxconfigure
8.14 <channel> lcpmaxfailure
8.15 <channel> lcpmaxterminate
8.16 <channel> llc
8.17 <channel> pvc

8.18 <channel> qos
8.19 <channel> remoteip
8.20 <channel> svc
8.21 <channel> theylogin
8.22 <channel> tunnel <n> <tunnel protocol> <dial direction>
8.23 <channel> welogin
8.24 bcp
8.25 interface <n> localip
8.26 interface <n> stats
8.27 user
8.28 version
9. PPTP Console commands
9.1 Console object types
9.2 bind
9.3 <tunnel> connect
9.4 <tunnel> create
9.5 <tunnel> delete
9.6 <tunnel> disconnect
9.7 <tunnel> event
9.8 <tunnel> info
9.9 list
9.10 version
10. TCP/IP Console commands
10.1 Summary
10.2 abort
10.3 arp
10.4 arprouting
10.5 autoloop
10.6 config
10.7 device
10.8 disable
10.9 enable
10.10 errors
10.11 etherfiles
10.12 files
10.13 flush
10.14 get
10.15 help

10.16 ipatm abort
10.17 ipatm arp
10.18 ipatm arpserver
10.19 ipatm files
10.20 ipatm help
10.21 ipatm lifetime
10.22 ipatm pvc
10.23 iphostname
10.24 nat
10.25 noerrors
10.26 norelay
10.27 ping
10.28 portname
10.29 protocols
10.30 relay
10.31 restart
10.32 rip accept
10.33 rip allowed
10.34 rip boot
10.35 rip help
10.36 rip hostroutes
10.37 rip killrelay
10.38 rip poison
10.39 rip relay
10.40 rip relays
10.41 rip rxstatus
10.42 rip send
10.43 rip trigger
10.44 route
10.45 routeflush
10.46 routes
10.47 snmp
10.48 stats
10.49 subnet
10.50 trace
10.51 untrace
10.52 uptime
10.53 version

10.54 ?
11. TFTP Console commands
11.1 connect
11.2 get
11.3 help
11.4 init
11.5 list
11.6 put
11.7 trace
11.8 version
Index

1. About this Guide
1.1 Introduction
This document is a reference guide for professional user to handle ADSL modem well. It
describes the command line interface (CLI) with examples.
1.2 Scope
Commands for legacy drivers (eg. ATM and Ethernet drivers) are not included here.
1.3 Typographical conventions
Throughout this guide, the following typographical conventions are used to denote
important information.
1.3.1 Text conventions
The following text conventions are used:
• Text like this is used to introduce a new term, to indicate menu options or to denote
field and button names in GUI windows and dialogue boxes.
• Text like t his is used to emphasize important points. For example:
‘To keep your changes, you must save your work before quitting.’
• Text like this is used for text that you type as a command or entry to a field in a
dialogue box. Variables to a command are shown in text like this.
• Text like this is used for text that you see on the screen in a terminal window.
Variables to displayed text are shown in text like this.
• <Text like this> in angle brackets is used for denoting command line options.
It indicates a mandatory argument.
• [Text like this] in square brackets is used for denoting command line options.
It indicates an optional argument.
• Text in square brackets is used to indicate keyboard keys. For Example
‘To reboot your computer, press [Ctrl]+[Alt]+[Del].
• Type versus Enter; Type means type the text as shown in the instruction. Enter
means type the text as indicated and then press [Enter].
1.3.2 Notes, Warnings and Cautions
The following symbols are used:
Warning - Indicates a hazard which may endanger equipment or personnel, if
the safety instruction is not observed.
Caution - Indicates a hazard which may cause damage to equipment, if the
safety instruction is not observed.
Note - Indicates general additional information about the operation of the

equipment, including safety information.

2. Console and Telnet commands
2.1 General notes
Apart from the chips commands, the commands are supported by the standard console.
Example output is shown only to clarify the description of the commands; the actual
output is not necessarily in exactly the same format.
2.2 event …
2.2.1 Syntax
event help
event n[ext]
event p[revious]
event r[ecent]
event show
event unshow
2.2.2 Description
The command event show enables display of background output on this console
device.
The command event unshow disables it. By default, the display of background output
is disabled.
The command event recent (or event r) displays the most recent background output
stored in the memory buffer; event previous (or event p) displays the background
output immediately preceding that last displayed; event next (or event n) displays the
background output immediately following that last displayed. Up to 24 lines are
displayed in each case.
For example, after event r, event n will show only new background output that has
arrived since the event r command: repeated typing of event n will let the user keep
up to date with new background output (without any repetitions in the output).
The command event help displays a summary of the options of the event command.
2.3 restart
2.3.1 Syntax
restart
2.3.2 Description
Reboots the ADSL modem.
2.4 uptime

2.4.1 Syntax
uptime
2.4.2 Description
Displays the time for which the system has been up.
2.5 version
2.5.1 Syntax
version
2.5.2 Description
Displays the system type and version.
2.6 <process>, <process> <command>
2.6.1 Syntax
<process> <command>
<process>
home
home <command>
2.6.2 Description
In these commands, <process> can be any of a list of process names known to the
console.
The former variant sends the command as a TELL message to the process.
The latter variant remembers the process name, and sends subsequent commands as
TELL messages to the process, as if they had been preceded by the process name,
until the command home is issued. The prompt is changed to reflect this; moreover,
if a help command with no arguments is issued, it is passed to the process as usual,
but then information about the home command is appended to the process’s output
by the console.
2.6.3 Example
mymachine> isfs version
ISFS v2.07
mymachine> isfs
mymachine isfs> version
ISFS v2.07
mymachine isfs> help
ISFS commands are:
help - this text is displayed

ls - list ISFS files
rm <file> - remove file from ISFS
cat <file> - show file contents
version - displays version number
Use “home” to return to “mymachine>” prompt
mymachine isfs> home
mymachine>
When the console is at the prompt of a particular process, the command home
<command> or home <process> <command> may be used to execute a command
as if the user had typed home followed by <command> or <process> <command>.
However, the console will remain at the same process prompt.
The command home <process> will change the prompt from the current process to a
new process <process>.
2.6.4 Example
mymachine> bridge
mymachine bridge> version
Bridge Version 1.15
mymachine bridge> home version
Modem BD3000 Version 7.0.0.7 (2 Jun 2000)
mymachine bridge> home nat version
NAT Version 2.02
mymachine bridge> home edd
mymachine edd> version
EDD Version 1.03
mymachine edd> home
mymachine>
2.7 . (history mechanism)
2.7.1 Syntax
.
2.7.2 Description
Repeats the previous console command.
2.7.3 Example
mymachine> isfs version
ISFS v2.07
mymachine> .
ISFS v2.07

2.8 @ commands
2.8.1 Syntax
@@<line>
@ <line>
@<process> <line>
@<process>
2.8.2 Description
Lines beginning with the @ character are intercepted by the console even when the
console device is bound to a file.
To bypass this interception and pass a line beginning with @ to a process, the @
must be doubled; the line with one @ removed will be passed on like a normal input
line. (At the time of writing, this is most useful when the device is bound to a slotN
process on a switch; then @ip would refer to the ip process on the switch, but @@ip
would be passed to the slotN process as @ip and forwarded by that to the ATMOS
console on an expansion card, which will interpret it as referring to the ip process on
the expansion card.)
If the @ is followed by a space (or any non-alphanumeric character), the remainder
of the line is treated as a console command, as if the device were not bound.
The @<process> <line> form passes <line> to a file (if any) opened for reading by
the named process.
The @<process> form binds the console device to the named process, in the same
way as bind <process>. (Except that the latter, not being an @ command, will not
work if the console device is bound. More generally, @<process> does the same as
@bind <process>.)
2.8.3 Example
mymachine> @ip
(The ip> prompt does not appear until the Enter key is pressed again.)
ip> device
# type dev file IP address
device ether ether //edd mtu 1500 192.168.3.55
ip> @console
mymachine>
2.9 Special-purpose commands
This section lists commands that are normally useful only to developers rather than to
normal users, or else are retained only for consistency with older versions of the software.
They are not described in the output of the help command.

2.10 list
2.10.1 Syntax
list
2.10.2 Description
The list command lists the active console devices (referred to as threads) and files.
For each console device, if it is bound to a file then the list shows which file it is
bound to; if background output is enabled on that device then the list indicates the
fact.
For each file, the list shows the name of the process that opened the file and the
number of read commands outstanding on the file. If the file is bound to a device
then the list shows which device it is bound to; if the file is for foreground output
then the list indicates the fact (with the string FG).
2.10.3 Example
mymachine> list
Threads:
1: ACTIVE, FP 00730520
3: ACTIVE, FP 00719170, Bound 75, events shown
Files:
0: OPEN FP 00718e70, Queue chips, 0 read(s)
1: OPEN FP 00718c30, Queue isfs, 0 read(s)
(some output omitted)
49: OPEN FP 00715af4, Queue ip, 0 read(s), Bound 3, FG
(some output omitted)
75: OPEN FP 00715b38, Queue ip, 1 read(s), Bound 3
(some output omitted)
2.11 echo …
2.11.1 Syntax
echo <text>
2.11.2 Description
Echoes the text. (Not a very useful command.)
2.11.3 Example
mymachine> echo hello world
hello world
2.12 tell <process> …

2.12.1 Syntax
tell <process> <command>
2.12.2 Description
Sends the command as a TELL message to a specific process. Note that for many
processes the tell can be omitted.
2.12.3 Example
mymachine> tell hswctrl portinfo a1
port type vers flags
A1 25Mbps 1QUA mast uni30 ilmi netside tx8khz manconfig
2.13 exit, exit!
2.13.1 Syntax
exit
exit!
2.13.2 Description
Exits from application firmware to the boot ROM. Without the exclamation mark,
the command works only from the serial interface; with the exclamation mark it
works from any console device.
Note - This command is now deprecated and provides no useful output.
2.14 debug
2.14.1 Syntax
debug
2.14.2 Description
Enters the debugger. Only works when issued at the serial interface. (Since the
debugger talks to the serial interface, the debug command would be of little use
elsewhere.)
2.15 crlf, nocrlf
2.15.1 Syntax
crlf
nocrlf
2.15.2 Description
Controls whether line-feed characters written to this console device are output as
carriage-return/line-feed pairs (crlf) or just as single line-feed characters (nocrlf).

2.16 bind <process>, unbind
2.16.1 Syntax
bind <process>
unbind
2.16.2 Description
The former command binds this console device to the specified process – that is,
binds this device to the file, if any, opened for read by that process, and binds every
file opened by the process to this device.
The latter command unbinds this console device – that is, undoes the above bindings.
2.16.3 Example
mymachine> bind ip
ip> @ unbind
mymachine>
2.17 Commands for the chips process
2.18 cpu
2.18.1 Syntax
cpu
2.18.2 Description
Displays the recent CPU utilization as a percentage. This is a fairly crude
measurement: the ATMOS kernel measures the time that the CPU spends in the idle
loop over successive three-second intervals, and the cpu command uses this
measurement from the most recent complete three-second interval.
2.19 debug
2.19.1 Syntax
debug
2.19.2 Description
Enters the ATMOS debugger.
2.20 exit
2.20.1 Syntax
exit
2.20.2 Description

Exits from ATMOS to the boot ROM.
Note - This command is now deprecated and provides no useful output.
2.21 help
2.21.1 Syntax
help
?
help <command>
2.21.2 Description
The help command lists all chips commands. ? is a synonym for this command;
help <command> displays more detailed help on the specified command.
This command is available only if the pre-processor symbol CHIPSHELP is defined.
2.22 info
2.22.1 Syntax
info
2.22.2 Description
Displays system type and version number, and the MAC addresses.
2.23 mem
2.23.1 Syntax
mem
2.23.2 Description
Displays a summary of how much memory is used by each process (distinguishing
between heap and thread stacks, along with some other minor categories), along with
the amount of free heap memory and the size of the largest single free block.
2.24 rb, rh, rw, wb, wh, ww
2.24.1 Syntax
rb <addr>
rh <addr>
rw <addr>
wb <addr> <val>
wh <addr> <val>
ww <addr> <val>
2.24.2 Description

Reads the byte (rb), word (rw) or half-word (rh) at a specified address, or writes a
specified value to the byte (wb), word (ww) or half-word (wh). Addresses and values
are specified in hexadecimal, with an optional 0x prefix.
2.24.3 Example
> rw 1c4b54
word at 0x001C4B54 contains 0x0000337E
> rb 1c4b55
byte at 0x001C4B55 contains 0x33
> wb 1c4b56 0x20
value 0x20 written to byte at 0x001C4B56
> rw 1c4b54
word at 0x001C4B54 contains 0x0020337E
> ww 0x1c4b54 14c44
value 0x00014C44 written to word at 0x001C4B54
>
2.25 steal
2.25.1 Syntax
steal memory use <handle> <amount>
steal memory release <handle>
steal file use <handle> <device>
steal file release <handle>
steal cpu use <percentage>
steal cpu release
steal status [memory] [file] [cpu]
2.25.2 Description
Uses up heap memory, file handles, or CPU cycles. <handle> is a number from 0 to
19, used to identify the resource for a later steal … release command.
This command is intended to help test system behaviour when resources are limited,
and is available only if the pre-processor symbol CHIPS_STEAL is defined.
2.26 tell
2.26.1 Syntax
tell <process> <command>
2.26.2 Description
Sends the command as a TELL message to a specific process. (The same as the

console tell command.)

3. Bridge Console commands
3.1 device add
3.1.1 Syntax
device add <device>
3.1.2 Description
This command adds a device to the bridge configuration. Attempts to add the bridge
itself or an existing device to the bridge are rejected.
Attempts to add devices which don’t support the Cyan interface are rejected. There
is a limit on the number of devices that can be attached to the bridge. If the device
being added is from a process which supports multiple devices, the /DEVICE
attribute must be specified as part of the device name. The table below shows
devices which may be attached to the bridge, although not all systems may support
all devices.
Device Remarks Source
Edd Ethernet driver bun_ethernet
r1483 RFC1483 protocol (PVC) rfc1483
Ppp Point-to-Point protocol pp
Configuration saving saves this information. See the section entitled Implementation
Constraints in the ATMOS Transparent Bridge Specification, DO-007087-PS, for
details of which devices are added by default.
3.1.3 Example
Simple examples
device add edd
device add ppp/DEVICE=2
Using the BUN RFC1483 driver
This example shows how to add the BUN RFC1483 driver, dynamically from the
console. You need to define and configure a device and a port.
Normally, the RFC1483 BUN device will pass all data straight through, untouched.
This means that even though you have changed your port definition to include the
RFC1483 driver, you can still use other protocols on the same port. In order to
enable RFC1483 encapsulation, the RFC1483 attribute on the channel must be set to
true.
The channel attribute mode dictates the functional behaviour of the driver, in terms
of encapsulation method to use and traffic nature (bridged/routed). The channel