EXCEPT AS INDICATED IN THE APPLICABLE SYSTEM PURCHASE AGREEMENT, THE SYSTEM,
DOCUMENTATION AND SERVICES ARE PROVIDED “AS IS”, AS AVAILABLE, WITHOUT
WARRANTY OF ANY KIND. MOTOROLA MOBILITY LLC. DOES NOT WARRANT THAT THE
SYSTEM WILL MEET CUSTOMER'S REQUIREMENTS, OR THAT THEIR OPERATION WILL BE
UNINTERRUPTED OR ERROR-FREE, OR THAT ANY ERRORS CAN OR WILL BE FIXED.
MOTOROLA MOBILITY LLC. HEREBY DISCLAIMS ALL OTHER WARRANTIES, EXPRESS OR
IMPLIED, ORAL OR WRITTEN, WITH RESPECT TO THE SYSTEM AND SERVICES INCLUDING,
WITHOUT LIMITATION, ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT,
INTEGRATION, MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE AND ALL
WARRANTIES ARISING FROM ANY COURSE OF DEALING OR PERFORMANCE OR USAGE OF
TRADE.
EXCEPT AS INDICATED IN THE APPLICABLE SYSTEM PURCHASE AGREEMENT, MOTOROLA
MOBILITY LLC. SHALL NOT BE LIABLE CONCERNING THE SYSTEM OR SUBJECT MATTER OF
THIS DOCUMENTATION, REGARDLESS OF THE FORM OF ANY CLAIM OR ACTION (WHETHER
IN CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHERWISE), FOR ANY (A) MATTER
BEYOND ITS REASONABLE CONTROL, (B) LOSS OR INACCURACY OF DATA, LOSS OR
INTERRUPTION OF USE, OR COST OF PROCURING SUBSTITUTE TECHNOLOGY, GOODS OR
SERVICES, (C) INDIRECT, PUNITIVE, INCIDENTAL, RELIANCE, SPECIAL, EXEMPLARY OR
CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF BUSINESS,
REVENUES, PROFITS OR GOODWILL, OR (D) DIRECT DAMAGES, IN THE AGGREGATE, IN
EXCESS OF THE FEES PAID TO IT HEREUNDER FOR THE SYSTEM OR SERVICE GIVING RISE
TO SUCH DAMAGES DURING THE 12-MONTH PERIOD PRIOR TO THE DATE THE CAUSE OF
ACTION AROSE, EVEN IF COMPANY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES. THESE LIMITATIONS ARE INDEPENDENT FROM ALL OTHER PROVISIONS OF THIS
AGREEMENT AND SHALL APPLY NOTWITHSTANDING THE FAILURE OF ANY REMEDY
PROVIDED HEREIN.
All Motorola Mobility LLC products are furnished under a license agreement included with the product.
If you are unable to locate a copy of the license agreement, please contact Motorola Mobility LLC.
This Administrator’s Handbook covers the advanced features of the Motorola 2247-N8 DSL Wi-Fi Gateway.
Your 2247-N8 equipment offers advanced configuration features accessed through the Web-based interface
screens and the command line interface (CLI). This Administrator’s Handbook documents the use of the system
CLI and provides a list of commands and arguments available.
NOTE:
For installation instructions, configuration procedures, basic troubleshooting, and information on the Web
management interface of the 2247-N8, refer to the Motorola 2247-N8 DSL Wi-Fi Gateway User Guide. You
should read the User Guide before reading this Administrator’s Handbook.
The 2247-N8 User Guide and the Motorola 2247-N8 Quick Start Guide are both available on the Motorola
support web site (http://www.motorola.com/us/support) and on the Documentation CD-ROM included in
the product package.
This guide is targeted primarily to residential service subscribers.
The command line interface may also be of use to the support staffs of broadband service providers and
advanced residential service subscribers. (See Chapter 2,
SAVE THESE INSTRUCTIONS
Command Line Interface.”)
5
Administrator’s Handbook
6
CHAPTER 2Command Line Interface
The 2247-N8 DSL Wi-Fi Gateway operating software includes a command line interface (CLI) that lets you
access your 2247-N8 over a telnet connection. You can use the command line interface to enter and update the
unit’s configuration settings, monitor its performance, and restart it.
This chapter covers the following topics:
“Overview” on page 9
“Starting and Ending a CLI Session” on page 11
“Using the CLI Help Facility” on page 12
“About SHELL Commands” on page 12
“SHELL Commands” on page 13
“About CONFIG Commands” on page 23
“CONFIG Commands” on page 26
“Debug Commands” on page 70
7
Administrator’s Handbook
CONFIG Commands
“Connection commands” on page 26
“Filterset commands” on page 29
“Queue commands” on page 34
“IP Gateway commands” on page 36
“IPv6 Commands” on page 36
“IP DNS commands” on page 46
“IP IGMP commands” on page 47
“NTP commands” on page 49
“Application Layer Gateway (ALG) commands” on page 50
“Dynamic DNS Commands” on page 51
“Link commands” on page 51
“Management commands” on page 54
“Remote access commands” on page 56
“Physical interfaces commands” on page 58
“PPPoE relay commands” on page 63
“NAT Pinhole commands” on page 63
“Security Stateful Packet Inspection (SPI) commands” on page 64
“System commands” on page 67
“System commands” on page 67
8
Overview
The CLI has two major command modes: SHELL and CONFIG. Summary tables that list the commands are
provided below. Details of the entire command set follow in this section.
SHELL Commands
CommandStatus and/or Description
arpto send ARP request
atmpingto check the ATM connection reachability and network
connectivity.
clearto erase all stored configuration information
clear_certificateto remove an SSL certificate that has been installed
clear_https_certkeyto remove a secure HTTP certificate key value
clear_firewall_logto empty the contents of the firewall event log
clear_igmp_logto empty the contents of the igmp log
clear_logto erase all stored log info in flash memory
configureto configure unit's options
debugto activate or deactivate debug
diagnoseto run self-test
downloadto download config file
exitto quit this shell
helpto get more: “help all” or “help help”
installto download and program an image into flash
logto add a message to the diagnostic log
loglevelto report or change diagnostic log level
netstatto show IP information
nslookupto send DNS query for host
pingto send ICMP Echo request
quitto quit this shell
6rd-checkto send a 6rd loopback packet to the border gateway
remote-accessto activate or deactivate remote access
resetto reset subsystems
restartto restart unit
showto show system information
startto start subsystem
statusto show basic status of unit
telnetto telnet to a remote host
tracerouteto send traceroute probes
uploadto upload config file
viewto show configuration information
whoto show who is using the shell
wpsto enter Wireless Protection Settings mode
9
Administrator’s Handbook
Command VerbsStatus and/or Description
deleteDelete configuration list data
helpHelp command option
saveSave configuration data
scriptPrint configuration data
setSet configuration data
validateValidate configuration settings
viewView configuration data
Keywords
connConnection options
ipTCP/IP protocol options
ip6IPv6 protocol options
gfsGlobal Filter Set options
linkWAN link options
managementSystem management options
physicalPhysical interface options
dslDSL configuration options
enetEthernet options
filtersetFilterset options
pinholePinhole options
pppoe-relayPoint to Point Protocol over Ethernet relay options
preferencesShell environment preferences
queueQueue options
restricted-hostsRestricted hosts options
securitySecurity (firewall) options
systemGateway’s system options
top Go to top level of configuration mode
quitExit from configuration mode; return to shell mode
exitExit from configuration mode; return to shell mode
CONFIG Commands
Command Utilities
10
Starting and Ending a CLI Session
Open a telnet connection from a workstation on your network.
You initiate a telnet connection by issuing the following command from an IP host that supports telnet, for
example, a personal computer running a telnet application such as NCSA Telnet.
telnet <ip_address>
You must know the IP address of the 2247-N8 before you can make a telnet connection to it. By default, your
2247-N8 uses 192.168.1.254 as the IP address for its LAN interface. You can use a Web browser to configure
the 2247-N8 IP address.
Logging In
The command line interface log-in process emulates the log-in process for a UNIX host. To logon, enter the
username and your password.
Entering the administrator password lets you display and update all 2247-N8 settings.
When you have logged in successfully, the command line interface lists the username and the security level
associated with the password you entered in the diagnostic log.
Ending a CLI Session
You end a command line interface session by typing quit from the SHELL node of the command line interface
hierarchy.
11
Administrator’s Handbook
Using the CLI Help Facility
The help command lets you display on-line help for SHELL and CONFIG commands. To display a list of the commands available to you from your current location within the command line interface hierarchy, enter
or type a question mark (
?).
help
To obtain help for a specific CLI command, type
to
h or a question mark when you request help for a CLI command.
help <command>. You can truncate the help command
About SHELL Commands
You begin in SHELL mode when you start a CLI session. SHELL mode lets you perform the following tasks with
your 2247-N8:
Monitor its performance
Display and reset gateway statistics
Issue administrative commands to restart 2247-N8 functions
SHELL Prompt
When you are in SHELL mode, the CLI prompt is the name of the 2247-N8 DSL Wi-Fi Gateway followed by a
right angle bracket (>). For example, if you open a CLI connection to the 2247-N8 named “moto1311,” you
would see
SHELL Command Shortcuts
You can truncate most commands in the CLI to their shortest unique string. For example, you can use the truncated command
for the
The only commands you cannot truncate are
munications, you must enter the
moto1311> as your CLI prompt.
q in place of the full quit command to exit the CLI. However, you would need to enter rese
reset command, since the first characters of reset are common to the restart command.
restart and clear. To prevent accidental interruption of com-
restart and clear commands in their entirety.
You can use the Up and Down arrow keys to scroll backward and forward through recent commands you have
entered. Alternatively, you can use the
!! command to repeat the last command you entered.
12
SHELL Commands
Common Commands
arp nnn.nnn.nnn.nnn
Sends an Address Resolution Protocol (ARP) request to match the nnn.nnn.nnn.nnn IP address to an
Ethernet hardware address.
clear [ yes ]
Clears the configuration settings in a 2247-N8. You are prompted to confirm the clear command by entering
yes.
clear_certificate
Removes an SSL certificate that has been installed.
clear_firewall_log
Empties the contents of the firewall event log.
clear_igmp_log
Empties the contents of the IGMP log.
clear_https_certkey
Removes any Secure HTTP certificate key value installed in the 2247-N8.
clear_log
Empties the contents of the event log.
configure
Puts the command line interface into Configure mode, which lets you configure your 2247-N8 DSL Wi-Fi Gateway with Config commands. Config commands are described starting on page 26
This command installs a file of configuration parameters into the 2247-N8 from a TFTP (Trivial File Transfer Protocol) server. The TFTP server must be accessible on your Ethernet network.
You can include one or more of the following arguments with the download command. If you omit arguments,
the console prompts you for this information.
The server_address argument identifies the IP address of the TFTP server from which you want to copy
the 2247-N8 configuration file.
The filename argument identifies the path and name of the configuration file on the TFTP server.
If you include the optional
confirm keyword, the download begins as soon as all information is entered.
13
Administrator’s Handbook
You can also download an SSL certificate file from a trusted Certification Authority (CA), on platforms that support SSL, as follows:
Downloads a new version of the 2247-N8 DSL Wi-Fi Gateway operating software from a TFTP (Trivial File Transfer Protocol) server, validates the software image, and programs the image into the 2247-N8 memory. After
you install new operating software, you must restart the 2247-N8.
The server_address argument identifies the IP address of the TFTP server on which your 2247-N8 operating software is stored. The filename argument identifies the path and name of the operating software file
on the TFTP server.
If you include the optional keyword confirm, you will not be prompted to confirm whether or not you want
to perform the operation.
log message_string
Adds the message in the message_string argument to the 2247-N8 diagnostic log.
loglevel [ level ]
Displays or modifies the types of log messages you want the 2247-N8 to record. If you enter the loglevel
command without the optional level argument, the command line interface displays the current log level
setting.
You can enter the
sages you want to record. All messages with a level number equal to or greater than the level you specify are
recorded. For example, if you specify loglevel 3, the diagnostic log will retain high-level informational messages
(level 3), warnings (level 4), and failure messages (level 5).
Use the following values for the level argument:
1 or low – Low-level informational messages or greater; includes trivial status messages.
2 or medium – Medium-level informational messages or greater; includes status messages that can help
monitor network traffic.
3 or high – High-level informational messages or greater; includes status messages that may be significant
but do not constitute errors.
4 or warning– Warnings or greater; includes recoverable error conditions and useful operator informa-
tion.
5 or failure – Failures; includes messages describing error conditions that may not be recoverable.
loglevel command with the level argument to specify the types of diagnostic mes-
netstat -i
Displays the IP interfaces for your 2247-N8.
netstat -r
Displays the IP routes stored in your 2247-N8.
14
nslookup [ hostname | ip_address ]
Performs a domain name system lookup for a specified host.
The hostname argument is the name of the host for which you want DNS information; for example,
nslookup klaatu.
The ip_address argument is the IP address, in dotted decimal notation, of the device for which you want
Causes the 2247-N8 to issue a series of ICMP Echo requests for the device with the specified name or IP
address.
The hostname argument is the name of the device you want to ping; for example,
ping ftp.motorola.com.
The ip_address argument is the IP address, in dotted decimal notation, of the device you want to locate.
If a host using the specified name or IP address is active, it returns one or more ICMP Echo replies, confirming that it is accessible from your network.
The
The
-s size argument lets you specify the size of the ICMP packet.
-c count argument lets you specify the number of ICMP packets generated for the ping request. Val-
ues greater than 250 are truncated to 250.
You can use the
work. You cannot use the
ping command to determine whether a hostname or IP address is already in use on your net-
ping command to ping the 2247-N8’s own IP address.
quit
Exits the 2247-N8 command line interface.
6rd-check [-s size] [-c count] conn_name
Generates and sends 6rd loopback packets to the 6rd gateway.
reset arp
Clears the Address Resolution Protocol (ARP) cache on your unit.
reset crash
Clears crash-dump information, which identifies the contents of the 2247-N8 registers at the point of system
malfunction.
reset dhcp server
Clears the DHCP lease table in the 2247-N8.
reset enet [ all ]
Resets Ethernet statistics to zero. Resets individual LAN switch port statistics as well as wireless and WAN
Ethernet statistics (where applicable).
reset ipmap
Clears the IPMap table (NAT).
15
Administrator’s Handbook
reset ipv6 dhcp server
Clears the IPv6 DHCP lease table in the 2247-N8.
reset ipv6 lan
This function resets IPv6 LAN interface statistics.
reset ipv6 statistics
This function resets all IPv6 statistics.
reset lan-discovery
This function resets the LAN discovery table.
reset log
Rewinds the diagnostic log display to the top of the existing 2247-N8 diagnostic log. The reset log command
does not clear the diagnostic log. The next
of the log file.
show log command will display information from the beginning
reset wan
This function resets WAN interface statistics.
restart [ seconds ]
Restarts your 2247-N8. If you include the optional seconds argument, your 2247-N8 will restart when the
specified number of seconds have elapsed. You must enter the complete
restart.
restart command to initiate a
show all-info
Displays all settings currently configured in the 2247-N8.
show bridge interfaces
Displays bridge interfaces maintained by the 2247-N8.
show bridge table
Displays the bridging table maintained by the 2247-N8.
show config
Dumps the 2247-N8’s configuration script just as the script command does in config mode.
show crash
Displays the most recent crash information, if any, for your 2247-N8.
show dhcp server leases
Displays the DHCP leases stored in RAM by your 2247-N8.
16
show dhcp client
Displays the DHCP clients stored in RAM by your 2247-N8.
show dsl [ all ]
Displays DSL port statistics, such as upstream and downstream connection rates and noise levels.
show enet [ all ]
Displays Ethernet interface statistics maintained by the 2247-N8. Supports display of individual LAN switch
port statistics as well as WAN Ethernet statistics (where applicable).
Example:
Ethernet driver full statistics - LAN
10/100/1000 Ethernet
Port Status: Link up
General:
Transmit OK : 253
Receive OK : 22
Tx Errors : 0
Rx Errors : 0
No transmit software queue configured on Ethernet port 2
No transmit software queue configured on Ethernet port 3
No transmit software queue configured on Ethernet port 4
show group-mgmt
Displays the IGMP Snooping Table. See “IP IGMP commands” on page 47 for detailed explanation.
show ip arp
Displays the Ethernet address resolution table stored in your 2247-N8.
show ip igmp
Displays the contents of the IGMP Group Address table and the IGMP Report table maintained by your 2247N8.
show ip igmp-stats [ all | interfaces | group | hosts ]
Displays IGMP statistics information.
show ip interfaces
Displays the IP interfaces for your 2247-N8.
show ip firewall
Displays firewall statistics.
show ip lan-discovery
Displays the LAN Host Discovery Table of hosts on the wired or wireless LAN, and whether or not they are currently online.
show ip routes
Displays the IP routes stored in your 2247-N8.
18
show ipmap
Displays IPMap table (NAT).
show ipv6 interfaces
Display IPv6 interfaces.
show ipv6 routes
Display IPv6 route table.
show ipv6 neighbors
Display IPv6 neighbor table.
show ipv6 dhcp server leases
Display DHCPv6 server lease table.
show ipv6 lan-discovery
Displays the IPv6 LAN Host Discovery Table of hosts on the wired or wireless LAN, and whether or not they are
currently online.
show ipv6 statistics
Display IPv6 statistics information.
show igmp-log
Displays blocks of information from the 2247-N8 IGMP log
show log
Displays blocks of information from the 2247-N8 diagnostic log. To see the entire log, you can repeat the show
command or you can enter show log all.
log
show firewall-log
Displays blocks of information from the 2247-N8 firewall log.
show memory [ all ]
Displays memory usage information for your 2247-N8. If you include the optional all argument, your 2247-N8
will display a more detailed set of memory statistics.
show ptm
Displays statistics information for each PTM session.
show post-results
Displays POST results.
19
Administrator’s Handbook
show pppoe
Displays status information for each PPPoE socket, such as the socket state, service names, and host ID values.
show status
Displays the current status of a 2247-N8, the device's hardware and software revision levels, a summary of
errors encountered, and the length of time the 2247-N8 has been running since it was last restarted. Identical
to the
status command.
show summary
Displays a summary of WAN, LAN, and gateway information.
show wireless [ all ]
Shows wireless status and statistics.
show wireless clients [ MAC_address ]
Displays details on connected clients, or more details on a particular client if the MAC address is added as an
argument.
telnet [ hostname | ip_address ] [ port ]
Lets you open a telnet connection to the specified host through your 2247-N8.
The hostname argument is the name of the device to which you want to connect; for example,
ftp.motorola.com
The ip_address argument is the IP address, in dotted decimal notation, of the device to which you want
to connect.
The port argument is the number of t he port over which you want to open a telnet session.
Copies the current configuration settings of the gateway to a TFTP (Trivial File Transfer Protocol) server. The
TFTP server must be accessible on your Ethernet network. The server_address argument identifies the IP
address of the TFTP server on which you want to store the 2247-N8 settings. The filename argument identifies the path and name of the configuration file on the TFTP server. If you include the optional
keyword, you will not be prompted to confirm whether or not you want to perform the operation.
confirm
view config
Dumps the 2247-N8’s configuration just as the view command does in config mode.
who
Displays the names of the current shell and PPP users.
wps
Enters the Wireless (Wi-Fi) Protected Setup mode.
WPS Commands
The following commands are available in Wireless Protected Setup mode:
pushbutton
Sets the 2247-N8 to WPS “pushbutton” mode, initiating protected setup.
pin
Sets the 2247-N8 to PIN mode, enabling authorized devices to be identified and added by MAC address Personal Identification Number.
list
Lists the WPS-ready client devices (enrollees) known to the 2247-N8.
self-pin
Displays the 2247-N8’s own Personal Identification Number (PIN) value.
WAN Commands
atmping vccn [ segment | end-to-end ]
Lets you check the ATM connection reachability and network connectivity. This command sends five Operations, Administration, and Maintenance (OAM) loopback calls to the specified vpi/vci destination. There is a
five second total timeout interval.
Use the segment argument to ping a neighbor switch.
Use the end-to-end argument to ping a remote end node.
reset atm
Resets any open ATM connections.
21
Administrator’s Handbook
reset dhcp client release interface-name
Releases the DHCP lease that the 2247-N8 is currently using to acquire the IP settings for the specified DSL
port. The interface-name
is the value shown by the show ip interfaces command.
reset dhcp client renew interface-name
Renews the DHCP lease that the 2247-N8 is currently using to acquire the IP settings for the specified DSL port.
The interface-name is the value shown by the
show ip interfaces command.
reset dsl
Resets any open DSL connection.
reset ppp vccn
Resets the point-to-point connection over the specified virtual circuit. This command only applies to virtual circuits that use PPP framing.
reset wan
Resets any open WAN connection.
reset xtm
Resets any open XTM connection.
show atm [all]
Displays ATM statistics for the 2247-N8. The optional all argument displays a more detailed set of ATM statistics.
start ppp vccn
Opens a PPP link on the specified virtual circuit.
22
About CONFIG Commands
You reach the configuration mode of the command line interface by typing configure (or any truncation of
configure, such as con or config) at the CLI SHELL prompt.
CONFIG Mode Prompt
When you are in CONFIG mode, the CLI prompt consists of the name of the 2247-N8 followed by your current
node in the hierarchy and two right angle brackets (>>). For example, when you enter CONFIG mode (by typing
config at the SHELL prompt), the NOS/9437188 (top)>> prompt reminds you that you are at the top
of the CONFIG hierarchy. If you move to the
prompt), the prompt changes to
Some CLI commands are not available until certain conditions are met. For example, you must enable IP for an
interface before you can enter IP settings for that interface.
NOS/9437188 (ip)>> to identify your current location.
Navigating the CONFIG Hierarchy
Moving from CONFIG to SHELL — You can navigate from anywhere in the CONFIG hierarchy back to the
SHELL level by entering quit at the CONFIG prompt and pressing Return.
NOS/9437188 (top)>> quit
NOS/9437188 >
Moving fromtopto a subnode — You can navigate from the top node to a subnode by entering the node
name (or the significant letters of the node name) at the CONFIG prompt and pressing R
you move to the IP subnode by entering
NOS/9437188 (top)>> ip
NOS/9437188 (ip)>>
ip node in the CONFIG hierarchy (by typing ip at the CONFIG
ETURN. For example,
ip and pressing RETURN.
As a shortcut, you can enter the significant letters of the node name in place of the full node name at the CONFIG prompt. The significant characters of a node name are the letters that uniquely identify the node. For
example, since no other CONFIG node starts with b, you could enter one letter (“
node.
Jumping down several nodes at once — You can jump down several levels in the CONFIG hierarchy by
entering the complete path to a node.
Moving up one node — You can move up through the CONFIG hierarchy one node at a time by entering the
b”) to move to the bridge
up command.
Jumping to the top node — You can jump to the top level from anywhere in the CONFIG hierarchy by enter-
ing the
Moving from one subnode to another — You can move from one subnode to another by entering a partial
path that identifies how far back to climb.
Moving from any subnode to any other subnode — You can move from any subnode to any other subnode
by entering a partial path that starts with a top-level CONFIG command.
Scrolling backward and forward through recent commands — You can use the Up and Down arrow keys
to scroll backward and forward through recent commands you have entered. When the command you want
appears, press Enter to execute it.
top command.
23
Administrator’s Handbook
Entering Commands in CONFIG Mode
CONFIG commands consist of keywords and arguments. Keywords in a CONFIG command specify the action
you want to take or the entity on which you want to act. Arguments in a CONFIG command specify the values
appropriate to your site. For example, the CONFIG command:
set ip dns domain-name domain_name_value
consists of three keywords (ip, dns and domain-name) and one argument (domain_name_value).
When you use the command to configure your 2247-N8, you would replace the argument with a value appropriate to your site.
For example:
set ip dns domain-name motorola.com
Guidelines: CONFIG Commands
The following table provides guidelines for entering and formatting CONFIG commands.
Command
component
Command verbsCONFIG commands must start with a command verb (set, view, delete).
You can truncate CONFIG verbs to three characters (set, vie, del).
CONFIG verbs are case-insensitive. You can enter “SET,” “Set,” or “set.”
KeywordsKeywords are case-insensitive. You can enter “Ethernet,” “ETHERNET,” or “ethernet” as a keyword
without changing its meaning.
Keywords can be abbreviated to the length that they are differentiated from other keywords.
Argument TextText strings can be as many as 64 characters long, unless otherwise specified. In some cases they
may be as long as 255 bytes.
Special characters are represented using backslash notation.
Text strings may be enclosed in double (“) or single (‘) quote marks. If the text string includes an
embedded space, it must be enclosed in quotes.
Special characters are represented using backslash notation.
NumbersEnter numbers as integers, or in hexadecimal, where so noted.
IP addressesEnter IP addresses in dotted decimal notation (0 to 255).
Rules for entering CONFIG commands
If a command is ambiguous or miskeyed, the CLI prompts you to enter additional information. For example,
you must specify which virtual circuit you are configuring when you are setting up a 2247-N8.
Displaying Current Gateway Settings
You can use the view command to display the current CONFIG settings for your 2247-N8. If you enter the
view command at the top level of the CONFIG hierarchy, the CLI displays the settings for all enabled func-
tions. If you enter the
odes.
view command at an intermediate node, you see settings for that node and its subn-
Step Mode: A CLI Configuration Technique
The 2247-N8 DSL Wi-Fi Gateway command line interface includes a step mode to automate the process of
entering configuration settings. When you use the CONFIG step mode, the command line interface prompts
you for all required and optional information. You can then enter the configuration values appropriate for your
site without having to enter complete CLI commands.
24
When you are in step mode, the command line interface prompts you to enter required and optional settings.
If a setting has a default value or a current setting, the command line interface displays the default value for
the command in parentheses. If a command has a limited number of acceptable values, those values are presented in brackets, with each value separated by a vertical line.
For example, the following CLI step command indicates that the default value is
limited to
on and off.
off and that valid entries are
option (off) [on | off]: on
You can accept the default value for a field by pressing the Return key. To use a different value, enter it and
press Return.
You can enter the CONFIG step mode by entering
enter step mode for a particular service by entering
trol-X <Return/Enter> to exit. For example:
set from the top node of the CONFIG hierarchy. You can
set service_name. In stepping set mode (press Con-
NOS/9437188 (top)>> set system
...
system
name (“NOS/9437188”): Mycroft
Diagnostic Level (High): medium
Stepping mode ended.
Validating Your Configuration
You can use the validate CONFIG command to make sure that your configuration settings have been
entered correctly. If you use the
services are present and that settings are consistent.
validate command, the 2247-N8 verifies that all required settings for all
NOS/9437188 (top)>> validate
Error: Subnet mask is incorrect
Global Validation did not pass inspection!
You can use the validate command to verify your configuration settings at any time. Your 2247-N8 automatically validates your configuration any time you save a modified configuration.
25
Administrator’s Handbook
CONFIG Commands
This section describes the keywords and arguments for the various CONFIG commands.
Connection commands
conns are used to create connections, for example, a WAN or LAN conn. There may be more than one of each
depending on your model.
set conn name name link-oid value
Sets the connection named name to point to an associated link specified by the link-oid value.
set conn name name type [ static | dhcpc | ppp ]
Specifies whether the type of the connection named name is static, dhcpc, or ppp.
set conn name name side [ lan | wan ]
Specifies whether this conn is LAN- or WAN-side. A conn can be either lan or wan.
set conn name name lan-type [ private | public | public-delegated ]
names correspond to the system object IDs (OIDs) but you can name them yourself.
Specifies whether this conn’s LAN is private, public, or public-delegated. The default is private, the usual type
of local network.
set conn name name dhcp-server-enable [ on | off ]
Turns the DHCP server for this connection on or off. The DHCP server can be enabled per connection. The
default is
on.
set conn name name mcast-forwarding [ off | on ]
Turns IP IGMP multicast forwarding for this connection off or on. The default is off.
set conn name name rip-send [ off | v1 | v2 | v1-compat | v2-md5 ]
Specifies whether the device should use Routing Information Protocol (RIP) broadcasts to advertise its routing
tables to other Gateways. RIP Version 2 (RIP-2) is an extension of the original Routing Information Protocol
(RIP-1) that expands the amount of useful information in the RIP packets. While RIP-1 and RIP-2 share the same
basic algorithms, RIP-2 supports several additional features, including inclusion of subnet masks in RIP packets
and implementation of multicasting instead of broadcasting (which reduces the load on hosts which do not
support routing protocols. RIP-2 with MD5 authentication is an extension of RIP-2 that increases security by
requiring an authentication key when routes are advertised. Depending on your network needs, you can configure your device to support RIP-1, RIP-2, or RIP-2MD5.
If you specify v2-MD5, you must also specify a rip-send-key. Keys are ASCII strings with a maximum of 31 characters, and must match the other gateway(s) keys for proper operation of MD5 support. The default is
off.
set conn name name rip-receive [ off | v1 | v2 | v1-compat | v2-md5 ]
Specifies whether the device should use Routing Information Protocol (RIP) broadcasts to update its routing
tables with information received from other Gateways on the other side of the connection. If you specify
md5
, you must also specify a rip-receive-key. Keys are ASCII strings with a maximum of 31 characters, and must
match the other gateway(s) keys for proper operation of MD5 support. The default is
off.
26
v2-
set conn name name icmp-echo-drop [ off | on ]
If set to on, drops echo-requests received on the particular WAN IP interface. The default is off.
set conn name name icmp-err-suppress [ off | on ]
An additional option to suppress ICMP error messages on WAN IP interfaces. The default is off.
set conn name name igmp-null-src [ off | on ]
An additional option to allow setting of a 0.0.0.0 IGMP source address. The default is off.
set conn name name static ipaddr ipaddr
Specifies a static IP address when the connection type has been set to static. The default is 192.168.1.254.
NOTE:
Example:
You must also set the gateway address OR turn it off, otherwise the settings cannot be saved. See “IP Gate-
way commands” on page 36.
NOS/128600225634272/conf
Config Mode v1.3
NOS/128600225634272 (top)>> conn
NOS/128600225634272 (conn)>> set
conn
(conn) node list ...
"LAN"
"WAN"
Select (name) node to modify from list,
or enter new (name) to create.
conn name (?):
name "LAN"
link-oid ("LAN") [ LAN | WAN | PPPoE | ]:
type (static) [ static | dhcpc | ppp ]:
side (lan) [ lan | wan ]:
lan-type (private) [ private | public | public-delegated ]:
mcast-forwarding (off) [ off | on ]:
rip-send (off) [ off | v1 | v2 | v1-compat | v2-md5 ]:
rip-receive (off) [ off | v1 | v2 | v1-compat | v2-md5 ]:
fs-egress ("") [ Security | QosUpstream | WanEgress | ]:
fs-ingress ("") [ Security | QosUpstream | WanEgress | ]:
static
ipaddr ("192.168.1.254"):
netmask ("255.255.255.0"):
dhcp-server-enable (on) [ off | on ]:
dhcp-server
start-addr ("192.168.1.64"):
end-addr ("192.168.1.253"):
lease-time (01:00:00:00):
subnet-order (1) [ 1 - 8 ]:
gen-option
(gen-option) node list ...
Select (name) node to modify from list,
or enter new (name) to create.
gen-option name (?):
option-group
(option-group) node list ...
Select (name) node to modify from list,
or enter new (name) to create.
option-group name (?):
filterset
(filterset) node list ...
Select (name) node to modify from list,
or enter new (name) to create.
filterset name (?):
name "WAN"
27
Administrator’s Handbook
link-oid ("WAN") [ LAN | WAN | PPPoE | ]:
type (dhcpc) [ static | dhcpc | ppp ]: static
side (wan) [ lan | wan ]:
mcast-forwarding (off) [ off | on ]:
nat-enable (on) [ off | on ]:
rip-receive (off) [ off | v1 | v2 | v1-compat | v2-md5 ]:
icmp-echo-drop (on) [ off | on ]:
icmp-err-suppress (off) [ off | on ]:
fs-egress ("WanEgress") [ Security | QosUpstream | WanEgress | ]:
fs-ingress ("") [ Security | QosUpstream | WanEgress | ]:
static
ipaddr (""): 10.3.53.100
netmask ("255.255.255.0"):
NOS/128600225634272 (conn)>> set ip gateway address 10.3.53.1
NOS/128600225634272 (conn)>> save
If you do not want the gateway use this command to turn it off:
set ip gateway enable off
set conn name name static netmask netmask
Specifies a static netmask when the connection type has been set to static. The default is 255.255.255.0.
set conn name name dhcp-server start-addr ipaddr
If dhcp-server-enable is set to on, specifies the first address in the DHCP address range. The 2247-N8 can
reserve a sequence of up to 253 IP addresses within a subnet, beginning with the specified address for dynamic
assignment. The default is 192.168.1.64
set conn name name dhcp-server end-addr ipaddr
If dhcp-server-enable is set to on, specifies the last address in the DHCP address range. The default is
192.168.1.253
set conn name name dhcp-server lease-time lease-time
If dhcp-server-enable is set to on, specifies the default length for DHCP leases issued by the 2247-N8. The
lease time is in time format (DD:HH:MM:SS). The default is one day
(01:00:00:00).
set conn name name dhcp-server subnet-order [1... 8]
If dhcp-server-enable is set to on, specifies the order in which to address the first of 8 possible subnets. Ordinarily, this is the first one, the default
1.
set conn name name nat-enable [ on | off ]
Specifies whether you want the 2247-N8 to use network address translation (NAT) when communicating with
remote gateways. NAT lets you conceal details of your network from remote gateways. It also permits all LAN
devices to share a single IP address. By default, address NAT is turned
on.
set conn name name dhcp-client discover-time seconds
The DHCP client parameters appear when the connection type has been set to dhcpc. discover-time is in seconds; the default is
30.
set conn name name dhcp-client dns-enable [ on | off ]
This allows you to enable or disable the default behavior of acting as a DNS proxy. The default is on.
28
set conn name name dhcp-client dns-override [ off | on ]
This allows you to enable or disable overriding default DNS behavior. The default is off.
set conn name name dhcp-client vendor-class string
The vendor-class default information varies by model and components. This is information that identifies the
unit.
set conn name name fs-egress filterset_name
Attaches a user filterset to a conn which is applied to transmitted packets. See “Filterset commands” on
page 29.
set conn name name fs-ingress filterset_name
Attaches a user filterset to a conn which is applied to received packets. See “Filterset commands” on page 29.
Filterset commands
Filtersets provide packet filtering and QoS configuration. Packets are identified by characteristics that allow
QoS and forwarding decisions to be made. These characteristics can be at the MAC layer, IP layer, TCP | UDP |
ICMP layer(s), or (in applicable circumstances) 802.1q/p (VLAN-tagging) layer.
Your gateway is capable of adding and stripping 802.1Q tags to and from frames before transmission on its
LAN interfaces. See also “Link commands” on page 51
for more information.
A maximum of 8 filtersets are supported. Each filterset can have up to 8 rules configured. A maximum 8 egress
queues are supported. Each queue can have up to 8 entries.
A filterset rule identifies packet attributes to match with its
its
default action parameters.
match parameters. It acts on these packets using
set filterset name filterset_name rule number order number
Determines order of execution of filterset rules (1 before 2, etc). If order is unspecified, the value of order is
set to 1 more than the last order in the filterset. If
of other rules are incremented automatically.
order is set to an already existing order value, order values
set filterset name filterset_name rule number enable [ on | off ]
Dynamically enables or disables the specified filterset rule.
set filterset name filterset_name rule number match-eth-proto number
Matches Ethernet protocol field to the supplied value.
set filterset name filterset_name rule number match-eth-length number
Matches Ethernet length field to the supplied value.
set filterset name filterset_name rule number match-eth-p-bits number
Matches VLAN priority bits.
29
Administrator’s Handbook
set filterset name filterset_name rule number match-eth-vid number
Matches VLAN ID number.
set filterset name filterset_name rule number match-eth-src-mac-addr mac_address
Matches supplied source MAC address field.
set filterset name filterset_name rule number match-eth-dst-mac-addr mac_address
Matches supplied destination MAC address field.
set filterset name filterset_name rule number match-src-ip-addr ip_address_range
Matches supplied value with packet's source IP address field.
set filterset name filterset_name rule number match-dst-ip-addr ip_address_range
Matches supplied value with packet's destination IP address field.
set filterset name filterset_name rule number match-protocol protocol_string
Matches supplied value with packet's protocol field.
set filterset name filterset_name rule number match-tos [ number | descriptive_value ]
Matches tos field from numeric value 0-255; or one of the following descriptive values: