ZyNOS and all information relating to ZyNOS © 1999
ZyXEL Communications Corporation
ZyXEL Website
This document has been assembled as a service to users of
ZyNOS and other interested parties. No responsibility is
assumed for users who use this information to corrupt or
damage their equipment. If you are not sure what you
are doing then DON'T do it! You have been warned.
This document has been colated from a number of sources. Some
sources were for earlier versions of ZyNOS and some predate ZyNOS
as it now exists. Some commands may only be available on specific
types of device. All known commands will be listed here for
completeness but may no longer exist on any devices. Some commands
may never have been implemented.
Parameters shown in italics, e.g. <parameter>,
should be replaced by the appropriate data. Paramaters that are
shown as a non-italicised list, e.g. <one|two|three>,
indicate that one of the values listed should be used. Parameters
shown in square brackets, e.g. [<value>], are
optional and may be ommited.
WARNING: Many commands use the absence of a parameter to
display the current value of the command while a few set the value
to an indeterminate value!
NOTE: Commands from previous versions of the firmware are still
listed but are marked as DEFUNCT if they are no longer available.
Newer commands are marked with the version number of the version
of ZyNOS when they were created or modified.
? |
List major commands (Not all commands are listed!) |
bridge |
List major bridge subcommands (Not all subcommands, if any, are listed!) |
device |
List major device subcommands (Not all subcommands, if any, are listed!) |
dialer |
List major dialer subcommands (Not all subcommands, if any, are listed!) |
ether |
List major ether subcommands (Not all subcommands, if any, are listed!) |
exit |
Exit the Command Interface |
hdap |
List major hdap subcommands (Not all subcommands, if any, are listed!) |
ip |
List major ip subcommands (Not all subcommands, if any, are listed!) |
ipx |
List major ipx subcommands (Not all subcommands, if any, are listed!) |
isdn |
List major isdn subcommands (Not all subcommands, if any, are listed!) |
l2tp |
List major l2tp subcommands (Not all subcommands, if any, are listed!) |
lan |
List major lan subcommands (Not all subcommands, if any, are listed!) |
ppp |
List major ppp subcommands (Not all subcommands, if any, are listed!) |
radius |
List major radius subcommands (Not all subcommands, if any, are listed!) |
snmp |
List major snmp subcommands (Not all subcommands, if any, are listed!) |
sys |
List major sys subcommands (Not all subcommands, if any, are listed!) |
wan |
List major wan subcommands (Not all subcommands, if any, are listed!) |
ip |
address |
[<ip-addr>] |
Display / Set host IP address |
adj |
<iface> [<value>] |
Display / Set TCP MSS (Maximum Segment Size) on an
interface
(Since ZyNOS V3.25 (M.01)) |
adjmss |
[<value>] |
Display / Set TCP MSS (Maximum Segment Size)
(Since ZyNOS V3.25 (M.01)) |
alias |
<iface> |
Create a new alias for interface (Default
existing aliases are enif0:0 and enif0:1) |
aliasdis |
<flag> |
Enable / Disable routing between aliased interfaces
flag = 0: Disable
flag = 1: Enable |
antip |
[<flag>] |
Display / Set IP antiprobe status
flag = 0: Disable
flag = 1: Enable |
arp |
add |
<hostid> ether <ether-addr> |
Add ARP entry to cache |
drop |
<hostid> <ether> |
Drop ARP entry from cache |
flush |
Flush ARP cache |
publish |
Add proxy ARP |
reply |
[<value>] |
Display / Set ARP reply between LAN and WAN
ethernet interface
value = 0: Disable
value = 1: Enable
(Since ZyNOS V3.25 (M.01)) |
resolve |
<hostid> |
|
status |
Display IP ARP status |
dhcp |
<iface> server |
arpcount <num> |
|
dnsserver <dnsIP1> [<dnsIP2>] |
Set DHCP client's DNS server(s)
(Default is 0.0.0.0 which refers to the values obtained from the
WAN interface) |
gateway <gw> |
Set DHCP client's gateway IP address
(Default is the router's IP address) |
hostname <prefix> |
Set DHCP client's hostname prefix |
leasetime <period> |
Set DHCP client's lease time |
netmask <netmask> |
Set DHCP client's netmask |
pool <start> <num> |
Set DHCP server's starting IP address and
the number of addresses in the DHCP table |
rebindtime <period> |
|
renewaltime <period> |
|
reset |
|
<iface> status |
Display interface DHCP information |
<iface> client |
release |
Release DHCP client IP address |
renew |
Renew DHCP client IP address |
dns |
query |
status |
Display DNS query status |
stats |
disp |
Display DNS active settings and statistics |
clear |
Clear DNS statistics |
table |
Display DNS proxy table |
httpd |
|
icmp |
check |
[<cmd|rsp|indication>] |
|
data |
|
echo |
[<switch>] |
Display / Set ICMP echo responce switch |
status |
Display ICMP statistic counter |
trace |
[<switch>] |
Display / Set ICMP trace debugging switch |
discovery |
<iface> [<switch>] |
Display / Set ICMP router discovery response switch
(Only LAN interfaces may be selected) |
ifconfig |
[<iface[/<bits>] [<gw>]] |
Display ifconfig for all interfaces or nominated
interface. Optionally configure the nominated interface with the
number of bits to specify the subnet mask and/or the gateway IP
address |
igmp |
debug |
[<level>]
| Display / Set IGMP debug level |
forwardall
| [<switch>]
| Display / Set IGMP forwarding to all interfaces switch |
iface |
|
querier |
[<switch>]
| Display / Set IGMP becoming a non-querier switch |
robustness |
[<variable>]
| Display / Set IGMP robustness variable |
status |
Display IGMP settings on all interfaces |
nat |
disp |
Display Single User Account (SUA) statistic |
iface |
<iface> |
Display dynamic NAT table by interface |
loopback |
[<switch>] |
Display / Set local LAN user's ability to use Internet
IP address to access internal servers on the LAN switch |
set |
[<switch>] |
Set static NAT entry for this port on IP interface
(Since ZyNOS V3.50 (M.00)) |
timeout |
generic [<timeout>] |
Display / Set UDP NAT timeout time (in seconds)
(Default is 180 seconds) |
tcp [<timeout>] |
Display / Set TCP connection phase timeout time (in seconds)
(Default is 270 seconds) |
tcpother [<timeout>] |
Display / Set TCP data phase timeout time (in seconds)
(Default is 9000 seconds) |
ping |
<host-id> |
Ping remote host by name or IP address |
rip |
accept |
<gw> |
Drop an entry from the RIP information |
activate |
Activate the RIP listener list |
dialin_user |
[<direction>] |
Display / Set dialin user's RIP direction
direction = show: Show the current RIP setting
direction = in: Set inbound RIP direction
direction = out: Set outbound RIP direction
direction = both: Set bidirectional RIP
direction = none: Disable RIP |
merge |
[<switch>] |
Display / Set RIP merging switch |
mode |
<iface> [<direction>] [<mode>] |
Set RIP direction and mode
direction: in | out
mode: 0 - 3 |
refuse |
<gw> |
Add an entry to the RIP refuse list |
reverse |
[<switch>] |
Display / Set RIP Poisoned Reverse switch |
status |
Display RIP statistic counters |
trace |
[<flag>] |
Display / Set RIP trace
flag = 0: Off
flag = 1: On |
route |
add |
<ip-addr>[/<bits>] <gw> [<metric>] |
Add route |
addprivate |
<ip-addr>[/<bits>] <gw> [<metric>] |
Add private route |
drop |
<ip-addr>[/<bits>]
| Drop a route |
errcnt |
clear |
Clear routing statistic counters |
disp |
Display routing statistic counters |
flush |
Flush route table |
lookup |
<ip-addr>[/<bits>]
| Show host route table |
status |
Display routing table |
status |
Display IP statistic counters |
sua |
iface |
<iface> |
(* DEFUNCT *) |
disp |
display single user account statistic
(* DEFUNCT *) |
set |
<ip-addr> <port> |
(* DEFUNCT *) |
tcp |
ceiling |
[<value>] |
Display /Set TCP maximum Round Trip Time (RTT) |
floor |
[<value>] |
Display / Set TCP minimum RTT |
kick |
<controlblock> |
|
irtt |
[<value>] |
Display / Set TCP default init RTT |
limit |
[<value>] |
Display / Set TCP output window size limit |
mss |
[<size>] |
Display / Set TCP input MSS size |
reset |
|
rtt |
<controlblock> |
|
status |
Display TCP statistic counters, active
connections and listening sockets (NetStat) |
syndata |
[<switch>] |
Display / Set TCP syndata piggyback switch |
trace |
[<switch>] |
Display / Set trace debugging switch |
window |
[<size>] |
Display / Set TCP input window size limit |
tftp |
stats |
Display TFTP statistics |
support |
Display confirmation of TFTP support |
tredir |
failcount |
|
partner |
|
target |
|
timeout |
|
checktime |
|
active |
|
save |
|
disp |
|
debug |
|
udp |
status |
Display UDP statistics and control blocks |
xparent |
break |
<iface> |
Detach this interface by breaking any transparent
bridging with other interfaces |
join |
<iface1> [<iface2>] |
Display interfaces that are joined in a transparent
bridge with interface 1. If specified, join interface 2 in a
transparent bridge with interface 1 |
ppp |
bod |
clear |
<iface> |
Clear WAN interface BOD counters |
debug |
[<switch>] |
Display / Set BOD debug status switch |
[<switch>] |
Display / Set BOD switch |
reset |
Reset BOD counters |
status |
<iface> |
Display WAN interface BOD counters |
ccp |
[<switch>] |
Display / Set dial-in CCP switch |
config |
ipcp |
address [<switch>] |
Display / Set IPCP address option switch |
compress [<switch>] |
Display / Set VJ header compression switch |
idcompress [<switch>] |
Display / Set slot ID compression switch |
slots [<value>] |
Display / Set number of slots
value: 1 - 64 |
ccp |
ascend [<switch>] |
Display / Set ascend stac on|off |
check |
Display Stac check mode |
debug [<switch>] |
Display / Set CCP debug mode switch |
history |
Display Stac history count |
pfc [<switch>] |
Display / Set PFC switch |
reset [<mode>] |
Display / Set ascend Stac reset mode
mode: 1 - 3 |
delay |
[<msec>] |
Display / Set the delay timer, in miliseconds, for sending
first PPP packet after call answered |
fsm |
trace |
break |
Set finite state machine trace |
clear |
Clear finite state machine trace |
disp |
Display finite state machine trace |
filter |
Set finite state machine trace filter |
tdata |
clear |
Clear finite state machine trace data |
disp |
Display finite state machine trace data |
filter |
Set finite state machine trace data filter |
iface |
<name> <protocol> |
Display protocol state |
ipcp |
address |
[<switch>] |
Display / Set IPCP address option switch |
close |
Close connection on PPP IPCP interface |
compress |
[<switch>] |
Display / Set VJ header compression switch |
idcompress |
[<switch>] |
Display / Set slot ID compression switch |
list |
<iface> |
Display interface PPP IPCP table |
open |
Open connection on PPP IPCP interface |
slots |
[<slots>] |
Display / Set local number of VJ compression slots |
timeout |
[<timeout>] |
Display / Set authentication and link quality setup
timeout timer in miliseconds (Timeout interval when waiting for
response from remote peer) |
try |
configure [<value>] |
|
failure [<value>] |
|
terminate [<value>] |
|
lcp |
acfc |
[<switch>] |
Display / Set address/control field compression switch |
bacp |
[<switch>] |
Display / Set bandwidth allocation control switch |
callback |
[<switch>] |
Display / Set PPP LCP callback switch |
mpin |
[<switch>] |
Display / Set PPP LCP MP for incoming calls switch |
pfc |
[<switch>] |
Display / Set protocl field compression switch |
mp |
default |
[<type>] |
Display / Set PPP MP default or unknown interface
type: rotate | split |
rotate |
[<switch>] |
Display / Set PPP MP rotate switch |
split |
[<switch>] |
Display / Set PPP MP split switch |
show |
<device> |
Show channel PPP information
device: PPP device channel, e.g. poe0 |
sys |
adjtime |
Adjust the local date and time, try a client
connection to the configured time server and accord the UTC
answer with the preset timezone offset |
baud |
<speed> |
Set console speed
speed = 1: 38400 bps (Default if omitted)
speed = 2: 19200 bps
speed = 3: 9600 bps
speed = 4: 57600 bps
speed = 5: 115200 bps |
callhist |
add |
<name> <dir> <rate> <uptime> |
Add the call history
(* DEFUNCT *) |
display |
Display the call history |
remove |
<index> |
Remove the call history at index |
cbuf |
cnt |
disp |
Display cbuf static |
clear |
Clear cbuf static |
disp |
<a|f|u> |
Display cbuf
a: all
f: free
u: used |
clock |
display |
Display clock procedure
(* DEFUNCT *) |
cmgr |
data |
<chan> |
Display channel connection manager data |
trace |
clear <chan> |
Clear channel connection manager trace |
disp <chan> |
Display channel connection manager trace |
countrycode |
[<country-code>] |
Display / Set country code |
cpu |
display |
Display CPU utilization |
date |
[<year> <month> <day>] |
Display / Set system date
year: 4 digit year
month: number between 1 and 12
day: number between 1 and 31 |
ddns |
debug |
[<flag>] |
Display / Set Dynamic DNS debug
flag = 0: Disable
flag = 1: Enable |
display |
Display Dynamic DNS status |
logout |
<iface> |
Publish IP address of interface with offline
status onto the configured Dynamic DNS server |
restart |
<iface> |
Publish IP address of interface with online
status onto the configured Dynamic DNS server |
dir |
Display file directory
(* DEFUNCT *) |
domainname |
Display system domain name |
edit |
<filename> |
Edit a text file
Edit Commands:
q: Quit
x: Save and exit
i: Insert after this line
d: Delete this line
r: Replace this line
n: Next line
Press n until you see the line you want to modify, or where
you want to insert a new line, etc., then press the key for the
appropriate command, e.g.: i followed by the new entry
you want to add. When you are done, enter x to save the
file and exit or q to quit without saving. |
errctl |
[<level>] |
Display / Set the error control level
level = 0: Crash no save, not in debug mode (Default)
level = 1: Crash no save, in debug mode
level = 2: Crash save, not in debug mode
level = 3: Crash save, in debug mode
(If ERRCTL is on system will stay at BootModule debug mode) |
event |
display |
Display tag flags information |
trace |
display |
Display system event information |
clear |
Clear system event information |
extraphnum |
add |
<set> <phone1> [<phone2>] |
Add outcalling phone numbers
set: 1 - 3 |
display |
Display outcalling phone numbers |
node |
|
remove |
<set> |
set: 1 - 3 |
reset |
|
feature |
Display feature bit settings list |
fid |
display |
Display function id list |
filter |
clear |
Clear filter statistic counter |
disp |
Display filter statistic counters |
sw |
[<switch>] |
Display / Set filter statistic counter switch |
hostname |
[<name>] |
Display / Set system hostname (Max 32
characters from [A-Z,a-z,0-9]) |
iface |
disp |
Display interface list |
isr |
Display interrupt entry (Debugging tool)
(* DEFUNCT *) |
log |
clear |
Clear error log |
disp |
Display error log |
online |
[<switch>] |
Display / Set error log online display switch |
map |
Display memory map table
(* DEFUNCT *) |
mbuf |
cnt |
cl |
Clear system mbuf count |
disp |
Display system mbuf count |
debug |
[<switch>] |
Display / Set mbuf system debug switch |
disp |
<address> |
Display mbuf status |
link |
link |
List system mbuf link |
pool |
<id> <type> |
List system mbuf pool |
status |
Display system mbuf status |
memory |
<address> <len> |
Display memory content
(* DEFUNCT *) |
memutil |
mcell |
<mid> [<type>] |
Display memory cells by given ID
type = a: All cells (Default)
type = f: Free cells
type = u: Used cells |
mq |
<address> <len> |
Display memory queues |
msecs |
Display memory sections |
usage |
Display memory allocate and heap status |
memwrite |
<null> |
Write to memory
(* DEFUNCT *) |
pro |
disp |
Display all process information |
ps |
<tag> |
Display process's status by a given tag |
stack |
<tag> |
Display process's stack by a given tag |
queue |
disp |
[<type>] [start [end]] |
Display queue by given status and range numbers
type = a: All queues
type = f: Free queues
type = u: Used queues |
ndisp |
<num> |
Display a queue by a given number |
quit |
Quit CI command mode |
reboot |
<code> |
Reboot system
code = 0: Cold boot
code = 1: Immediately boot
code = 2: BootModule (BootBase) debug mode |
reslog |
disp |
Display resources trace |
clear |
Clear resources trace |
rn |
disp |
|
load |
|
nailup |
|
nat |
|
save |
|
syst |
|
roadrunner |
debug |
<level> |
Enable / Disable roadrunner service
level = 0: Disable (Default)
level = 1: Enable |
disp |
<iface> |
Display roadrunner information
iface: wanif0 (WAN port) |
restart |
<iface> |
Restart roadrunner service |
server |
access |
<service> <type> |
Set access type for service
service: dns | ftp | icmp | telnet | web
type = 0: Both LAN and WAN access
type = 1: Disable access to service
type = 2: LAN access only
type = 3: WAN access only |
disp |
Display server config |
load |
Load server config into memory |
port |
<service> <port> |
Set IP port number for service
service: dns | ftp | icmp | telnet | web |
save |
Save server config |
secureip |
<service> <ip-addr> |
Set port number for service
service: dns | ftp | icmp | telnet | web |
socket |
Display open sockets |
spt |
dump |
<root|rn|user|slot> |
Dump spt raw data |
size |
Display spt record size |
stdio |
[<timeout>] |
Display / Set terminal timeout value (in minutes) |
syslog |
facility |
<facility> |
Set syslog local facility number
facility: 0 - 6 |
mode |
[<switch>] |
Display / Set syslog enabled switch |
server |
<ip-addr> |
Set syslog server IP address |
type |
[<bitmap>] |
Display / Set syslog log type bitmap
bit 0: (Least significant bit)
bit 1:
bit 2:
bit 3:
bit 4: PPP log
bit 5: Filter log
bit 6: Packet triggered
bit 7: CDR (Most significant bit) |
time |
[<hour> [<min> [<sec>]]] |
Display / Set system time
hour: number between 0 and 24
min: number between 0 and 59 (0 if omitted)
sec: number between 0 and 59 (0 if omitted) |
timer |
disp |
[<type>] |
Display timer cell
type = a: A timers
type = f: F timers
type = u: U timers |
trcdisp |
brief |
Online display packet content briefly |
parse |
Online parse packet content |
trclog |
call |
Display call event |
clear |
Clear trace |
disp |
Display trace log |
level |
[<level>] |
Display / Set trace level of trace log
level: 1 - 10 |
online |
[<switch>] |
Display / Set trace log online switch |
switch |
[<switch>] |
Display / Set system trace log switch |
type |
[<bitmap>] |
Display / Set trace type of trace log (64 bits) |
trcpacket |
channel |
<chan> [<direction>] |
Display / Set packet trace direction for a given channel
direction: none | incoming | outgoing | bothway |
create |
<entry> <size> |
Create packet trace buffer |
destroy |
Destroy packet trace buffer |
disp |
Display packet trace |
string |
[<switch>] |
Display / Set string display in packet trace switch |
switch |
[<switch>] |
Display / Set packet trace switch |
udp |
<sw|addr|port> |
Send packet trace to other system |
brief |
Display packet content briefly |
parse |
[[<begin>] <end>] |
Parse packet content |
version |
Display RAS code and driver version |
view |
<filename> |
View a text file |
wdog |
switch |
[<switch>] |
Display / Set watchdog timer switch |
cnt |
[<value>] |
Display / Set watchdog counts
value: 0 - 34463 |
AT |
Just answer OK |
ATHE |
Print help |
ATBAx |
Change baudrate
x = 1: 38.4 Kbps (38400 bps)
x = 2: 19.2 Kbps (19200 bps)
x = 3: 9.6 Kbps (9600 bps)
x = 4: 57.6 Kbps (57600 bps)
x = 5: 115.2 Kbps (115200 bps) |
ATENx,[y] |
Set BootExtension Debug Flag
y = password |
ATSE |
Show the seed of password generator |
ATTI[h,m,s] |
Show current time or change system time
h = hours
m = minutes
s = seconds |
ATDA[y,m,d] |
Show current date or change system date
y = year
m = month
d = day |
ATDS |
Dump RAS stack |
ATDT |
Dump Boot Module Common Area |
ATDUx,y |
Dump memory contents from address x for length y |
ATWBx,y |
Write address x with 8-bit value y |
ATWWx,y |
Write address x with 16-bit value y |
ATWLx,y |
Write address x with 32-bit value y |
ATRBx |
Display the 8-bit value of address x |
ATRWx |
Display the 16-bit value of address x |
ATRLx |
Display the 32-bit value of address x |
ATGO[x] |
Run program at addr x or boot router |
ATGR |
Boot router |
ATGT |
Run Hardware Test Program |
AT%Tx |
Enable Hardware Test Program at boot up |
ATBTx |
Block write enable (x=1: enable, other: disable) |
ATRTw,x,y[,z] |
RAM test level w, from address x to y (z iterations) |
ATWEa[,b,c,d] |
Write MAC addr, Country code, EngDbgFlag, FeatureBit to flash ROM |
ATCUx |
Write Country code to flash ROM |
ATCB |
Copy from FLASH ROM to working buffer |
ATCL |
Clear working buffer |
ATSB |
Save working buffer to FLASH ROM |
ATBU |
Dump manufacturer related data in working buffer |
ATSH |
Dump manufacturer related data in ROM |
ATWMx |
Set MAC address in working buffer |
ATCOx |
Set country code in working buffer |
ATFLx |
Set EngDebugFlag in working buffer |
ATSTx |
Set ROMRAS address in working buffer |
ATSYx |
Set system type in working buffer |
ATVDx |
Set vendor name in working buffer |
ATPNx |
Set product name in working buffer |
ATFEx,y,... |
Set feature bits in working buffer |
ATMP |
Check & dump memMapTab |
ATDOx,y |
Download from address x for length y to PC via XMODEM |
ATTD |
Download router configuration to PC via XMODEM |
ATUPx,y |
Upload to RAM address x for length y from PC via XMODEM |
ATUR |
Upload router firmware to flash ROM |
ATLC |
Upload router configuration file to flash ROM |
ATUXx(,y) |
XMODEM upload from flash block x to y |
ATERx,y |
Erase flash rom from block x to y |
ATWFx,y,z |
Copy data from addr x to flash addr y, length z |
ATXSx |
XMODEM select
x = 0: CRC mode (Default)
x = 1: Checksum mode |
ATLOa,b,c,d |
Int/Trap Log Cmd |
ATSR |
System reboot |
If you find any errors or omissions in this document please submit corrections.
Also, if you know or can expand on any of the instructions, commands, definitions,
usage or version number when of any commands were added, removed or changed
then please submit them. It is hoped that this document will grow to become
a single point of reference for ZyNOS Command Interface usage.