Professional Documents
Culture Documents
June 2005
Command Line Interface User’s Guide
Paradyne Corporation makes no representation or warranties with respect to the contents hereof and specifically
disclaims any implied warranties of merchantability or fitness for a particular purpose. Further, Paradyne Corporation
reserves the right to revise this publication and to make changes from time to time in the contents hereof without
obligation of Paradyne Corporation to notify any person of such revision or changes.
Changes and enhancements to the product and to the information herein will be documented and issued as a new
release to this manual.
Internet: Visit the Paradyne World Wide Web site at www.paradyne.com. (Be sure to register your warranty at
www.paradyne.com/warranty.)
Telephone: Call our automated system to receive current information by fax or to speak with a company
representative.
Within the U.S.A., call 1-800-870-2221
Outside the U.S.A., call 1-727-530-2340
Document Feedback
We welcome your comments and suggestions about this document. Please mail them to Technical Publications,
Paradyne Corporation, 8545 126th Ave. N., Largo, FL 33773, or send e-mail to userdoc@paradyne.com. Include
the number and title of this document in your correspondence. Please include your name and phone number if you
are willing to provide additional clarification.
Trademarks
Acculink, ADSL/R, Bitstorm, Comsphere, DSL the Easy Way, ETC, Etherloop, FrameSaver, GranDSLAM,
GrandVIEW, Hotwire, the Hotwire logo, Jetstream, MVL, NextEDGE, Net to Net Technologies, OpenLane, Paradyne,
the Paradyne logo, Paradyne Credit Corp., the Paradyne Credit Corp. logo, Performance Wizard, ReachDSL,
StormPort, TruePut are registered trademarks of Paradyne Corporation. Connect to Success, Hotwire Connected,
iMarc, JetFusion, JetVision, MicroBurst, PacketSurfer, Quick Channel, Reverse Gateway, Spectrum Manager, and
StormTracker are trademarks of Paradyne Corporation. All other products and services mentioned herein are the
trademarks, service marks, registered trademarks, or registered service marks of their respective owners.
2 1800-A2-GB20-00
Command Line Interface User’s Guide
Preface
This instruction guide introduces the command line interface (CLI) for the Telnet management
of the 1813 and 1823 VoIP Gateways, the 1862 SIP IAD, and 6212 Router. If your device has a
console port, you can also access the CLI from a VT100 terminal or equivalent (such as a PC
running Hyperterminal or Telix).
This manual is written for a range of ADSL products. Some specific commands may not be
available for all devices. For example, wireless functions will only be available for products with
wireless functionality.
See the user’s guide for your device for information about web-based management.
1800-A2-GB20-00 3
Command Line Interface User’s Guide
Table of Contents
4 1800-A2-GB20-00
Command Line Interface User’s Guide
1800-A2-GB20-00 5
Command Line Interface User’s Guide
6 1800-A2-GB20-00
Command Line Interface User’s Guide
1800-A2-GB20-00 7
Command Line Interface User’s Guide
8 1800-A2-GB20-00
Command Line Interface User’s Guide
1800-A2-GB20-00 9
Command Line Interface User’s Guide
The Command Line Interface (CLI) can be used to configure your endpoint device. Telnet is
used to access the CLI.
To Telnet to the device, you can either set your PC’s IP address to the same domain as the
endpoint, or set the endpoint’s IP address to the same domain as your PC. The default IP address
of the endpoint is 192.168.1.1.
The timeout period of the Telnet session is three minutes. If no command is entered for three
minutes, the Telnet session is terminated.
To log on to the device using Telnet, your PC and the endpoint should both be on the same
network segment. You can either modify the IP address of your PC to the same domain of the
endpoint, or modify the IP address of the endpoint to the same domain as your PC.
You can modify the IP address of the endpoint by completing the following steps:
STEP 1: Enter a management tool (http or cli) for your endpoint
STEP 2: Change the IP address to the same domain as your workstation.
STEP 3: Save the settings to the flash and reboot the endpoint.
10 1800-A2-GB20-00
Command Line Interface User’s Guide
You can modify the IP address of your PC by from its TCP/IP definition. Follow the steps
below:
STEP 1: Enter the TCP/IP screen. (Under Windows XP, for example, click on Control Panel
from the Windows Start menu. Double-click on Network Connections.Right-click on
Local Area Connection and select Properties. Then select Internet Protocol and select
Properties.)
STEP 2: Change the IP address to the same domain as your endpoint (which has a default
address of 192.168.1.1 and a default subnet mask of 255.255.255.0). For example:
1800-A2-GB20-00 11
Command Line Interface User’s Guide
1.2 Login
To access Telnet to manage your endpoint, complete the following steps: The default IP address
is 192.168.1.1. Use the default IP address to log on to the endpoint if it was not changed.
STEP 1 Make sure that the endpoint and your PC are on the same network
segment.
STEP 4 You will be prompted to enter a User Name and Password. Enter
root
for the User Name and
1234
for the Password.
STEP 5 The first prompt of the CLI interface appears. The prompt shows the
user name (ex. 1234) used to log to the endpoint.
login: root
Password:
[1234@ home]$
Note: If you fail to access the endpoint, make sure both your PC and the endpoint are in the same IP
domain. If you do not know the endpoint’s IP address, press the recessed button on the rear
panel to restore the default LAN IP address (192.168.1.1).
12 1800-A2-GB20-00
Command Line Interface User’s Guide
All the system commands for various modules are organized in different directories. All these
directories are put under the directory called home. However, they can be listed using the ls
command. All the administration commands are put in home/auth. The current working
directory’s name is included in the command prompt (for example, [1234@bridge]$).
Each prompt consists of two parts: user name and directory. The two parts are divided by the
character @. For example, in the prompt 1234@bridge the first part (1234) is the user logged to
the endpoint. The second part (bridge) shows the current working directory.
The commands in the CLI are case sensitive.
1800-A2-GB20-00 13
Command Line Interface User’s Guide
2.2 Generic
The CLI provides generic commands for navigating between directories, listing the commands in
a directory, and providing help. All the generic commands can be executed from any directory.
2.2.1 ls
ls
When you enter a directory, you can use the ls command to display the available commands. It
lists all the commands registered in the current working directory.
EXAMPLE
[1234 @ ethernet]$ ls
A <CMD> setemac
A <CMD> rmon
A <CMD> pread
A <CMD> pwrite
A <CMD> elink
A <CMD> up
A <CMD> down
A <CMD> stat
[1234 @ ethernet]$
2.2.2 help
The help command is useful when you are not sure of the functions and usages of a command. It
displays help and usage text for the specified command. If nothing is specified, it displays help
text for all general commands.
The following line is an example usage of the help command you type at the home prompt.
[1234 @ home]$ help –o <command>
EXAMPLE
14 1800-A2-GB20-00
Command Line Interface User’s Guide
The following screen is an example of displaying the usage for the rip command.
[1234 @ home]$ help -o rip
DESCRIPTION
Contains RIP related commands
USAGE
rip
2.2.3 accountstats
accountstats modulename
This command displays accounting details of the specified module.
2.2.4 exit
exit
If the user is working in the home directory, the session is closed. Otherwise exit changes the
working directory to its immediate parent directory.
2.2.5 version
version
This command displays the endpoint software version.
EXAMPLE
[1234 @ home]$ version
WLAN Gateway SoftwareV1.6.9
1800-A2-GB20-00 15
Command Line Interface User’s Guide
2.2.6 date
date
This command displays the endpoint date and time.
EXAMPLE
[1234 @ home]$ date
DATE (MM:DD:YYYY) 1:10:2002 TIME (H:M:S) 4:56:59
2.2.7 erase
erase
This command erases all the configurations in the system. That means the factory default settings
are retrieved.
2.2.8 save
save
This command saves the current configurations into flash memory. The current configurations
will be available after the system is booted or reset.
2.2.9 reboot
reboot
This command restarts the endpoint. You must reconnect to the endpoint after you run this
command. The endpoint will be rebooted with the saved configurations on the flash. If you
reboot the endpoint without saving the changes, those parameters will be lost.
2.2.10 ping
ping address [ -o [ -s size ] ]
The utility ping utilizes the ICMP protocol's ECHO_REQUEST datagram to elicit an ICMP
ECHO_RESPONSE from the specified host or network gateway. If the host responds, ping will
print the response. By default, the ping command will send four ping requests to the host. This
diagnostic function can verify if the remote host is reachable for Telnet or FTP purposes.
If data size is not specified in the command, it will try 64 bytes for four times.
16 1800-A2-GB20-00
Command Line Interface User’s Guide
COMMAND DESCRIPTION
address
destination IP address you wish to ping in the form x.x.x.x, where each x is a decimal number 0
to 255.
size
Data size to ping the host. The accepted size is 56 bytes to 1492 bytes.
EXAMPLE
2.2.11 time
time
The time command reveals the elapsed time of how long the endpoint is powered on.
EXAMPLE
[1234 @ home]$ time
System Elapse Time : 23:21:46:
[1234 @ home]$
1800-A2-GB20-00 17
Command Line Interface User’s Guide
2.3 logger
logseverity
log
logftpserver
loginfo
logadd
2.3.1 logSeverity
logseverity -o error/info on/off
This command is used to set the trace for the log severity level.
COMMAND DESCRIPTION
error/info
This option specifies the severity level.
on/off
This option specifies weather the trace is set or not.
EXAMPLE
logseverity -o error on
This command will set the trace for the log level “error”.
2.3.2 log
log -o [ [all] / [<modulename>] [<loglevel>]]
This command is used to display the logged messages. The logged messages will be displayed
based on the specified module name or the log level or both the module and log levels.
COMMAND DESCRIPTION
<loglevel>
18 1800-A2-GB20-00
Command Line Interface User’s Guide
EXAMPLE
log –o all
This command will displays all the logged messages.
log –o firewall
This command will display messages logged from the firewall module.
log –o error
This command will display messages logged based on the log level “error”.
2.3.3 logFtpServer
logFtpServer [server_address] [username] [password]
This command is used to configure the ftp server address, user login and password to store the
logger messages.
EXAMPLE
logftpserver 192.168.1.100 snaidu 12345
This command will configure the ftp server address as 192.168.1.100, username as snaidu and
password as 12345. While uploading the logged messages it opens a connection to the ftp server
on 192.168.1.100 and login as “snaidu”. Then it will store the log messages in the file named
“fwlogfile”.
2.3.4 loginfo
loginfo
1800-A2-GB20-00 19
Command Line Interface User’s Guide
This command displays the configured logger information. This will contain the trace
information, ftpserver, and login information.
EXAMPLE
A default user account is provided to configure, maintain, and operate the endpoint in HTTP
(web), CLI, and FTP modes. The default user name is 1234, and the default password 1234. To
add, modify, delete, or list the user name and password, enter the auth directory.
[1234 @ home]$ auth
At the auth directory, you can use the ‘ls’ command to display the available commands:
A <CMD> adduser
A <CMD> deluser
A <CMD> changepasswd
A <CMD> modifyuser
A <CMD> listusers
A <CMD> resetuser
[1234 @ auth]$
There are three management modes and two access privileges. The three modes are cli, http, and
ftp. The cli and http modes provide full parameters to configure, maintain, operate, and monitor
the endpoint. The ftp mode only allows software upgrade, configuration upgrade, and
configuration backup.
20 1800-A2-GB20-00
Command Line Interface User’s Guide
The two access privileges are admin and ordin. The admin privilege provides full right including
read and write accesses. The ordin privilege only allows reading and monitoring the parameters
via http or cli. An ftp user must have an admin privilege.
adduser
Adds a new user to the system. This command asks to set password for the user. Only
administrators can use this command.
EXAMPLE
[1234 @ auth]$ adduser mrpizza -o -services cli -permissions ordin
Enter password:
Confirm password:
User Name Succesfully Added.
[1234 @ auth]$
deluser
Deluser <username>
Enter this command followed by the name of the user to be deleted. Only administrators can use
this command.
EXAMPLE
[1234 @ auth]$ deluser mrpizza
Successfully Deleted
[1234 @ auth]$
modifyuser
modifyuser <username> -o
-addservices <cli | ftp | http>
-delservices <cli | ftp | http>
-permissions <admin | ordin>
1800-A2-GB20-00 21
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<username>
The name of the user whose services or permissions are to be modified.
EXAMPLE
-addservices <cli | ftp | http>
Adds cli, ftp, or http services to the user.
-delservices <cli | ftp | http>
Removes cli, ftp, or http services from the user.
modifyuser xyz –o -addservices ftp -permissions ordin
Allows user “xyz” ordinary permissions to access the system via ftp. In addition, gives the user
“xyz” ordinary permissions. In other words user “xyz” is not an administrator.
modifyuser abc -o -delservices http
Prohibits user “abc” from accessing the system via http.
modifyuser xyz -o -addservices ftp delservices http -permissions ordin
Allows user “xyz” to access the system via ftp and prohibits that user from accessing the system
via http. In addition, gives the user “xyz” ordinary permissions. In other words user “xyz” is not
an administrator.
changepasswd
changepasswd <username>
Changes password of the existing user. This is an administrators command; ordinary users can
not use this. This command prompts for entering the old password before setting up the new
password.
EXAMPLE
[1234 @ auth]$ changepasswd
changepasswd username
[1234 @ auth]$ changepasswd pppoe
Enter old password:
Enter New password:
Confirm New password:
Password changed
[1234 @ auth]$
The command changes the password for user “pppoe.”
22 1800-A2-GB20-00
Command Line Interface User’s Guide
listusers
listusers
The listusers command lists all registered users to use cli/http/ftp.
EXAMPLE
[1234 @ auth]$ listusers
1 1234 cli http ftp ADMIN
2 pppoe http ADMIN
3 maylyne ORDIN
4 may ORDIN
5 pizza cli ftp ADMIN
[1234 @ auth]$
resetuser
The resetuser command resets the user password. This is an administrators command; ordinary
users can not use this. This command won’t prompt for inputting the old password while
command “changepasswd” will.
EXAMPLE
[1234 @ auth]$ resetuser pppoe
Enter New password:
Confirm New password:
Password changed
[1234 @ auth]$
Resets the password for user “pppoe.”
There are two configurable Ethernet interfaces, identified with eth0 and eth1 in CLI. Each
Ethernet interface provides two default IP addresses.
z Interface eth0- 192.168.1.1 (primary) and 192.168.1.2 (alias)
1800-A2-GB20-00 23
Command Line Interface User’s Guide
To set up an IP address and subnet mask for the Ethernet interface, use the following command
after the prompt of [1234 @ home]$.
ifconfig -o <interface-name> inet <address> [parameters]
ifconfig -o -a displays the information of the interfaces
ifconfig -o -l
parameters- mtu <n 72-1500>, broadcast <address>, netmask <mask>, up, down
COMMAND DESCRIPTION
<interface name>
The LAN interface to be configured. Type eth0 for Interface Ethernet 1, and type eth0 for
Interface Ethernet 2.
<address>
The IP address or subnet mask to be assigned to the interface. Dot-notation is used to enter the IP
address (for example 192.168.2.1).
netmask <mask>
The netmask is used to extract the network portion of the IP address. It also specifies how much
of the IP address is to be reserved for subdividing the network into sub networks, which are
taken from the host field of the address. Netmask is added with the interface IP address to get a
network ID that is used in routing to indicate that this network is reachable through these
interfaces. The mask can be specified as a single hexadecimal number with a leading 0x for
example 0xffffff00, or with a dot-notation Internet address 255.255.255.0
alias <address>
To add the alias IP address
-alias <address>
To delete the alias IP address
After typing the command, the home prompt displays. Save the changes by typing save. The
following message displays and shows that the changes are successful.
Configuration saved successfully
24 1800-A2-GB20-00
Command Line Interface User’s Guide
EXAMPLE
[1234 @ home]$ ifconfig -o eth0 inet 172.1.1.1 alias netmask 255.255.255.0
The above example assigns an alias IP address of 172.1.1.1 with a 24-bit subnet mask to the eth0
interface.
[1234 @ home]$ ifconfig -o <interface name> inet <address> -alias netmask <address>
To delete the alias IP address, use this command:
2.6 Rarpd
add
list
rarpd
delete
The rarpd commands are put in the rarpd directory, used to get the IP address of diskless system.
2.6.1 add
add <0xH/Waddress > <IPAddress >
Used to add Hardware address and IP address into the DataBase.
COMMAND DESCRIPTION
<0xH/Waddress >
Hardware address in hexadecimal format.
<IPAddress >
IP address in dot notation.
1800-A2-GB20-00 25
Command Line Interface User’s Guide
EXAMPLE
add 0x112233445566 192.168.3.4
Adds the H/W address and IP Address mapping in the database.
2.6.2 delete
delete <0xH/Waddress >
Deletes an entry in the existing RARP DataBase.
<0xH/Waddress >
Hardware address in hexadecimal format.
EXAMPLE
delete 0x112233445566
Deletes mapping of H/W address 11:22:33:44:55:66 to IP Address, from the database.
2.6.3 list
list
Lists the RARP DataBase entries.
EXAMPLE
[1234 @ rarpd]$ list
H/W ADDR IP ADDRESS
11:22:33:44:55:66 192.168.3.4
26 1800-A2-GB20-00
Command Line Interface User’s Guide
2.6.4 rarpd
rarpd <-a | interface>
The rarpd command starts the RARPD on the specified interface or all the interfaces.
EXAMPLE
rarpd eth0
This command starts the RARPD on eth0 interface.
rarpd eth0
If RARPD is already running the above command, it displays: “Rarpd is already running on the
interface”
rarpd -a
This command starts the RARPD on all the interfaces.
2.7 timeout
COMMAND DESCRIPTION
<seconds>
the timeout period in seconds, which can be up to 300 seconds.
EXAMPLE
timeout -t 300
The command configures the timeout period to 300 seconds.
2.8 baudrate
baudrate <value>
1800-A2-GB20-00 27
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<value>
The baud rate of the console session. 0 represents 9600 bps; 1 represents 38400 bps; 2 represents
57600 bps. 3 represents 115200 bps.
EXAMPLE
baudrate 3
28 1800-A2-GB20-00
Command Line Interface User’s Guide
This chapter describes how to configure the endpoint for the first time using the CLI. The
endpoint can work after these settings are complete.
To enable the bridging function of the endpoint, enter the sndcp directory from the prompt of
[1234 @ sndcp]$. In the sndcp directory, type bridge to enter the bridge directory.
3.1.1 PART 1 Create a PVC
1. Type atm at the home prompt to enter the atm directory.
3. At the atm prompt, type home or exit to return to the home prompt.
1800-A2-GB20-00 29
Command Line Interface User’s Guide
6. If the bridge prompt pops up, a PVC 0/35 is successfully enabled for the RFC 1483 Bridged
mode.
There are two major parts to set up a RFC 1483 Bridged PVC. The first part is to add a PVC
under the atm directory. The second part is to assign the new PVC to the RFC1483 Bridged
mode under the bridge directory. The following is an example of adding an RFC1483 Bridged
PVC at 0/35.
3.2.1 PART 1 Create a new VC
1. Type atm to enter the home prompt.
2. Type vcadd 0 35 ubr aal5
30 1800-A2-GB20-00
Command Line Interface User’s Guide
3. At the atm prompt, type home or exit to return to the home prompt.
2. If the Ethernet IP address is successfully set up, the home prompt pops up.
1800-A2-GB20-00 31
Command Line Interface User’s Guide
3.3 IPoA
3. At the atm directory, type home or exit to return to the home prompt.
EXAMPLE
32 1800-A2-GB20-00
Command Line Interface User’s Guide
4. If the sndcp prompt pops up, a PVC 0/35 is successfully created for the IPoA mode.
3.4 PPPoE
3. At the atm prompt, type home or exit to return to the home prompt.
1800-A2-GB20-00 33
Command Line Interface User’s Guide
The pppoe command covers the settings for the PPPoE entry number, encapsulation type,
timeout period, authentication, user name, password, VPI, VCI, and NAT. You can complete a
PPPoE entry by typing this command that covers these basic settings. If you need a complete
setting, refer to the usage instruction above.
4. If the sndcp prompt pops up, a PVC 0/35 is successfully created for PPPoE mode.
34 1800-A2-GB20-00
Command Line Interface User’s Guide
3.5 PPPoA
3. At the atm prompt, type home or exit to return to the home prompt.
.
3.5.2 PART 2 Set the PVC to PPPoA
1800-A2-GB20-00 35
Command Line Interface User’s Guide
The pppoa command covers the basic settings for the PPPoA profile number, encapsulation
type, timeout period, authentication, user name, password, VPI, VCI, and NAT. You can
complete a PPPoA entry by typing this command that covers these basic settings. If you need a
complete setting, refer to the usage instruction above.
4. If the sndcp prompt pops up, a PVC 0/35 is successfully created for PPPoA mode.
3.6 MER
3. At the atm prompt, type home or exit to return to the home prompt.
36 1800-A2-GB20-00
Command Line Interface User’s Guide
3. Type 1483mer to display the command to set up an MER entry. The command usage is
shown below. For the port parameter specified in the command, always type mer0. Only one
MER entry can be created.
EXAMPLE
4. If the sndcp prompt pops up, a PVC 0/35 is successfully created for MER mode.
2. If the WAN IP address is successfully set up, the home prompt pops up.
To delete the PVC set up for the MER, you must delete the profile first under the sndcp prompt.
Secondly, delete the VC under the atm prompt. The following screen is an example.
1800-A2-GB20-00 37
Command Line Interface User’s Guide
SIP Configuration
4.1.1 Configuration
Command syntax:
confighost <Interface> -o [-up <useproxy(yes/no)>]
Usages:
This command configures binding interface and proxy info for Host.
Description:
Interface: Binding interface of SIP User-Agent
useproxy: Option of Using Proxy/Registrar server if it is configured.
Example:
confighost eth0
confighost eth0 –o –up yes
4.1.2 Displaying
Command syntax:
listhost
Usages:
Display the Configured Host information.
Example:
####HostINFO####
38 1800-A2-GB20-00
Command Line Interface User’s Guide
4.2.1 Configuration
Command syntax:
configproxyreg <proxy/register Addr> -o [-p <proxy/register
Port>]
Usages:
This command configures the Proxy/Registrar Server host address and Port
Number.
Description:
Address: Ip Address or FQDN of outbound SIP-Proxy/Registrar server .
Port: Port Number of SIP-Proxy server where it will Receive all the SIP
messages.
Default Port Number is 5060.
Example:
configproxyreg 192.168.1.254
configproxyreg 192.168.1.254 -o -p 5060
4.2.2 Displaying
Command syntax:
listproxyreg
Usages:
Display the Configured Proxy/Registrar Server information.
4.3.1 Configuration
Command syntax:
configdomain <Domain>
Usages:
1800-A2-GB20-00 39
Command Line Interface User’s Guide
4.3.2 Displaying
Command syntax:
listdomain
Usages:
Display the Configured Domain information.
Example:
#### Domain LIST ####
Domain
---------------------
paradyne.com
4.4.1 Configuration
Command syntax:
configcodecs -o [PCMU] [PCMA] [G729]
Usages:
This command configures Codecs to be supported for the configured User-
Agent.
Description:
PCMU, PCMA, G729 : Name of the Codecs
Example:
configcodecs –o PCMU PCMA G729
40 1800-A2-GB20-00
Command Line Interface User’s Guide
4.4.2 Displaying
Command syntax:
listcodecs
Usages:
Displays all the Configured Codecs.
Example:
#### CODECS INFO ####
4.5 Phone
4.5.1 Configuration
Command syntax:
configphone <portNumber> <phoneUserName> -o [-d<DispName>]
[-e<expires>] [-q<qvalue>] [-c<PreferCodec>]
Usages:
This command Configures sip parameter required to build SIP messages for
phone(s) attached to SIP UA to send signaling information to peer.
Description:
portNumber: port number of the SIP UA to which Phone is attached.
Presently Valid values are 1or 2.
phoneUserName: Name of the User who is using the phone connected to
above portNumber.
phoneDisplayName:
Display Name of the above user.
expires: Time period for registering to Registrar/ProxyServer.
PreferCodec: preferred codec of this user.
Qvalue: Preference for the phone registered to proxy/registrar.
Example:
configphone 1 600 -o -c PCMU
1800-A2-GB20-00 41
Command Line Interface User’s Guide
4.5.2 Displaying
Command syntax:
listphones
Usages:
Display the Configured sip parameters of all the configured phones.
Example:
#### PHONELIST ####
Buddy List (List of remote user(s) one wish to call, only works when not using proxy)
4.5.3 Configuration
Command syntax:
addbuddy <speeddial> <userName> <destIPAddr> -o [-d<displayName>] [-p<destPort>]
Usages:
The BUDDY LIST is used to setup SIP URI of the parties that one wish to call.
Description:
speeddial: is speedDial number which maps to remote party SIP-URI after
dialing on key/phone pad.This should be unique for different SIP-URI.
userName: Name of the remote User who is to be contacted.
destIPAddr: is the IP address of the party one wish to call.
displayName: Display Name of the above remote user.
42 1800-A2-GB20-00
Command Line Interface User’s Guide
4.5.4 Displaying
Command syntax:
listbuddy
Usages:
List all the Configured buddy with their information .
Example:
#### BUDDYLIST####
4.5.5 Deleting
Command syntax:
deletebuddy <index>
Usages:
Delete the Configured buddy information in the Buddy List according the specified
index.
Example:
deletebuddy 1
4.6.1 Configuration
Command syntax:
configcf <portnumber> <username> <Host Ipaddr>
Usages:
The configcf command is used to configure the call forward information for the
particular phone.
Description:
portnumber: phone port number for which the configuration will be done.
Presently Valid values are 1or 2.
1800-A2-GB20-00 43
Command Line Interface User’s Guide
username: Sip User name of the forwarding address where the calls will
be forwarded.
Host Ipaddr: Sip host addr of the forwarding address where the calls will
be forwarded.
Example:
Configcf 1 102 192.168.1.102
Command syntax:
callforward <portnumber> -o [-cf <yes/no>] [-uf <yes/no>]
Usages:
To enable call forward to the given port only when the configuration is done.
Example:
callforward 1 -o -cf yes -uf yes
4.6.2 Displaying
Command syntax:
listcf
Usages:
List all the call forward information.
Example:
#### Call forward configuration ####
port Cf_flag Uf_Flag User_Name Host_Ipaddr NumRings
-----------------------------------------------------------
1 YES YES 102 192.168.1.102 5
4.7 Authentication
4.7.1 Configuration
Command syntax:
configauth <portNumber> <username> <password>
Usages:
44 1800-A2-GB20-00
Command Line Interface User’s Guide
4.7.2 Displaying
Command syntax:
listauth
Usages:
Display the authentication information.
Example:
#### AUTHLIST####
---------------------------------
1 123 abc
4.8 Registration
Command syntax:
register <PortNumber>
Usages:
send Register request to Registrar server and phone corresponding to the port
number is registered with proxy/registrar.
Description:
portNumber: port number of the Phone connected to SIP UA.
1800-A2-GB20-00 45
Command Line Interface User’s Guide
Command syntax:
digitimeout <sec>
Usages:
Used to set inter digit timeout value.
Description:
sec: Inter digit timeout value, valued value are from 1 to 10, 0 to disable.
Example:
digitimeout 4
Command syntax:
maxrings <num>
Usages:
Used to set max ring numbers for call forward on no reply/answer.
Description:
num: Number of rings for activating CFNR.
Example:
maxrings 5
46 1800-A2-GB20-00
Command Line Interface User’s Guide
Command syntax:
dialplan -o list
dialplan -o add <dialnumber> <outnumber>
dialplan -o del <index>
Usages:
Used to configure dialplan for converting dialed digits to out-dialing digits.
Description:
dialnumber: User dialed digits.
outnumber: Out-dialing digits.
Example:
dialplan –o add xxxx 555xxxx
dialplan –o add 949xxxxxxx xxxxxxx
Command syntax:
voiceopt -o -vad <on/off> -plc <on/off> -ec <on/off> -t
<val>
Usages:
Configuring voice options parameters.
Description:
vad: Voice Active Detection.
plc: Packet Lose Concealment.
ec: Echo Cancellation
t: Echo Cancellation Tail Length
Example:
voiceopt -o -vad off -plc on -ec on -t 20
1800-A2-GB20-00 47
Command Line Interface User’s Guide
4.12.3 Country
Command syntax:
countryopt -o -c <country>
Usages:
Used to set/display country options.
Description:
country: Specifies the country.
AUSTRALIA, FRANCE, GERMANY, JAPAN, NETHERLANDS, SPAIN,
TAIWAN, USA
Example:
countryopt -o -c TAIWAN
48 1800-A2-GB20-00
Command Line Interface User’s Guide
1800-A2-GB20-00 49
Command Line Interface User’s Guide
To set up the static route, type route at the prompt to display the static route commands. These
commands are used to add, delete, modify, and flush the static route table.
route add -o -dest {dest ip addr} -gateway {gateway ip addr} [{-option value}*]
route add -o -dest {dest ip addr} -interface {interface name} [{-option value }*]
route delete -o -dest {dest ip addr}
route change -o -dest {dest ip addr} -gateway {new ip addr}
route get -o -dest {ip addr}
route flush
options : mtu & hopcount &netmask
The command route add -o -dest {dest ip addr} -interface {interface name} [{-option value
}*] is reserved only.
EXAMPLE
50 1800-A2-GB20-00
Command Line Interface User’s Guide
5.2 Ethernet
The ethernet command is used to configure the Ethernet interface parameters. Ethernet
commands are located in the “ethernet” directory.
setemac
rmon
pread
pwrite
elink
up
down
stat
5.2.1 MAC Address
setemac <xx:xx:xx:xx:xx:xx>
This sets up the MAC address. In order for the MAC changes to take effect, the configuration
must be saved (using ‘save’command in the home directory) and the system rebooted.
< xx:xx:xx:xx:xx:xx >
The MAC address in colon separated notation. Two hex digits must be supplied between the
colons. Twelve hex digits comprise a MAC address. (i.e. “aa:bb:cc:01:22:05”).
EXAMPLE
1800-A2-GB20-00 51
Command Line Interface User’s Guide
5.2.2 rmon
This command reads the MAC RMON counters. Type rmon eth0 at the prompt to collect the
Ethernet interface statistics.
5.2.3 pread
pread <interface> <port(decimal)>
Reads PHY register
EXAMPLE
[1234 @ ethernet]$ pread eth0 1
Register 1 value 0xffff
Displays the register 1 value of eth0 interface.
5.2.4 pwrite
[1234 @ ethernet]$ pwrite <interface> <port(decimal)> <value(hex)>
Writes PHY register
52 1800-A2-GB20-00
Command Line Interface User’s Guide
5.2.5 elink
elink <interface> -o [[auto] | [10 | 100 | auto_speed ] | [half | full | auto_duplex]
The elink command configures the speed and/or duplex of the Ethernet interface. The default
setting is auto for auto negotiation. With auto negotiation, both the speed and duplex are
configured based upon what the link is connected to. It is also possible to configure the duplex,
say half and full, and specify auto_speed so that only the speed is auto negotiated. Similarly for
auto_duplex.
COMMAND DESCRIPTION
<interface>
The name of the Ethernet interface. This is eth0.
Auto
This specifies that both the speed and duplex are auto negotiated.
10
This specifies that the speed is set to 10M bits per second.
100
This specifies that the speed is set to 100M bits per second.
auto_speed
This specifies that the speed is auto negotiated.
half
This specifies half duplex
full
This specifies full duplex
auto_duplex
This specifies that the duplex is auto negotiated.
EXAMPLE
[1234 @ ethernet]$ elink eth0 -o 10 half
This command sets the Ethernet to a speed of 10Mbps half duplex.
[1234 @ ethernet]$ elink eth0 -o auto_speed full
The speed will be auto negotiated and the link will use full
1800-A2-GB20-00 53
Command Line Interface User’s Guide
5.3 Bridge
The bridge commands sets up the bridge functions, covering the following commands. They are
located in the “bridge” directory.
arpproxy
pvc
group
group3
cachetimer
setmultiport
list
stats
bridge
vstats
vlantable
vlanmode
fdbmode
igmpsnooping
stp
filter
filterlist
filterflush
l2_list
l2_fil
5.3.1 arpproxy
arpproxy [on/off]
The arpproxy command enables or disables the ARP (Address Resolution Protocol) proxy (L3
bridging)
COMMAND DESCRIPTION
on
This enables the ARP proxy
54 1800-A2-GB20-00
Command Line Interface User’s Guide
off
This disables the ARP proxy
5.3.2 pvc
pvc add/delete port vpi vci encapsulation -o <-vpn OUI vpnId>
The pvc command attaches a PVC to the WAN interface.
COMMAND DESCRIPTION
add
This adds the specified PVC to the bridge.
delete
This deletes the specified PVC to the bridge.
<port>
A string identifying the wan interfaces e.g. atm0.
<vpi> <vci>
Virtual Path Identifier and Virtual Circuit Identifier for the ATM connection.
<encapsulation>
This specifies the encapsulation type. The possible values are llc or vc which represent Logical
Link Control or VC multiplexing respectively.
- vpn OUI vpnId
Enable VPN Encapsulation on this interface. The OUI (Organizationally Unique Identifier) and
VPN identifier are specified as numbers.
5.3.3 group
group if if
group if if –o if
The group command assigns or groups two interfaces or three interfaces to the bridge. To group
two interfaces, use the command:
group if if
To group three interfaces, use the command
group if if –o if
1800-A2-GB20-00 55
Command Line Interface User’s Guide
If the bridge group was already set up, to configure the new group, delete the previous group by
using the bridge delete command, and then group the new interfaces you wish to the bridge.
The group and group3 commands are similar functions, but they group different number of
interfaces to the bridge.
COMMAND DESCRIPTION
interface_name
The name of an interface e.g. eth0, atm0… atm1 etc.
EXAMPLE
group eth0 atm0
The interfaces eth0 and atm0 are assigned to the bridge.
group eth0 atm0 –o atm1
The interfaces eth0, atm0, and atm1 are assigned to the bridge.
5.3.4 group3
group if if if
group if if if –o if
The group command assigns or groups three interfaces or four interfaces to the bridge. To group
three interfaces, use the command:
group if if
56 1800-A2-GB20-00
Command Line Interface User’s Guide
If the bridge group was already set up, to configure the new group, delete the previous group by
using the bridge delete command, and then group the new interfaces you wish to the bridge.
COMMAND DESCRIPTION
interface_name
The name of an interface e.g. eth0, atm0… atm1 etc.
EXAMPLE
group eth0 atm0 atm4
The interfaces eth0, atm0, and atm4 are assigned to the bridge.
group eth0 atm0 atm2 atm4–o atm5
The interfaces eth0, atm0, atm2, atm4, and atm5 are assigned to the bridge.
5.3.5 cachetimer
cachetimer <timeout>
Specifies the idle timeout for bridge table entries. The timeout value is in seconds. Whenever
there is any traffic passing through bridge, bridge will maintain the lookup table with the MAC
addresses coming from configured interface( through LAN). If the traffic is destined to any
MAC address which is found in the lookup table, that packet is not sent to the ATM interface. If
there is no traffic from particular machine for certain time period then that entry is deleted from
the lookup table. The time that the bridge will clear the bridge lookup entry is the cachetimer
timeout.
5.3.6 setmultiport
setmultiport enable | disable
Enables or disables flooding between ATM PVCs.
1800-A2-GB20-00 57
Command Line Interface User’s Guide
5.3.7 list
list
Lists bridge parameters.
EXAMPLE
5.3.8 stats
stats
Displays bridge statistics.
EXAMPLE
5.3.9 bridge
bridge enable | disable | delete
Enables, disables, or deletes the configuration of the bridge.
5.3.10 vstats
vstats
lists the VLAN groups.
58 1800-A2-GB20-00
Command Line Interface User’s Guide
5.3.11 vlantable
vlantable groupNumber(0 - 3) -o ethernetPort(1 - 4) -atm vci vpi
configures the VLAN groups. Up to four groups (0-3) can be set up, and four Ethernet ports (0-
3) can be joined to these groups.
COMMAND DESCRIPTION
groupNumber(0 - 3)
There are four groups. Use the number (0-3) to represent each group.
ethernetPort[0] -> Link4
ethernetPort[1] -> Link3
ethernetPort[2] -> Link2
ethernetPort[3] -> Link1
ethernetPort(0 - 3)
Each LAN interface can only be attached to one VLAN.
0- Ethernet port 1
1- Ethernet port 2
2- Ethernet port 3
3- Ethernet port 4
vci vpi
Type the VCI/VPI value for the VLAN. You can only select from values that have been
configured as Bridge mode on the WAN interface.
EXAMPLE
vlantable 0 -o 0 1 2 3 -atm 0 33
5.3.12 vlanmode
vlanmode [on/off]
Enables or disables VLAN. After VLAN is enabled, also configure it’s functions like fdbmode,
igmpsnooping, and
COMMAND DESCRIPTION
1800-A2-GB20-00 59
Command Line Interface User’s Guide
on
enables VLAN
off
disables VLAN
5.3.13 fdbmode
fdbmode [single/multi]
configures the forwarding database learning type.
COMMAND DESCRIPTION
multiple
The learned entries will be distributed to five databases, (VLAN 1~4 and non-VLAN)
single
The learned entries will be collected into a single database.
5.3.14 igmpsnooping
igmpsnooping on/off
Enables or disables IGMP snooping for VLAN.
COMMAND DESCRIPTION
on
enables IGMP snooping
off
disables IGMP snooping
5.3.15 stp
The spanning tree commands are located in the “stp” directory (which is located in the “bridge”
directory).
port
60 1800-A2-GB20-00
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<portname>
A string identifying the port e.g. eth0, atm0
-priority <priority>
A positive integer indicating the port priority. Must be a value between 0 and 255.
-linkcost <linkcost>
A positive integer indicating the cost associated with the port. The value can range from 0 to
65535.
EXAMPLE
port eth0 -o -priority 20 -linkcost 100
Assigns a priority of 20 to Eth0 with a linkcost of 100.
config
COMMAND DESCRIPTION
-priority <priority>
The priority of the individual bridge. The value can range from 0 to 65000.The lower the
number, more the priority.
-hellotime <hellotime>
The time interval between HELLO bridge protocol data unit. The time interval can be any value
between 1 to 10 seconds.
-maxagettime <maxagettime>
The maximum age of the stored BPDUs. The time interval can be any value between 1 and 60
seconds.
-fwddelaytime<fwddelaytime>
The time spent by bridge in the listening and learning state before moving to learning or
forwarding state respectively. The time interval can be any value between 10 and 200 seconds.
1800-A2-GB20-00 61
Command Line Interface User’s Guide
span
list
Lists the spanning tree configuration.
5.3.16 filter
filter <action> <mac_address> -o [-fwd | -drop]
Configures the filtering capability of MAC addresses for the bridge. Up to 128 addresses may be
specified.
COMMAND DESCRIPTION
<action>
Action may be add, delete, or modify.
<mac_address>
The MAC address that is to be filtered. The address is specified by a hex code for each byte
separated by a colon (:). For example: 00:01:33:44:5F:2C.
-fwd
When specified, the frame will be forwarded. This is the default.
-drop
When specified, the frame will be dropped.
EXAMPLE
filter add 1:2:3:4:5:6
Forward packets whose MAC destination address is 1:2:3:4:5:6.
filter add 2:3:4:4:5:2 -o -fwd
Forward packets whose MAC destination address is 2:3:4:4:5:2.
filter add 11:22:33:44:55:66 -o -drop
Drop packets whose MAC destination address is 11:22:33:44:55:66
filter delete 1:2:3:4:5:6
Remove the filter action for MAC address 1:2:3:4:5:6
62 1800-A2-GB20-00
Command Line Interface User’s Guide
5.3.17 filterlist
filterlist
Lists the contents of the filter database.
EXAMPLE
5.3.18 filterflush
filterflush
Flush the dynamic entries of the filter database.
5.3.19 l2_list
List the layer 2 entries.
EXAMPLE
[1234 @ bridge]$ l2_list
L2 Module is [enable]
List All Active rule
[19]00:00:00:00:00:00[0]->01:00:5E:00:00:00[1,1] 0000,TxPort:[2,wlan0][Deny]
5.3.20 l2_fil
l2_fil add -o -pri priority_number -src srMac -dst [multicast|dstMac] -type Eth_type -if
1800-A2-GB20-00 63
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<priority>
This is the priority level of the rule, smaller numbers have higher priorities, if a conflict between
rules occurs. The number ranges from 0 to 19.
srMac
The Source MAC address that is to be filtered. The address is specified by a hex code for each
byte separated by a colon (:). For example: 00:01:33:44:5F:2C.
[multicast|dstMac]
This is the destination MAC address of the packet. The address is specified by a hex code for
each byte separated by a colon (:) If multicast is typed, the Multicast MAC address is used for
the destination MAC address.
Eth_type
Enter the Ethernet Type in hexadecimal format. For example, enter 0800 for IP address, or enter
0806 for ARP.
ifname
This option selects the interface for the packet, from the Interface dropdown list. The available
interface options are eth0, wlan0 and atm0.
allow|deny
When allow is specified, the frame will be forwarded. When drop is specified, the frame will be
dropped.
64 1800-A2-GB20-00
Command Line Interface User’s Guide
5.4 SNMP
The SNMP commands allow listing and setting of current SNMP configuration.
list
sysconf
shutdown
start
comconf
delcomm
trapconf
agconfig
trap
1800-A2-GB20-00 65
Command Line Interface User’s Guide
5.4.1 list
list
This command lists the current SNMP configuration like system version, system contact, System
location, system id etc.
EXAMPLE
5.4.2 sysconf
sysconf [-d] [-c] [-l] [-i] value
-d: System Version Description
-c: System Contact
-l: System Location
-i: Assigned Enterprise Number
The sysconf command configures system version description, system contact, system location,
and assigned enterprise number.
66 1800-A2-GB20-00
Command Line Interface User’s Guide
EXAMPLE
[1234 @ snmp]$ sysconf -d office1
This command configures the system version description to office1.
5.4.3 shutdown
shutdown
This command shuts down the SNMP agent. To configure the SNMP agent, shut down the agent
first.
5.4.4 start
strat
This command starts the SNMP agent.
5.4.5 comconf
COMMAND DESCRIPTION
$ipaddress
IP Address of accessing station
$community_name
community string to access MIB
$access
Type 1 for ReadOnly access, or type 2 for ReadWrite access.
EXAMPLE
comconf 10.0.0.1 test -o 2
5.4.6 delcomm
delcomm $index
This command deletes the community string
1800-A2-GB20-00 67
Command Line Interface User’s Guide
COMMAND DESCRIPTION
$index
Community index in list. The index number can be displayed using the list command.
EXAMPLE
delcomm 0
5.4.7 trapconf
trapconf [1][2] $IPADDRESS $community
this command sets up the SNMP trap 1 and trap 2
COMMAND DESCRIPTION
1
SNMP Version 1
2
SNMP Version2
IPADDRESS
IP Address of Trap Server
community
community string to authenticate at manager side
EXAMPLE
5.4.8 trap
trap [1][2] enable/disable
This command enables or disables trap 1/ tap 2.
EXAMPLE
[1234 @ snmp]$ trap 1 enable
68 1800-A2-GB20-00
Command Line Interface User’s Guide
5.4.9 agconfig
agconfig $interface -o $port
COMMAND DESCRIPTION
$interface
interface on which agent will run, such as eth0, mer0, atm0….atm7, and ppp0….ppp7.
$port
Port Number (the default port No is 161)
EXAMPLE
agconfig atm0 -o 121
If the SNMP agent is running, to configure its parameters, first shut it down by using the
shutdown command, and then you can configure the parameters.
5.5 Firewall
Stateful dynamic filtering with transparent proxies is provided to meet the demanding security
needs of today's Internet. Stateful firewalls store state and context data, which are updated
dynamically. This provides virtual session information for tracking connection-oriented and
connectionless protocols. Each connection also keeps the set of actions that need to be performed
on the packets, to avoid the classification process for further IP datagrams in the same
connection. Once the connection entry for a flow is created, then all other packets that belong to
the connection only need to recognize the classification for flow identification. This way, the
throughput is significantly boosted.
5.5.1 policy
1800-A2-GB20-00 69
Command Line Interface User’s Guide
COMMAND DESCRIPTION
policy set <Policy-ID > <RxIfName> <TxIfName> <Sequence> {Allow|Deny}
[srcip <a.b.c.d> [<e.f.g.h>]]
[dstip <a.b.c.d> [<e.f.g.h>]]
[sport <p1> [<p2>]]
[dport <p1> [<p2>]]
[proto <Protocol>]
[nat <NAT-Action-ID>]
This command is used to add firewall rule.
policy modify
70 1800-A2-GB20-00
Command Line Interface User’s Guide
EXAMPLE
policy set eth0 atm0 2 allow srcip 192.168.1.23 dstip 172.16.1.100 proto tcp
5.5.7 nat
nat
nat <interface> [-alias_address <addr>]
[-unregistered_only yes|no]
[-same_ports yes|no]
[-status]
[-disable]
[-enable]
The nat command contains several command options to set up different functions of the NAT.
COMMAND DESCRIPTION
-alias_address a.b.c.d
Address to use for aliasing
-unregistered_only [yes|no]
1800-A2-GB20-00 71
Command Line Interface User’s Guide
5.5.8 publicip
publicip
publicip add/delete <public address>
publicip list
NAT Public Address Configuraton
COMMAND DESCRIPTION
publicip add/delete <public address>
Add or delete public address
publicip list
List current public address
5.5.9 links
links
links
Show the NAT links table
EXAMPLE
links
72 1800-A2-GB20-00
Command Line Interface User’s Guide
5.5.10 nataction
nataction
nataction add static/rdaddr/rdport <addr1 [addr2]> [-tp port1 [port2]]
nataction delete/list/enable/disable <action-id>
Redirect the IP address or the port.
COMMAND DESCRIPTION
nataction add
Add static NAT address, redirect address, or redirect port.
nataction delete <action-id>
Delete NAT action list.
nataction list
List NAT action.
nataction enable <action-id>
Enable NAT action.
nataction disable <action-id>
Disable NAT action.
5.5.11 spoof
spoof
spoof [ list | enable | disable | <If name> [ trusted | untrusted ] ]
This command sets which interface is trusted or untrusted. When a interface is trusted, the packet
will not be check with the attack rule.
1800-A2-GB20-00 73
Command Line Interface User’s Guide
COMMAND DESCRIPTION
spoof list :
list the all the trusted and untrusted interfaces along with status
spoof enable :
Enable spoof protection
spoof disable :
Disable spoof protection
spoof eth1 trusted :
Set eth1 as trusted interface
spoof eth1 untrusted :
Set eth1 as untrusted interface
5.5.12 setwt
setwt
setwt <default_wt> <low_wt> <high_wt> <medium_wt>
<critical_wt> <real-time_wt> <premium_wt> <urgent_wt>
This command is used to configure weights to different traffic. The total weight of these queues
are 100. Weight Zero queues traffic will use default queue bandwidth
EXAMPLE
setwt 5 5 5 5 5 65 5 5
5.5.13 listwt
5.5.14
listwt
This command is used to display the pre-configured WFQ Weights.
EXAMPLE
listwt
WFQ Weights
====================
74 1800-A2-GB20-00
Command Line Interface User’s Guide
5.5.15 Attach
attach
attach <interface_name> -o linkspeed <kbps> admission <yes/no> borrow <yes/no> ackpriority
<enable/disable>
This command is used to attach an interface to WFQ.
Default Link Speed : Baud rate of the interface
Default admission: no
Default Borrow: yes
Default AckPriority : Disable
COMMAND DESCRIPTION
<interface_name>
Attach the traffic scheduler to outgoing interface.
linkspeed <kbps>
Set the link speed of the interface.
admission <yes/no>
Set “yes”, the all weights will be in default queue.
borrow <yes/no>
Decide the residue bandwidth can be reuse or not.
1800-A2-GB20-00 75
Command Line Interface User’s Guide
ackpriority <enable/disable>
ACK packet can be transferred first.
EXAMPLE
attach adsl0 –o linkspeed 800 admission no borrow yes ackpriority no
5.5.16 listwfq
listwfq
This command is used to show all configured WFQ
EXAMPLE
listwfq
1.
Interface Information:
----------------------
Name Link Speed Admission Borrow Ack Priority
adsl0 800 no yes disable
Weights:
-------
Default Low Medium High critical real-time premium urgent
5 5 5 5 5 65 5 5
5.5.17 remove
remove
remove $interface_name
This command is used to de-attach WFQ from an interface
76 1800-A2-GB20-00
Command Line Interface User’s Guide
EXAMPLE
remove adsl0
5.5.18 qstat
qstat
qstat $interface_name
This command is used to show queues statistics on a interface.
5.5.19 createtc
createtc
createtc <dfmark/dfnomark> <priority_class> -o assuredbw <value> maxbw <value>
This command is used to create a Traffic Conditioning rule.
COMMAND DESCRIPTION
<dfmark/dfnomark>
Mark the packet with color.
<priority_class>
Set the priority of the TC rule. Each priority attach a WFQ.
assuredbw <value>
The assured bandwidth of this TC rule.
maxbw <value>
The maximum bandwidth of this TC rule
EXAMPLE
createtc dfnomark 3 –o assuredbw 600 maxbw 800
5.5.20 deletetc
deletetc
deletetc <action_id/all( which are not attached to any policy)>
1800-A2-GB20-00 77
Command Line Interface User’s Guide
EXAMPLE
deletetc all
5.5.21 listtc
listtc
listtc <action_id/all>
This command is used to list the TC rule.
EXAMPLE
Listtc all
ActionId DF-Marking Priority Assured BW(kbps) Max BW(kbps)
---------------------------------------------------------------
1 dfnomark Critical NA NA
---------------------------------------------------------------
5.5.22 tcstat
tcstat
listtc <action_id>
This command is used to list TC Statistics.
5.5.23 firewall
firewall
firewall enable/disable/status
This command is used to enable or disable firewall and also can show firewall status.
5.5.24 attack
attack
attack set <attack_type> [<threshold> <timeout>]
78 1800-A2-GB20-00
Command Line Interface User’s Guide
COMMAND DESCRIPTION
attack set <attack_type> [<threshold> <timeout>]
Set the attack type rule with threshold and timeout value.
attack enable/disable <attack_type>
Enable or disable the rule of the attack type.
attack list
List the current attack list.
EXAMPLE
attack set tcpportscan 15 50
5.6 NAPT
Network Address Translation (NAT) hides internal IP addresses of a network from the outside
world and provides access to the Internet for multiple machines using a single or fixed number of
public IP addresses. The NAT framework supports both dynamic and static NAT.
The NAPT-relevant commands are put in the qosc directory. These commands are used to set up
the NAT. Among the commands, the natif command enables dynamic NAT processing. The
addressmap and portmap support NAT features.
nat
natif
addressmap
portmap
delrdaddr
maplist
addpublic
delpublic
listpubaddrs
links
1800-A2-GB20-00 79
Command Line Interface User’s Guide
5.6.1 natif
natif [enable/disable/list] -o ifname
The natif command enables or disables the dynamic NAPT for the WAN interface (e.g., atm0,
ppp0, mero…), or displays the interface status.
EXAMPLE
natif enable -o mer0
enables NAPT for mero.
natif disable –o atm0
disables NAPT for atm0.
natif list
display the NAPT status of the interface.
5.6.2 links
links
This command displays the dynamic link table for NAPT.
5.6.3 nat
The nat command contains several command options to set up different functions of the NAT.
nat –o -unregistered_only
nat –o -same_ports [yes|no]
nat –o -alias_address x.x.x.x
nat –o --ifa network_if_name
nat –o --status [yes|no]
nat –o --disable [yes|no]
80 1800-A2-GB20-00
Command Line Interface User’s Guide
unregistered_only
If yes, only the outbound packets with unregistered source IP addresses are translated. All the
outbound packets with the registered source IP addresses are forwarded on the WAN interface
without translation. This is useful if you have one more subnet having a registered IP address
that shares the common WAN link with the subnet having an unregistered IP address.
Registered addresses are addresses reachable and advertised in the Internet whereas unregistered
addresses are private addresses which are not reachable through the Internet. Currently there is
no command to display registered addresses.
EXAMPLE
nat -o -unregistered_only yes
Tells the NAT module to translate only those outgoing packets that bears a unregistered IP
address in the source address field of the packet header.
same_ports
EXAMPLE
nat -o -same_ports yes
This command tells the NAT module to retain the same source port while translating outbound
packets. However, if this causes conflicts with existing entries in the NAT table then the source
port will be modified.
alias_address x.x.x.x
EXAMPLE
1800-A2-GB20-00 81
Command Line Interface User’s Guide
ifa network_if_name
This command configures the specified WAN interface to use dynamic Network Address
Translation. For all packets transmitted from the WAN interface, the source address is modified
to use IP address of the WAN interface. The source port of the packet may be modified as
required. Packets received on the WAN interface will have their destination address modified
appropriately to reach the appropriate machine on the LAN network.
EXAMPLE
nat –o –ifa atm0
This command configures the WAN interface atm0 to use network address translation.
status
nat –o status
This command displays the NAT configurations, including NAT interface, alias IP address, same
port, and unregistered-only setting. This will display all the configured parameters on the nat
interface.
EXAMPLE
[1234 @ qosc]$ nat -o -status
Nat Interface: NONE
Alias Address: 0.0.0.0
same ports : YES
unregistered only : NO
disable
nat –o -disable
This command disables the NAT interface.
5.6.4 addressmap
addressmap -local [<local_addr> | <local_addr_range> | <local_subnet>] -public
82 1800-A2-GB20-00
Command Line Interface User’s Guide
[<public_addr>]
Maps one or more single local IP addresses to a public IP address. One to one mapping is used
for both inbound and outbound connections and many to one mapping are used only for
outbound connections. For outbound connections, the packets matches a static link then it creates
dynamic link with that static link information on outgoing path. For incoming path packets are
match with the dynamic link and the destination (public) address is translated with the local
address.
COMMAND DESCRIPTION
-local [<local_addr> | <local_addr_range> | <local_subnet>]
The option specifies the local address (es) that will be mapped. There are three ways of
specifying the local address. Using local_addr the local IP address can be expressed on dot-
notation. Using local_addr_range a range of IP addresses can be expressed in dot notation
separated by a dash (-). An example of an address range is:
192.168.1.10-192.168.1.30. Using local_subnet the local IP addresses can be specified using dot
notation. In this form the host part of the IP address is set to zero. For example: 192.168.1.0.
-public [<public_addr>]
This option specifies the public IP address that the local addresses are mapped to. Dot notation is
used.
EXAMPLE
addressmap -local 192.168.2.1 -public 202.54.30.2
Maps a local address to a public address.
addressmap -local 192.168.2.10-192.168.2.100 -public 202.54.30.3
Maps a range of local addresses to a single public address.
addressmap -local 192.168.2.0 -public 202.54.30.4
This command maps all IP addresses on the 192.168.2.0 subnet to a single public address
202.54.30.4.
5.6.5 portmap
portmap add/delete –o tcp | udp <local_addr>:[<port>/<port range>]
<public_addr>:[<port>/<port range>]
Packets that arrive with the specified public_addr:[port/ port range] are mapped to the specified
local_addr:[port/port range]. Here the range of local ports mapped with the range of public ports.
This facility allows the system to permit certain kinds of traffic from the public Internet, pass
through the WAN interface and be directed to the specified machine on the local network.
COMMAND DESCRIPTION
add/delete
1800-A2-GB20-00 83
Command Line Interface User’s Guide
EXAMPLE
portmap add –o tcp 192.168.2.1:21 202.54.30.2:2000
Packets that whose destination address is 202.54.30.2 and whose TCP port number is 2000 will
have its destination address changed to 192.168.2.1 and its port number changed to 21. The
packet will be forwarded accordingly.
5.6.6 delrdaddr
delrdaddr <local_addr>
COMMAND DESCRIPTION
<local_addr>
84 1800-A2-GB20-00
Command Line Interface User’s Guide
The local_addr specified in the addrdaddr command. If the local address is a single address or a
subnet address, the user should specify the local address/subnet address. If it is a range of
addresses, the user should specify the first address in the range.
Removes an address mapping that was specified in the addressmap command.
EXAMPLE
addressmap -local 192.168.2.1 -public 202.54.30.2
addressmap -local 192.168.2.10-192.168.2.100 -public 202.54.30.3
addressmap -local 192.168.2.0 -public 202.54.30.4
delrdaddr 192.168.2.1 (single ip address)
delrdaddr 192.168.2.10 ( range of ip address)
delrdaddr 192.168.2.0 (subnet address)
5.6.7 maplist
maplist
This command displays addressmap and port map entries.
EXAMPLE
5.6.8 addpublic
addpublic <public_addr>
This specifies the public IP address. Dot notation should be used.
EXAMPLE
1800-A2-GB20-00 85
Command Line Interface User’s Guide
addpublic 217.15.52.34
This command enters the public IP address 217.15.52.34 into the pool.
5.6.9 delpublic
delpublic <index>
This command removes the entered IP addresses specified by index.
5.6.10 listpubaddrs
listpubaddrs
This command lists the public IP addresses that were configured with addpublic
Proxy servers restrict users from communicating directly with the public servers. A proxy server
takes the user's request for Internet services (such as HTTP, FTP and Telnet) and forwards them
to the actual servers after proper authentication. Secondary sets of rules are applied to the
application data to provide further security from the known threats associated with these
applications. These proxies support URL filtering (specified web links).
The httpproxy command configures HTTP proxy including authentication and display of
statistics.
COMMAND DESCRIPTION
httpproxy -o enable/disable
This option is used to enable or disable the httpproxy.
86 1800-A2-GB20-00
Command Line Interface User’s Guide
httpproxy -o –display
This option is used to display the configured information of httpproxy.
httpproxy -o -stat
This option is used to display the statistics of the connections passing through the httpproxy,
including inbound packets, outbound packets, inbound bytes, and outbound bytes.
httpproxy -o -auth[enable/disable]
This option is used to enable or disable the authentication module in httppproxy.
start
stop
subnet
host
lease
The dhcpserver commands configure the DHCP server function. They are put in the dhcpserver
directory. There is a pre-set DHCP subnet entry. To configure a new subnet
5.8.1 start
start
Starts the DHCP server. The subnet and host commands are used to configure DHCP server.
EXAMPLE
[1234 @ dhcpserver]$ start
DHCP Server started !!!
1800-A2-GB20-00 87
Command Line Interface User’s Guide
5.8.2 stop
stop
This command stops the DHCP server.
EXAMPLE
[1234 @ dhcpserver]$ stop
DHCP Server stoppped !!!
[1234 @ dhcpserver]$
5.8.3 subnet
subnet if add -o -subnet <subnet> -netmask <mask> -startip <startip> -endip <endip> -
leasetime <lease time in days> -broadcast <broadcast-address> -dns <name-server> -dns2
<name-server2> -gateway <gateway> -server <serverip> -file <filename>
subnet if delete
subnet if list
Configuration of DHCP to serve the specified IP addresses. There are three subnet commands
configuring the DHCP entry. The add option is used to specify the IP addresses and other aspects
of the configuration. The list option shows the configured subnets. The delete command removes
the serving of the specified subnet.
COMMAND DESCRIPTION
-subnet <subnet>
The subnet that the server will serve IP addresses on.
-netmask <mask>
The subnet mask for the subnet that the server will serve IP addresses on.
-startip <startip> -endip <endip>
The range of IP addresses that will be served. The startip and endip define this range with the
beginning and ending IP addresses to be served. These addresses are specified in dot notation.
-gateway <gateway-address>
The IP address of the gateway. This information is passed to the DHCP clients which they use
for a default route entry. By default the IP address of this endpoint is passed to the DHCP clients
as the gateway.
-leasetime <leasetime>
88 1800-A2-GB20-00
Command Line Interface User’s Guide
The amount of time the DHCP lease of the IP address will last. This is specified in days. The
default is 7 days.
-broadcast <broadcast-address>
The IP broadcast address that the server will listen to for DHCP requests. By default a standard
broadcast address for the subnet is used.
-dns <name-server>
The IP address of the DNS server that should be passed to DHCP clients. By default the dns
address configured on the WAN interface from the Internet Service Provider (via DHCP server
or PPPoA/PPPoE) is used.
-server <server> -file <filename>
These options are used to support Bootp clients. The client will go to the specified server to
retrieve the specified file as the boot image. The 6680 based endpoint does not support storage of
a file for a remote client to boot from. So the server specified will be another machine on the
network.
EXAMPLE
subnet add -o -subnet 192.168.5.0 -startip 192.168.5.200 -endip 192.168.5.210 \-leasetime
3 -dns 192.168.5.7
IP addresses will be assigned to up to 11 DHCP clients. The IP addresses assigned will begin
with 192.168.5.200 and end with 192.168.5.210. The length of the IP address assignment (the
lease) is 3 days. The address of the DNS server (192.168.5.7) will also be sent to the DHCP
clients.
subnet delete -o -subnet 192.168.5.0
The DHCP server will no longer serve address for the 192.168.5.0 network.
5.8.4 host
host add -o -macaddr <mac-address> -ipaddr <ipaddr> [-leasetime host add -o -macaddr
<mac-address> -ipaddr <ipaddr> -leasetime <lease time> -broadcast <broadcast-address> -
dns <name-server> -gateway <gateway> -server <server-name> -file <filename>
host delete -o -macaddr <mac-address>
host list
These commands control the configuration of specific hosts and are useful when specific
machines need to have permanent IP addresses assigned to specific machines. The host
commands have precedence over subnet commands. The add option is used to specify the IP
address for a particular host. The list option shows the configured hosts. The delete option will
remove a host configuration. These commands are available in the dhcpserver directory.
1800-A2-GB20-00 89
Command Line Interface User’s Guide
EXAMPLE
host add -o -macaddr 00.00.00.d1.26.95 -ipaddr 192.168.5.34
This command specifies that the machine with the MAC address of 00.00.00.d1.26.95 will be
assigned the IP address 192.168.5.34.
host delete -o -macaddr 00.00.00.d1.26.95
This command removes this host configuration for the machine with the MAC address of
d1.26.95.
5.8.5 lease
lease list
lease delete -o -ipaddr <ipaddr>
This command displays or deletes the lease configuration. Leases represent which IP addresses
are allocated to which machines and for how long. The list option lists all outstanding leases.
delete -o -ipaddr <ipaddr>
This command deletes the lease for the specified IP addresses. Dot notation is used to specify the
IP address.
The dhcpr command is used for setting up the DHCP relay function. The system acts as a proxy
for DHCP requests. When enabling the DHCP Relay, the address of the DHCP server is
specified and DHCP requests are relayed to the specified server. On enabling DHCP relay
functionality, the DHCP server functionality gets disabled (if it is enabled) and vice versa.
COMMAND DESCRIPTION
start -o <remote_server>
This option starts DHCP relay. The remote_server is the IP address of the DHCP server.
stop
This option disables or stops the DHCP relay service.
status
90 1800-A2-GB20-00
Command Line Interface User’s Guide
5.10 ADSL
Commands for setting and viewing ADSL parameters are in the “adsl” directory.
5.10.1 setmode
setmode <mode> [-trellis on/off] [-vendor default/broadcom/gsv/infineon/ti] -o [-bitswap
on/off]
This command sets the mode of the ADSL link to ANSI (T1.413), G.DMT, G.Lite, or multi-
mode. After executing this command, the configuration can be saved and the next time the
machine is rebooted, the mode will take effect.
COMMAND DESCRIPTION
<mode>
The mode may be ansi, gdmt, glite, or multi.
[-trellis on/off]
on enables the trellis code; off disables it.
-o [-bitswap on/off]
on enables bitswap; off disables it.
5.10.2 readcmv
readcmv <cmv_index> <offset>
The ADSL Configuration and Management Variables (CMV) can be read with the readcmv
command. The CMV variables are documented in “CMV Reference Manual”. This command
will only provide meaningful results when the link is operational.
COMMAND DESCRIPTION
<cmv_index>
The cmv index may be one of the following values.
Note that they must be specified in uppercase: ADPT, CNTL, CODE, DIAG, DOPT, FLAG,
INFO, INTL, MASK, OPTN, PFCL, PFRX, PFTX, PSDM, RATE, RXDA, STAT, TEST,
TONE, TXDA, UOPT.
<offset>
This is a numeric value between 0 and 65535.
1800-A2-GB20-00 91
Command Line Interface User’s Guide
5.10.3 writecmv
writecmv <cmv_index> <offset> <value>
The ADSL Configuration and Management Variables (CMV) can be written with the writecmv
command. The CMV variables are documented in “CMV Reference Manual”. This command
will take effect only after the link is reconnected.
COMMAND DESCRIPTION
<cmv_index>
The cmv index may be one of the following values. Note they must be specified in uppercase:
ADPT, CNTL, CODE, DIAG, DOPT, FLAG,
INFO, INTL, MASK, OPTN, PFCL, PFRX, PFTX, PSDM, RATE, RXDA, STAT, TEST,
TONE, TXDA, UOPT.
<offset>
This is a numeric value between 0 and 65535.
<value>
The value for the variable specified in hexadecimal format.
5.10.4 mon
mon
It displays the state of the ADSL connection. It only gives meaningful information when the link
is operational.
5.10.5 addusercmv
addusercmv <cmv name> <offset> <value>
This command allows the adding or setting of a CMV. The CMV values will be used the next
time the system is rebooted. Note that the configuration must be saved after using this command
in order for them to take effect on the next reboot.
COMMAND DESCRIPTION
<cmv_name>
The following values are permitted for the cmv name: MASK/ OPTN/ PSDM/ RXDA/CNTL/
TEST/ TXDA/ ADPT/ DIAG/ FLAG
<offset>
92 1800-A2-GB20-00
Command Line Interface User’s Guide
5.10.6 delusercmv
delusercmv <index>
Deletes the specified user CMV. The user cmv was added with the “addusercmv” command.
<index>
Index of CMV: MASK/ OPTN/ PSDM/ RXDA/CNTL/ TEST/ TXDA/ ADPT/ DIAG/ FLAG.
5.10.7 listusercmv
listusercmv
This command lists the User CMVs added by the addusercmv command.
5.10.8 eread
eread <offset> <size>
This command displays the Eagle 16 bit data memory
COMMAND DESCRIPTION
<offset >
0 - 3ffff (hexadecimal)
<size >
1 - 256 (decimal)
5.10.9 ewrite
ewrite <offset> <value>
This command writes one 16-bit word into Eagle 16 bit data memory.
1800-A2-GB20-00 93
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<offset >
0 - 3ffff (hexadecimal)
< value >
0 - ffff (hexadecimal)
5.10.10 mwrite
mwrite <offset> <value>
This command writes 1 32-bit word into Eagle 16 bit data memory
COMMAND DESCRIPTION
<offset>
0xa0000000 - 0xbfffffff (hexadecimal)
<value>
0 - ffffffff (hexadecimal)
5.10.11 mread
mread <offset> < size >
This command displays the Falcon 32 bit data memory.
COMMAND DESCRIPTION
<offset>
0xa0000000 - 0xbfffffff (hexadecimal)
<size>
1 - 100 (decimal)
5.10.12 adslup
adslup
This command starts the ADSL link
5.10.13 adsldown
adsldown
94 1800-A2-GB20-00
Command Line Interface User’s Guide
5.10.14 tone
tone <offset1> <offset2>
Options offset1 and offset2 are the numeric value from 0 to 287
EXAMPLE
To read all the tone information, enter the command:
tone 0 287
5.10.15 bitalloc
bitalloc
This command reads the bit allocation information
5.10.16 adslstat
adslstat
EXAMPLE
If the ADSL link is down, it displays the following information after typing adslstat.
[1234 @ adsl]$ adslstat
The current ADSL status is STATE_UNTRAINED.
[1234 @ adsl]$
1800-A2-GB20-00 95
Command Line Interface User’s Guide
5.11.1 Configuration
Command syntax:
setmode <Hex value>
Usages:
This command sets the mode of the ADSL link to ANSI (T1.413),
G992.1(G.dmt), G992.2(G.Lite), G992.3(ADSL2), G992.5(ADSL2+)
or multi-mode. After executing this command, the
configuration can be saved and the next time the machine is
rebooted, the mode will take effect.
Description:
Hex value :
ANSI(T1.413) = 0x1
G992.2_AB (G.lite AnnexA/B) = 0x2
G992.1_A (G.dmt AnnexA) = 0x4
G992.1_B (G.dmt AnnexA) = 0x8
G992.1_C (G.dmt AnnexC) = 0x10
G992.2_C (G.lite AnnexC) = 0x20
G992.3_A (ADSL2 AnnexA) = 0x100
G992.3_B (ADSL2 AnnexB) = 0x200
G992.3_I (ADSL2 AnnexI) = 0x400
G992.3_J (ADSL2 AnnexJ) = 0x800
G992.3_L (RE-ADSL2) = 0x1000
G992.5_A (ADSL2+) = 0x8000
Example:
Set ADSL link compatible ADSL/ADSL2/ADSL2+
setmode 0x9105
96 1800-A2-GB20-00
Command Line Interface User’s Guide
5.11.2 Displaying
Command syntax:
mon
Usages:
It displays the state of the ADSL connection. It only gives meaningful information when the link is
operational.
Example:
ADSL Monitoring is Successful.
The values are:
adslLineStatus : OPERATIONAL
adslMode : G992_5_A
Upstream = 1016 Kb ( Interleave )
Downstream = 23996 Kb ( Interleave )
======================================================
DIAG Info : Near-end Far-end
======================================================
Attenuation ( dB ) : 5.5 3.0
SNR margin ( dB ) : 8 15
HEC counter : 28060
CRC counter : 4472
RTFirmwareVer : 0x0e1b0a01
Command syntax:
showstream
Usages:
It only displays the link rate of the ADSL connection.
Example:
up stream:1016 Kb (Interleave)
down stream:23996 Kb (Interleave)
1800-A2-GB20-00 97
Command Line Interface User’s Guide
5.12 DNS
list
help
set
dnsr
Commands for setting DNS parameters are in the “dns” directory. From the “home” directory,
type “dns” to enter the directory. The available commands are shown below after typing ls.
Among the commands, help is used to give instructions about how to use the other commands.
5.12.1 list
list
This command lists DNS domain name and name server.
5.12.2 set
set -d <domain_name>
set [–n1 <name_server>] [–n2 <name_server>]
This command sets DNS entries for the system. The domain_name specifies the name of this
domain for the endpoint. The name_server specifies the IP address of the server resolving DNS
requests. To clear a domain entry, specify double quotes (“”) for the domain name. To clear the
name server entry, specify 0 as the name server.
COMMAND DESCRIPTION
-n1 <name_server>
This specifies the primary name server.
-n2 <name_server>
This specifies the secondary name server.
EXAMPLE
[cli @ dns]$ set -d wang.com
This command sets the domain name to “wang.com”.
[cli @ dns]$ set -d “”
This command removes the domain name.
98 1800-A2-GB20-00
Command Line Interface User’s Guide
5.12.3 dnsr
dnsr start -o [<server1>] [<server2>]
dnsr stop -o [<server1>] [<server2>]
This command enables/disables the DNS relay function.
COMMAND DESCRIPTION
start
This starts the DNS relay function
stop
This stops the DNS relay function.
<server1>
IP address of the primary DNS server.
<server2>
IP address of the secondary DNS server.
1800-A2-GB20-00 99
Command Line Interface User’s Guide
To set up the IGMP proxy, use the command igmp proxy to display the commands for IGMP.
igmp -o -proxyif <interface>
igmp -o -routerif <interface>
igmp -o -deleteif <interface>
igmp -o -display
COMMAND DESCRIPTION
-proxyif <interface>
This option sets the proxy interface. Typically a LAN interface (eth0) is specified. When the
proxy interface is successfully configured, the home prompt displays.
EXAMPLE
[1234 @ home]$ igmp -o -proxyif eth0
[1234 @ home]$
-routerif <interface>
This option sets the router interface. Typically a WAN interface (ATM0, PPP0) is specified.
When the router interface is successfully configured, the home prompt displays.
EXAMPLE
[1234 @ home]$ igmp -o -routerif atm0
[1234 @ home]$
-deleteif <interface>
This option deletes either the proxy or router interface.
-display
This option displays the group in all interfaces.
100 1800-A2-GB20-00
Command Line Interface User’s Guide
5.14 Rip
RIP is a protocol that automatically updates the routing entries on the system. This is done by
cooperating with other nearby routers. The RIP commands are located in the “rip” directory.
Two commands are available: rip and ver. In order for any configuration changes to take effect,
the configuration must be saved (with “save” command) and the system rebooted.
5.14.1 rip
rip –o <ON|OFF>
Rip starts and stops automated updates of routing tables. When RIP is enabled, the system
communicates with other routers in the network to update and maintain the IP routing tables. By
default, RIP is not enabled. If RIP is enabled but no version is specified, RIP version 1 is used.
This command is available in the “rip” directory.
To enable RIP, type the following command with ON capitalized.
rip -o ON
To disable the RIP function, use the following command with OFF capitalized.
rip -o OFF
5.14.2 ver
ver -o <1|2>
This command specifies the version of the RIP protocol that will be used. The permissible values
are 1 or 2. The default is 1.
5.14.3 list
list
This command lists the routes currently available.
1800-A2-GB20-00 101
Command Line Interface User’s Guide
5.15 SNDCP
5.15.1 pppoe
pppoe <profile> -o <-if Interface> <-encap Encapsulation> <-restarttime Timeout> <-auth
Auth> <-myaddr IPAddr> <-peer PeerIPAddr> <-mtu MTU> <-mru MRU> <-hwaddr
Ethaddr> <-service ServiceName> <-acname ACName> <-tag HostTag> <-user Username>
<-pass Password> <-vpi Vpi> <-vci Vci> <-mode Mode> <-idletime idleTimeout> <-nat
[enable/disable]> <-netmask mask> <-vpn OUI vpnId>
This command sets up a PPPoE profile. A PPPoE entry can be added by using the simplified
command as follows. Other part of the command is optional.
pppoe <profile> -o -if <interface> -user <user> -pass <password> -vpi <vpi> -vci <vci>
102 1800-A2-GB20-00
Command Line Interface User’s Guide
COMMAND DESCRIPTION
profile
Profile number to configure. Specify an integer number from 0 through 7.
Interface
Interface name with unit number. Eight PPP interfaces are available: ppp0, ppp1, ppp2, ppp3,
ppp4, ppp5, ppp6, ppp7. These interfaces are configured for the PPPoE and PPPoA services.
Encapsulation
Encapsulation type (LLC or VC)
Timeout
timeout (in milliseconds). The default is 3000 milli seconds.
Auth
authentication (PAP, CHAP, BOTH, MSCHAPV1, MSCHAPV2)
IPAddr
Desired self IP address (in dotted decimal, e.g., 192.168.32.32)
PeerIPAddr
Peer IP Address (in dotted decimal)
MTU
Maximum Transmission Unit expressed in bytes. The default is 1500.
MRU
Maximum Receive Unit, negotiated in LCP. The default is 1500.
Ethaddr
Hardware address of the endpoint for this connection. Typically one of the Ethernet hardware
addresses of the endpoint is used for this. The address is specified with ‘:’ used as a delimiter
between byte values (eg 10:11:12:13:14:15).
ServiceName
Service Name.
ACName
Access Concentrator name.
HostTag
Use host unique tag.
Username
Username.
Password
Password.
1800-A2-GB20-00 103
Command Line Interface User’s Guide
Vpi
The ATM vpi value which was assigned in a vcadd command or listed in a atmshowconn
command.
Vci
The ATM vci value which was assigned in a vcadd command or listed in a atmshowconn
command.
mask
This specifies the netmask for the PPP interface. The mask is specified in dot notation
(i.e.255.255.255.0).
Mode
Mode can be AUTO or DIRECT. In case of mode being set to AUTO the PPPoE negotiation
starts only when the system identifies any traffic required to be transferred on the link and in
case of DIRECT the PPPoE negotiation is started manually using “pppoestart” command. The
default is DIRECT.
idleTimeout
The value of idletime is given in minutes and this value indicates how long the link remains up
when there is no data transfer over the link. The idle time works only when used in combination
with mode AUTO. The default is 60 seconds.
enable|disable
This enables or disables NAT (Network Address Translation) for this PPP interface. The default
is for NAT to be disabled.
mask
This specifies the netmask for the PPP interface. The mask is specified in dot notation
(i.e.255.255.255.0).
OUI vpnId
This specifies the VPN encapsulation. The OUI (Organizationally Unique Identifier) and VPN
identifier are specified as numbers.
EXAMPLE
pppoe 1 –o -if ppp0 -vpi 0 -vci 100 -user jones -pass Indiana
This command defines a PPPoE profile. The ppp0 interface is used with the ATM connection vpi
0 and vci 100. The user name is “jones” and the password is “Indiana”.
5.15.2 pppoedefault
pppoedefault <profile>
104 1800-A2-GB20-00
Command Line Interface User’s Guide
This command configures the specified profile as the default PPPoE connection. This profile
must be using “auto” mode. Out of all the profiles which are using the “auto” option, only one
can be run at a time. This command is used to specify that profile. If the “pppoedefault”
command is not used, the first profile that used the “auto” option is used as the default.
5.15.3 pppoestart
pppoestart <Profile>
This command starts PPPoE given the specified profile. The profile is specified with an integer
(0, 1, 2…7). The profile was previously specified with the pppoe command.
5.15.4 pppoestop
pppoestop <Profile>
This command stops PPPoE given the specified profile. The profile is specified with an integer
(0, 1, 2). The profile was previously specified with the pppoe command.
5.15.5 pppoelist
pppoelist [-profile Profile]
This command displays the listing of all available free profiles. If -profile is not specified, this
command will display all the valid configured profiles.
5.15.6 pppoedel
pppoedel <profile> | all
This command deletes the specified profile. Profile is specified as a number (see pppoe
command). If all is specified the all profiles are deleted. This command only deletes inactive
profiles. If a profile is in use, it must be stopped before it can be deleted.
5.15.7 pppoa
pppoa <profile> -o <-if Interface> <-encap Encapsulation> <-restarttime Timeout> <-auth
Auth> <-myaddr IPAddr> <-peer PeerIPAddr> <-mtu MTU> <-mru MRU> <-user
Username> <-pass Password> <-vpi Vpi> <-vci Vci> <-nat [enable/disable]> <-netmask
mask> <-vpn OUI vpnId>
This command sets up a PPPoA profile. A PPPoA entry can be added by using the simplified
command as follows. Other part of the command is optional.
pppoe <profile> -o -if <interface> -user <user> -pass <password> -vpi <vpi> -vci <vci>
1800-A2-GB20-00 105
Command Line Interface User’s Guide
COMMAND DESCRIPTION
<profile>
Profile number to configure. Specify an integer number from 0 through 7.
interface
Interface name with unit number. Eight PPP interfaces are available: ppp0, ppp1, ppp2, ppp3,
ppp4, ppp5, ppp6, and ppp7. These interfaces are configured for the PPPoE and PPPoA services.
Encapsulation
Encapsulation type (LLC or VC)
Timeout
timeout (in milliseconds). The default is 3000 milli seconds.
Auth
authentication (PAP, CHAP, BOTH, MSCHAPV1, MSCHAPV2)
IPAddr
Desired self IP address (in dotted decimal, e.g., 192.168.32.32)
PeerIPAddr
Peer IP Address (in dotted decimal)
-mtu <mtu>
Maximum Transmission Unit expressed in bytes. The default is 1500.
-mru <mru>
Maximum Receive Unit, negotiated in LCP. The default is 1500.
Username
Username.
Password
Password.
Vpi
The ATM vpi value which was assigned in a vcadd command or listed in a atmshowconn
command.
Vci
The ATM vci value which was assigned in a vcadd command or listed in a atmshowconn
command.
-encap <encapsulation>
Encapsulation type. Possible values are LLC or VC.
enable|disable
106 1800-A2-GB20-00
Command Line Interface User’s Guide
This enables or disables NAT (Network Address Translation) for this PPP interface. The default
is for NAT to be disabled.
mask
This specifies the netmask for the PPP interface. The mask is specified in dot notation
(i.e.255.255.255.0).
OUI vpnId
This specifies the VPN encapsulation. The OUI (Organizationally Unique Identifier) and VPN
identifier are specified as numbers.
EXAMPLE
pppoa 1 –o -if ppp0 -vpi 0 -vci 100 -user jones -pass Indiana
This command defines a PPPoA profile. The ppp0 interface is used with the ATM connection
with vpi 0 and vci 100. The user name is “jones” and the password is “Indiana”.
5.15.8 pppoastart
pppoastart <Profile>
This command starts PPPoA given the specified profile. The profile is specified with an integer
(0, 1, 2). The profile was previously specified with the pppoa command.
5.15.9 pppoastop
pppoastop <Profile>
This command stops PPPoA given the specified profile. The profile is specified with an integer
(0, 1, 2). The profile was previously specified with the pppoa command.
5.15.10 pppoalist
pppoalist [-profile Profile]
This command displays the listing of all available free profiles. If -profile is not specified, this
command will display all the valid configured profiles.
5.15.11 pppoadel
pppoadel <profile> | all
This command deletes the specified profile. Profile is specified as a number (see pppoa
command). If all is specified, then all profiles are deleted. This command only deletes inactive
profiles. If a profile is in use, it must be stopped before it can be deleted.
1800-A2-GB20-00 107
Command Line Interface User’s Guide
5.15.12 pppoadefault
pppoadefault <profile>
This command configures the specified profile as the default PPPoA connection. This profile
must be using “auto” mode. Out of all the profiles which are using the “auto” option, only one
can be run at a time. This command is used to specify that profile.
5.15.13 list
list <param>
This command displays the configurations of IPOA/BRIDGE/ROUTEDBRIDGE.
COMMAND DESCRIPTION
<param>
param can be bridge, routedbridge, or ipoa.
EXAMPLE
list bridge
This command displays Bridge parameters.
list routedbridge
This command displays Routed Bridge parameters.
list ipoa
This command displays IPoA parameters.
5.15.14 ipoa
ipoa <interface> <disable> <vpi> <vci> -o <default> <-nhp ipaddress>
ipoa <interface> <enable> <vpi> <vci> -o <-enc encapulation><default> <-nhp ipaddress>
<-vpn OUI vpnId>
This command configures the specified WAN interface to use IPoA, which is Classical IP over
ATM including Inverse ATM Arp. IPoA uses Inverse ATM Arp to get the peer IP address. The
Maximum Transfer Unit (MTU) for IPoA is 9182.
Note: In this case, if the peer does not support Inverse ATM Arp, then there will not be any
traffic flow. If the next hop (-nhp option) or default PVC is configured per IPoA, then it does not
use Inverse ATM Arp to get the peer IP address.
108 1800-A2-GB20-00
Command Line Interface User’s Guide
COMMAND DESCRIPTION
interface
The name of the WAN interface. Typically this is ‘atm0’.
enable
This enables this IPoA interface.
disable
This disables this IPoA interface.
<vpi> <vci>
These are the vpi and vci values on which ipoa has to be enabled/disabled. Vpi and vci are
assigned with the vcadd command. The showatmconn command can also be used to list the
current ATM connections with their respective vpi and vci values. (Note the vcadd and
showatmconn commands are located in the “atm” directory).
encapsulation
This specifies the encapsulation type. The possible values are ‘llc’ or ‘vc’ which represent
Logical Link Control or VC multiplexing respectively.
default
If an entry does not exist for the destination in the inverse ATM Arp table, then the packet is
forwarded on the PVC specified.
ipaddress
This specifies the next hop IP address of the peer-end.
OUI vpnId
This specifies the VPN encapsulation. The OUI (Organizationally Unique Identifier) and VPN
identifier are specified as numbers.
EXAMPLE
ipoa atm0 enable 0 100 –o -enc LLC
This command establishes an IPoA connection on the WAN interface atm0. VPI, VCI values 0,
100 is used for the ATM connection. LLC encapsulation will be used.
ipoa atm0 disable 0 100
This command disables the IPoA connection.
1800-A2-GB20-00 109
Command Line Interface User’s Guide
5.15.15 routedbridge
routedbridge <interface> disable <vpi><vci>
routedbridge <interface> enable <vpi><vci> -o <-enc encapsulation> <-vpn OUIvpnId>
This command configures the specified WAN interface to use Routed Bridge which is RFC 2684
routing. Note the Maximum Transfer Unit (MTU) for the Routed Bridge is 9182.
COMMAND DESCRIPTION
interface
The name of the WAN interface. Typically this is ‘atm7’.
enable
It enables this Routed Bridge interface.
disable
It disables this Routed Bridge interface.
<vpi> <vci >
These are the vpi, vci values on which the Routed Bridge has to be enabled/disabled. Vpi and vci
are assigned with the vcadd command. The showatmconn command can also be used to list the
current ATM connections with their respective vpi and vci values. (Note the vcadd and
showatmconn commands are located in the “atm” directory).
encapsulation
This specifies the encapsulation type. The possible values are ‘llc’ or ‘vc’ which represent
Logical Link Control or VC multiplexing respectively.
OUI vpnId
This enables VPN encapsulation. OUI is organizationally unique identifier. VpnId is VPN index.
EXAMPLE
routedbridge atm0 enable 0 100 –o -enc LLC
This command establishes a Routed Bridge connection on the WAN interface atm0. VPI, VCI
values 0, 100 is used for the ATM connection.. LLC encapsulation will be used.
routedbridge atm0 disable 0 100
This command disables the Routed Bridge connection.
5.15.16 1483mer
1483mer add port vpi vci encapsulation
110 1800-A2-GB20-00
Command Line Interface User’s Guide
This command configures the specified WAN interface to use 1483MER (MAC Encapsulation
Routing). The “mer” command is used to enable the configuration.
COMMAND DESCRIPTION
port
The MER interface name (mer0).
Vpi vci
These are the vpi, vci values on which the 1483 is configured. vpi,vci are assigned with the
vcadd command. The showatmconn command can also be used to list the current ATM
connections with their respective vpi and vci values. (Note the vcadd and showatmconn com-
mands are located in the “atm” directory). The vpi value is between 0 - 255. The vci value is
between 0 - 65535.
encapsulation
This specifies the encapsulation type. The possible values are ‘llc’ or ‘vc’ which represent
Logical Link Control or VC multiplexing respectively.
5.15.17 mer
mer enable | disable | delete | status
This enables, disables, deletes or gives status of the 1483MER configurations.
5.15.18 relay
relay
relay -o -client <-if interface> <-pvc vpi vci>
relay -o -server <-if interface> <-pvc vpi vci>
relay -o enable | disable
relay -o -display
The relay command configures and enables PPPoE relay.
COMMAND DESCRIPTION
-client <-if interface> <-pvc vpi vci>
This specifies the server interface for the PPPoE Relay. The PPPoE server is connected to this
interface. The interface may be ppp0, ppp1, ppp2, ppp3, ppp4, ppp5, ppp6, or ppp7.
-server <-if interface> <-pvc vpi vci>
This specifies the client interface for the PPPoE Relay. The PPPoE clients are connected to this
interface. Typically eth0 is specified.
1800-A2-GB20-00 111
Command Line Interface User’s Guide
enable
This enables the PPPoE Relay feature.
disable
This disables the PPPoE Relay feature.
-display
This displays the PPPoE Relay configuration.
5.15.19 liststat
liststat bridge | routedbridge | ipoa | pppoe | pppoa
This command lists the statistics of the specified module.
5.15.20 ppptrace
ppptrace [on | off ]
In PPPoE or PPPoA mode, you can use this command to declare that a PPP session is
established. The command is given in the SNDCP directory.
COMMAND DESCRIPTION
on
This declares a PPP session is established
off
This displays no message when a PPP session is established.
5.16 atm
showatmconn
vpadd
vcadd
deletevc
atmstats
f5lb
112 1800-A2-GB20-00
Command Line Interface User’s Guide
5.16.1 showatmconn
showatmconn
This command lists the existing PVCs.
EXAMPLE
5.16.2 vcadd
vcadd <vpi> <vci> <service> <encaps> -o -peak <val> -avg <val> -mbs <val> -cdvt <val>
This command establishes a Permanent Virtual Circuit (PVC) with the specified traffic
descriptors. The service specifies the traffic type of the PVC. Permissible values are: cbr, rtvbr,
nrtvbr, or ubr. The adaptation parameter is used to specify the type of ATM adaptation layer for
which permissible values are aal5 for data connections and aal2 for voice connections.
COMMAND DESCRIPTION
<vpi> <vci>
Virtual Path Identifier (VPI) and Virtual Channel Identifier (VCI) that identifies this ATM
connection. The vpi is an integer number which can range from 0 to 255. The vci is an integer
number which can range from 0 to 65,535.
<service>
The service specifies the kind of traffic shaping. The possible values are cbr, rtvbr, nrtvbr, or ubr.
<encaps>
This option specifies whether ATM Adaptation Layer is aal2 or aal5. For voice connections,
AAL2 must be specified. For data connections, AAL5 must be specified.
-peak <value>
1800-A2-GB20-00 113
Command Line Interface User’s Guide
This option defines the fastest rate a user can send cells to the network. It is expressed in units of
cells
per second.
-avg <value>
This option defines the maximum sustainable/average rate a user can send cells to the network. It
is expressed in cells per second. This specifies the bandwidth utilization. This value must always
be less than or equal to the Peak Cell Rate (see -pcr option).
-mbs <value>
Maximum number of cells the user can send at the peak rate in a burst, within the sustainable
rate.
-cdvt <value>
This option constrains the number of cells the user can send to the network at the maximum line
rate. It is expressed in microseconds.
EXAMPLE
vcadd 0 38 cbr aal2 -o -peak 1600 -mbs 25 -cdvt 50000
The vcadd command creates a PVC (vpi - 0,vci - 38). Service class is cbr (Constant Bit Rate)
and encapsulation as aal2 (for voice). The traffic descriptors are set for peak cell rate of
1600kbps, burst size of 25 cells and cell delay variation of 50000 microseconds.
5.16.3 vpadd
f5lb <vpi> <vci> <flow_type> -o <LLID>
This command allows to add and configure VP level atm connection
COMMAND DESCRIPTION
<id>
Connection identification
<vpi>
vpi number
< service>
cbr / rtvbr / nrtvbr / ubr
<service>
cbr / rtvbr / nrtvbr / ubr
<peak val>
114 1800-A2-GB20-00
Command Line Interface User’s Guide
5.16.4 deletevc
deletevc <vpi> <vci>
This command deletes the specified PVC. The PVC is identified by the vpi / vci values.
EXAMPLE
deletevc 0 39
This command deletes a PVC with vpi=0 and vci=39.
5.16.5 atmstats
atmstats
This command lists the AAL5 and ATM statistics.
5.16.6 f5lb
f5lb <vpi> <vci> <flow_type> -o <LLID>
This command initiates an F5 loopback.
COMMAND DESCRIPTION
<vpi>
Virtual Path Identifier for the ATM connection.
<vci>
Virtual Circuit Identifier for the ATM connection.
<flow_type>
This command specifies segment (seg) or end-to-end (ete).
<LLID>
1800-A2-GB20-00 115
Command Line Interface User’s Guide
The loopback identifier. This is specified as 32 hex digits. The default is:
FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
EXAMPLE
remote web on
This command enables the remote web access.
remote telnet on
This command enables the remote telnet access.
5.18.1 addacl
addacl <module> <priority> <permissions> -o [-uid <UserId>]
[-range <Source IP Range> ]
[-dest <Destination Address> ]
[-domain <Domain Name> ]
[-mime <Mime Type> ]
[-timeofday <DAY1> <TIME1> <DAY2> <TIME2>]
This command provides a mechanism to filter packets based on the priority value. The high
priority rule is applied for the packet. The packets can be filtered on multiple option fields also.
The module name, priority and permissions must be specified along with the command. The
rules will sort based on the priority value. The permissions specify the action to be taken on the
packet flow.
<MODULE>
This is a mandatory parameter for configuring a rule in ACL. By specifying module name we
can configure rule for specific proxy server (httpproxy).
<PRIORITY>
116 1800-A2-GB20-00
Command Line Interface User’s Guide
Priority is mandatory parameter for configuring rule in ACL. By specifying priority we can
prioritize rule in Access Control List. The priority values range from the highest priority 1 to the
lowest priority 65535.
<PERMISSIONS>
This is a mandatory parameter for configuring a rule in ACL. By using this permission parameter
we can specifies action for specific rule. Action may be allow or deny.
-UID <USERID>
This option specifies the user using the user id given by the adduser command. This is used to
apply the permissions (allow/deny) to the specified user. This option works only when proxy
server supports Authentication.
-RANGE <SOURCE RANGE>
This option specifies the range of source addresses. The range can be specified using the
delimiter ‘-‘. The addresses should be given in the dotted format. By using this option we can
configure rule, which allows or denies request from range of Source IP addresses or specific IP
address.
-DEST <DESTINATION ADDRESS>
This option is used for configuring rule, which allows or denies request from LAN clients to
httpproxy Server for a specific Destination IP address. (It may be WAN http Server ).
-DOMAIN <DOMAIN NAME>
This option specifies the permissions to be applied for the domain name. The domain name
should not exceed 256 characters.
-MIME <MIME TYPE>
This option specifies the permissions (to allow or to deny) to be applied for the specified mime
type. The mime types are application, image, audio, and video.
Application files:
Application: generic for all application files
.exe : application/octet-stream (specific)
Image files:
Image: generic for all image files
.gif :image/gif (specific)
.jpg, .jpeg, .jpe :image/jpeg (specific)
Audio files:
Audio: generic for all audio files
.mp3 : audio/x-mpeg (specific)
.wav : audio/x-wav (specific)
1800-A2-GB20-00 117
Command Line Interface User’s Guide
Video files:
Video: generic for all video files
.mpg, .mpeg: video/mpeg (specific)
-TIMEOFDAY <DAY1> <TIME1> <DAY2> <TIME2>
This option is used filter the connections using the specified time. We can specify the day and
time.DAY1 and DAY2 should be in string format like sun, mon, tue, wed, thu, fri, sat. TIME1,
TIME2 should be in the hh:mm (24:00 hr format). The permissions should be applied between
the specified times.
Syntax of days and times are as below:
DAY1, DAY2: sun/mon/tue/wed/thu/fri/sat
TIME1, TIME2: Hrs: Mins
EXAMPLE
addacl httpproxy 3 deny -o -uid 3
This command configure a user using adduser command. Assume that it returns user id as 3. This
will add an entry in to the acl rule base. This rule is applied on http traffic, which is pass through
the httpproxy only. This rule will block the user (user id 3) completely.
addacl httpproxy 4 allow –o –uid 3 –domain www.yahoo.com
This rule adds an entry into the acl rule base. This rule will allow the user (user id 3) to access
the website www.yahoo.com only. Other than this it will not allow the user to access anything.
addacl httpproxy 8 deny –o -dest 202.100.200.20 -timeofday mon 10:00 thu 10:00
This rule adds an entry into the acl rule base. This rule will block the packets from Monday 10’o
clock to Thursday 10’o clock destined to 202.100.200.20
5.18.2 deleteacl
DELETEACL <MODULE> <RULE-ID>
This command is used to delete the rule from the acl rule base. We have to specify the module
name and the rule id to delete the entry from the list.
EXAMPLE
deleteacl httpproxy 1
This command deletes the rule 1 from the acl list.
118 1800-A2-GB20-00
Command Line Interface User’s Guide
5.18.3 listacls
listacls <module>
This command is used to displays the acls for the specified module.
EXAMPLE
listacls httpproxy
This command displays all the acls configured for httpproxy.
1800-A2-GB20-00 119
Command Line Interface User’s Guide
6.1 Bitmap
This bitmp command shows the allocation status of bitmaps like sockets, mbuffs and clusters.
120 1800-A2-GB20-00
Command Line Interface User’s Guide
6.2 Statistic
The statistic command collects the information about IP, TCP, UDP, and ICMP protocols.
[1234 @ home]$ statistic
statistic parameter
parameters - IP|TCP|UDP|ICMP|INTERFACE
For example, to display the IP statistics, type statistic IP to display the IP information.
1800-A2-GB20-00 121
Command Line Interface User’s Guide
The TFTP application provides both upload and download functions for the software and
configuration settings.
The upload enables the endpoint software (put app) or configurations (put param) uploaded as a
file, which can be used for backup and maintenance purposes. The download (get app) of the
software is used to upgrade the software, and the download of the configuration (get param) is
used to apply the settings of the configuration file to the endpoint.
Run a TFTP server program. At the TFTP prompt, connect to the TFTP server by typing connect
xxx.xxx.xxx.xxx. xxx.xxx.xxx.xxx is the IP address of the TFTP server. A “connected to :
xxx.xxx.xxx.xxx” message pops up if the TFTP server is successfully connected. The following
is an example.
tftp> connect 172.16.4.16
connected to : 172.16.4.16
There are two file transfer mode: binary and ASCII. After connecting to the TFTP server, choose
a transfer mode. If you are sure of the mode in use, type mode at the prompt.
tftp> mode
Using octet mode to transfer files. or Using netascii mode to transfer files.
122 1800-A2-GB20-00
Command Line Interface User’s Guide
The message “Using octet mode to transfer files” or “using netascii mode to transfer files”
displays for your reference.
The following sections of this chapter will describe the procedures for the upload and download.
In all the examples used in these sections, the TFTP server IP address, 172.16.4.16 and file name
are only used for reference. You must change them to fit your own settings if they are different
in real application.
You can also skip the file name by simply typing put app. The file will then be saved as app at
the target location.
1800-A2-GB20-00 123
Command Line Interface User’s Guide
When the modem is powered on, it will automatically execute the following command:
OR
The TFTP Server will check the firmware and configuration version.
If the version is older than the version in the TFTP Server, then the TFTP server will download
the updated firmware and configure files from the modem.
124 1800-A2-GB20-00
Command Line Interface User’s Guide
If the configuration file name is param, you can also skip the file name by simply typing put
param.
1800-A2-GB20-00 125
Command Line Interface User’s Guide
3. Type get app when the file name is app, or type get app ÀÀÀ to specify the name If the
software file name is app, you can also skip the file name by simply typing get app.
4. The tftp prompt pops up when the upgrade is successful. Below is an example of the software
upgrade procedures.
126 1800-A2-GB20-00
Command Line Interface User’s Guide
3. Type get para. The configuration file is saved as param at the target location. If the
configuration file name is param, you can also skip the file name by simply typing get param.
1800-A2-GB20-00 127
Command Line Interface User’s Guide
This chapter is only relevant for devices that have wireless LAN functionality. The
parameters listed below are available from the [root @ wlan]$ directory.
Command syntax:
wlancfg get [parameter]
wlancfg set [parameter]=[value]
Usages:
Configures/gets wireless LAN configuration.
Parameters:
Parameter Value Description
CountryRegion 0 : use 1 ~ 11 Channel Country Region
1 : use 1 ~ 11 Channel
2 : use 1 ~ 13 Channel
3 : use 10, 11 Channel
4 : use 10 ~ 13 Channel
5 : use 14 Channel
6 : use 1 ~ 14 Channel
7 : use 3 ~ 9 Channel
SSID 0~z, less than 32 characters SoftAP SSID
WirelessMode 0 : 11b/g mixed Wireless Mode
1 : 11B only
2 : 11g only
128 1800-A2-GB20-00
Command Line Interface User’s Guide
1800-A2-GB20-00 129
Command Line Interface User’s Guide
130 1800-A2-GB20-00
Command Line Interface User’s Guide
Example:
wlancfg set SSID=Wireless
1800-A2-GB20-00 131
Command Line Interface User’s Guide
When the endpoint finishes booting, the stations can connect to AP during the
“AssocTime” interval. Afterward, if other stations want to connect to AP, please use CLI
“association” command to let them connect to AP during the “AssocTime” interval.
8.3.1 disassoc
Command syntax:
disassoc [mac]
Usages:
AP sends mlme-disassociate packet to station.
Parameters:
mac format : xx:xx:xx:xx:xx
8.3.2 association
Command syntax:
association
Usages:
Start association to allow station connecting to AP.
8.3.3 remaintime
Command syntax:
remaintime
Usages:
Show the remainder association time.
132 1800-A2-GB20-00
Command Line Interface User’s Guide
8.3.4 listdevices
Command syntax:
listdevices
Usages:
List subscribed devices.
8.3.5 Example
Assumption that no station connected to AP. First we set the “AssocTime” interval
to 1 minute. And we get the “AssocTime” interval. Then we list subscribed devices. It’s a
blank list, because nobody connected to AP.
We start association to allow station connecting to AP. The station A (MAC address
is 00:0D:88:87:E5:DE) connects to AP in a moment. We show the remainder
association time. We list subscribed devices and find the entry #01 station A in the
subscribed devices list.
------------------------------------------------------------------------------------------------------
1800-A2-GB20-00 133
Command Line Interface User’s Guide
Command syntax:
batch option
Usages:
Combine many wlancfg configurations to the batch file.
Options:
Option Description
add –o [parameter]=[value] Add wlan configuration to the batch file. The
parameters refer to Wireless LAN Configuration.
The batch file only contain 10 wlan configuration.
Clear Clear batch file
List List batch file
134 1800-A2-GB20-00
Command Line Interface User’s Guide
Option Description
Apply Apply batch and save wlan configuration
Note: The end of batch file must be SSID=xxxx. If you Telnet to the endpoint with
wireless interface, the Telnet session will be broken by “batch apply.”
Example:
batch clear
batch add -o Channel=10
batch add -o HideSSID=0
batch add -o SSID=Wireless
batch apply
1800-A2-GB20-00 135