VIRATA ATMOS Console Installation manual

ATMOS Console
Commands Reference
Manual (Binary)
DO-008530-PS, Draft B (26th April 2001)

ii ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
Copyright
Copyright © 2001 Virata Corporation. All
Rights Reserved.
This document and the software programs to
which it relates are furnished under license and
may only be used in accordance with the terms
and conditions set forth in the license
agreement. This document is provided for
information only and is subject to change
without notice. Virata Corporation assumes no
responsibility or liability for any errors or
inaccuracies that may appear in the document,
and specifically disclaims any implied
warranties of merchantability, fitness for a
particular purpose, and non-infringement.
Except as permitted by such license, no part of
this document may be copied, reproduced,
stored in a retrieval system, or transmitted by
any means, electronic, mechanical, recording or
otherwise, or used as the basis for manufacture
or sale of any items without the prior written
consent of Virata Corporation.
Virata® is a registered trademark of Virata
Corporation.
All other names are for reference only and are
the property of their respective owners.
ATMOS Console Commands Reference Manual
(Binary): DO-008530-PR
Virata Company Proprietary.
Trademarks
Virata®, EmStack® and EmWeb® are
registered trademarks of Virata Corporation,
Inc. ATIC™ portable network protocol
software, ATMOS™ real-time operating
system, Beryllium™ ADSL communications
processor, Contoured System Architecture™
(CSA) technology, Helium™ communications
processor, Helium™ 200 communications
processor, Helium™ 210 communications
processor, Inverness™, ISOS™ Integrated
Software on Silicon, Performance Optimized
MPLS™ Software Solution Suite, vBaud™
software and vCore™ software are trademarks
of Virata Corporation.
Contacting Virata
For more information on Virata, contact the
offices below or visit our web site:
http://www.virata.com
Virata Santa Clara, USA
2933 Bunker Hill Lane Suite 201
Santa Clara, CA 95054
USA
phone: [phone]
fax: [phone]
Virata Cambridge, Europe
Mount Pleasant House
2 Mount Pleasant
Huntingdon Road
Cambridge CB3 OBL
United Kingdom
phone: [phone]
fax: [phone]
Virata Raleigh, USA
4700 Falls of Neuse Road
Suite 400
Raleigh, NC 27609
USA
phone: [phone]
fax: [phone]
Virata Taiwan, Asia
17F-2, No. 77 Hsin Tai Wu Road Sec.1
Hsichih
Taipei County
Taiwan
Voice: [phone]
Fax: [phone]

ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) iii
Contents
1. About this Guide 1
1.1 Introduction 2
1.2 Scope 2
1.3 Audience 2
1.4 Related Documents 2
1.5 Typographical conventions 3
1.6 Reading this guide 4

Contents
iv ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
2. ATMOS Console commands 5
2.1 General notes 6
2.2 event … 7
2.3 restart 8
2.4 uptime 9
2.5 version 10
2.6 <process>, <process> <command> 11
2.7 . (history mechanism) 13
2.8 @ commands 14
2.9 Special-purpose commands 16
2.10 list 17
2.11 echo … 18
2.12 tell <process> … 19
2.13 exit, exit! 20
2.14 debug 21
2.15 crlf, nocrlf 22
2.16 bind <process>, unbind 23
2.17 Commands for the chips process 24
2.18 cpu 25
2.19 debug 26
2.20 exit 27
2.21 help 28
2.22 info 29
2.23 mem 30
2.24 rb, rh, rw, wb, wh, ww 31
2.25 steal 32
2.26 tell 33

Contents
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) v
3. Bridge Console commands 35
3.1 device add 36
3.2 device delete 38
3.3 device list 39
3.4 ethertype 40
3.5 filter 41
3.6 filterage 42
3.7 flush 43
3.8 info 44
3.9 interface 45
3.10 portfilter 46
3.11 spanning 48
3.12 status 49
3.13 version 50
4. BUN Console commands 51
4.1 Introduction 52
4.2 help 55
4.3 version 56
4.4 build 57
4.5 config 58
4.6 list config 59
4.7 list devices 60
4.8 show device 61
4.9 list classes 62
4.10 show class 63
4.11 list ports 64
4.12 show port 65
4.13 set port 66
4.14 list channels 67
4.15 list all open channels 68
4.16 show channel 69
4.17 set channel 70
4.18 reset port 71

Contents
vi ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
5. DHCP-client Console commands 73
5.1 config 74
5.2 help 75
5.3 pool 76
5.4 status 77
5.5 trace 78
5.6 DHCP-related IP process commands 79
5.7 ip device 80
6. DHCP-server Console commands 81
6.1 config 82
6.2 help 84
6.3 pool 85
6.4 reset 86
6.5 status 87
6.6 trace 88
6.7 version 89
7. NAT Console commands 91
7.1 event 92
7.2 help 93
7.3 interfaces 94
7.4 inbound 95
7.5 info 97
7.6 protocol 98
7.7 sessions 99
7.8 stats 100
7.9 version 101
7.10 dump 102
7.11 fragments 103
7.12 hashtable 104

Contents
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) vii
8. PPP Console commands 105
8.1 Console object types 106
8.2 Console examples 107
8.3 <channel> clear 110
8.4 <channel> disable 111
8.5 <channel> discard 112
8.6 <channel> echo 113
8.7 <channel> echo every 114
8.8 <channel> enable 115
8.9 <channel> event 116
8.10 <channel> hdlc 117
8.11 <channel> info 118
8.12 <channel> interface 119
8.13 <channel> lcpmaxconfigure 120
8.14 <channel> lcpmaxfailure 121
8.15 <channel> lcpmaxterminate 122
8.16 <channel> llc 123
8.17 <channel> pvc 124
8.18 <channel> qos 126
8.19 <channel> remoteip 127
8.21 <channel> theylogin 130
8.22 <channel> tunnel <n> <tunnel protocol> <dial direction> 131
8.23 <channel> welogin 132
8.24 bcp 133
8.25 interface <n> localip 134
8.26 interface <n> stats 135
8.27 user 136
8.28 version 137
9. PPTP Console commands 139
9.1 Console object types 140
9.2 bind 142
9.3 <tunnel> connect 143
9.4 <tunnel> create 144
9.5 <tunnel> delete 145
9.6 <tunnel> disconnect 146
9.7 <tunnel> event 147
9.8 <tunnel> info 148
9.9 list 149
9.10 version 150

Contents
viii ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
10. TCP/IP Console commands 151
10.1 Summary 152
10.2 abort 155
10.3 arp 156
10.4 arprouting 158
10.5 autoloop 159
10.6 config 160
10.7 device 162
10.8 disable 166
10.9 enable 167
10.10 errors 168
10.11 etherfiles 169
10.12 files 170
10.13 flush 171
10.14 get 172
10.15 help 173
10.16 ipatm abort 174
10.17 ipatm arp 175
10.18 ipatm arpserver 176
10.19 ipatm files 177
10.20 ipatm help 178
10.21 ipatm lifetime 179
10.22 ipatm pvc 180
10.23 iphostname 182
10.24 nat 183
10.25 noerrors 184
10.26 norelay 185
10.27 ping 186
10.28 portname 187
10.29 protocols 189
10.30 relay 190
10.31 restart 192
10.32 rip accept 193
10.33 rip allowed 194
10.34 rip boot 195
10.35 rip help 196
10.36 rip hostroutes 197
10.37 rip killrelay 198
10.38 rip poison 199
10.39 rip relay 200

Contents
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) ix
10.40 rip relays 201
10.41 rip rxstatus 202
10.42 rip send 203
10.43 rip trigger 204
10.44 route 205
10.45 routeflush 207
10.46 routes 208
10.47 snmp 209
10.48 stats 210
10.49 subnet 211
10.50 trace 213
10.51 untrace 215
10.52 uptime 216
10.53 version 217
10.54 ? 218
11. TFTP Console commands 219
11.1 connect 220
11.2 get 221
11.3 help 222
11.4 init 223
11.5 list 224
11.6 put 225
11.7 trace 226
11.8 version 227
Index 229

Contents
x ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)

ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) 1
1. About this Guide
This chapter tells you about:
• The scope of this guide and its intended
audience.
• The typographical conventions used in this
guide.
• How to read and provide feedback about this
guide.
The information contained in this guide must be
read and fully understood, before you attempt to
use the product.

Introduction
2 ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
1.1 Introduction
This document is a reference guide for binary developers working with
Release 7.0 and later of ATMOS. It describes the command line
interface (CLI) for the most commonly used software components; the
IP stack, the Bridge, BUN, NAT, DHCP, PPP and TFTP interfaces.
1.2 Scope
This document describes the syntax and options for each console
command and provides some simple examples of the use of the
command. But this document does not provide extensive examples of
how to configure the software. For examples, see the example network
configurations chapter of the software user’s guide for your hardware
platform.
1.3 Audience
This document is targeted at binary licensees evaluating or developing
ATMOS-based systems.
1.4 Related Documents
For an overview of the features included in ISOS 7.1 software release,
see:
• Software 7.1 Feature Overview (Binary): DO-008529-TC
For conformance details for ISOS 7.1, see:
• ISOS Software Conformance Specification (Binary): DO-008528-
TC
For details of how to use the ATMOS console, see the software user’s
guide for your hardware platform, see:
• Centaur 2 (ATMOS) Software User’s Guide (Binary): DO-008531-
TC
• Centaur 4 (ATMOS) Software User’s Guide (Binary): DO-009023-
TC
for details of how to use the ISOS System Builder, see:
• ISOS System Builder User’s Guide: DO-007979-TC

About this Guide
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) 3
1.5 Typographical conventions
Throughout this guide, the following typographical conventions are
used to denote important information.
1.5.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 this 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].

Reading this guide
4 ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
1.5.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.
1.6 Reading this guide
1.6.1 Providing feedback on this guide
Please report problems and questions via the Problem Reports area on
the Virata licensee web server at:
http://ls.virata.com.
When submitting feedback, please give the full title, part number and
version number of the guide.
1.6.2 Reading this guide
Although this guide can be printed for easy reference, it has been
prepared for viewing online through a web browser, (such as Internet
Explorer™ or NetScape Navigator™) or Adobe Acrobat™.
Links to other sections of this guide or to other guides are marked in
blue (although the links are black when printed on a standard laser
printer.) Click on the link to view the associated section or document.

ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) 5
2. ATMOS Console
commands
This chapter describes the ATMOS Console
commands.

General notes
6 ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
2.1 General notes
Example output is shown only to clarify the description of the
commands; the actual output is not necessarily in exactly the same
format.

ATMOS Console commands
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) 7
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.

restart
8 ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
2.3 restart
2.3.1 Syntax
restart
2.3.2 Description
Reboots the ATMOS system.
The reboot will cause the loss of any configuration which has not yet
been saved (using the config save command).
2.3.3 See also
tell <process> … on page 19.

ATMOS Console commands
ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001) 9
2.4 uptime
2.4.1 Syntax
uptime
2.4.2 Description
Displays the time for which the system has been ‘up’, ie. the time since
the system has been powered up or restarted (using the restart
command).
2.4.3 See also
restart on page 8.

version
10 ATMOS Console Commands Reference Manual (Binary) DO-008530-PS, Draft B (26th April 2001)
2.5 version
2.5.1 Syntax
version
2.5.2 Description
Displays the system type and version.