See Also
clear <keyword>
The clear command can be used to clear various collections of data, such as statistics, routing tables or IP mapping tables. The data will be cleared as soon as the command is executed and no warning prompt is issued.
Command |
Command Function |
|---|---|
|
Clears ATM statistics | |
|
Clears the ARP cache | |
|
Clears all ATM and AAL5 statistics | |
|
Clears the bridge MAC address table | |
|
Resets all bridge statistics to zero | |
|
Clears the static map of a MAC-to-IP address or hostname-to-IP address used by the DHCP server | |
|
Clears all DNS server hostname-to-IP address mappings | |
|
Clears all Ethernet statistics | |
|
Clears all ICMP statistics | |
| Clears all IP filter rules | |
|
Clears all IP filter statistics | |
|
Clears the IP address of the IP gateway (default route) | |
|
Clears all IP statistics | |
|
Clears the NAPT table | |
|
Clears all NAPT server entries | |
|
Clears all NAPT statistics | |
|
Clears all PPP statistics | |
|
Clears only static routes from the route table | |
|
Clears only dynamic routes from the route table | |
|
Clears all IP routing statistics | |
|
Clears all TCP statistics | |
|
Clears all UDP statistics |
The commands listed below reset user-configurable parameters back to their factory default settings. No changes will take effect until the modem is rebooted.
|
Command |
Command Function |
Default Setting |
|---|---|---|
|
Sets all user-configurable parameters to factory defaults. |
N/A | |
|
Sets the unit to operate as a bridge (enabled) or a router (disabled) |
disabled | |
|
Clears the bridge MAC address filtering database |
none | |
|
Clears the bridge filtering database |
none | |
|
Sets the DHCP mode to factory default |
enabled | |
|
Sets DHCP configuration to factory default |
none | |
|
Clears the DHCP MAC or hostname-to-IP map table |
none | |
|
Sets DNS mode to factory default |
enabled | |
|
Sets DNS forwarders to factory default |
none | |
|
Sets DNS servers to factory default |
none | |
|
Sets DNS server configuration to factory default |
none | |
|
Sets DNS domain name to factory default |
none | |
|
Sets DSL Interface to factory default |
connect | |
|
Sets Ethernet communication mode to factory default |
10 Mbps half duplex | |
|
Sets Ethernet IP Address and Network Mask to factory defaults |
10.0.0.1 | |
|
Sets the bridge/router hostname to the factory default |
ENI-Router | |
|
Sets IP filtering mode to factory default |
enable | |
|
Clears all IP filtering rules |
none | |
|
Sets default route (IP gateway) to factory default |
none | |
|
Sets NAPT mode to factory default |
disabled | |
|
Sets the PPP authorization username and password to factory defaults |
No servers configured | |
|
PPP Interface to factory default |
connect | |
|
Sets the PPP authorization username and password to factory defaults |
No username or password set | |
|
Sets the RIP configuration to the factory default |
Protocol:
RIP2 | |
|
Sets IP routes to factory default |
No IP routes configured | |
|
Sets the default router IP address to the factory default |
None | |
|
Sets the server ports to factory defaults |
||
|
Sets the SNMP configuration to the factory default |
Community
String: public | |
|
Sets the Spanning Tree (bridging algorithm) to the factory default |
disabled | |
|
Sets the Virtual Path Identifier/Virtual Circuit Identifier and Peak Cell Rate to the factory defaults |
VPI/VCI:
0/32 |
The delete commands can be used to remove various collections of data, such as MAC addresses and DNS information. The data will be deleted as soon as the command is executed and no warning prompt is issued.
|
Command |
Command Function |
|---|---|
|
Deletes an entry from the MAC address table. The MAC address is 12 characters and colons can be entered as separators | |
|
Deletes a static DHCP mapping of a MAC address or hostname to an IP address. The actual MAC address or hostname that was entered when the map was created must be entered to delete the entry. Use the show dhcpinfo command to list all of the current mappings | |
|
Deletes a static map of a hostname to an IP address from from the NS server on the router. Enter the hostname to delete the mapping | |
|
Deletes an IP filter rule specified by rule number | |
|
Deletes a NAPT server from the router. Use show naptserver to see the currently configured NAPT servers. This command requires input of the transport <protocol> ("tcp" or "udp") and the <port> specified as an integer from 0-65535 that represents a service or one of the following keywords: telnet, ftp, http, snmp, or smtp | |
| delete route <destination> <gateway> | Deletes entries from the IP routing table. This table is created by the user (using the set route command) by entering static destination IP addresses and specifying a "gateway" address for each one |
This command downloads the
application code that runs the router. When new revisions of the router software
are released by Efficient Networks, the router software can be upgraded in the
field using this command. The application can be
downloaded using XModem transfer protocol or using File Transfer Protocol (FTP).
After the firmware application is downloaded, but before it is written to the
Flash PROM, a checksum is done to ensure that the file transferred correctly.
After the file is verified, the PROM is erased and the new code is written to
the PROM. CAUTION: The router must
not be powered off or the command interrupted (using [Control-C]) while the PROM
is being erased or while the code is being written to the PROM. The firmware xmodem
command can only be used when you are logged directly into the serial port. The
serial console must have an XModem software package installed. After the command
is entered, the router will be waiting for the download via XModem. You need to
run your XModem package and execute its standard download procedures.
The firmware ftp command
can be executed from a telnet session or the serial console, as long as there is
an IP connection to the router (either over the Ethernet connection or the DSL
line) and an FTP server available on the network. This form of the command
requires the following parameters: When using the ftp form of
the command, if the server is inaccessible, the command will timeout, which may
take 30 or more seconds.
This command downloads a
configuration file that has been created using the putconfig command. The
configuration file can be downloaded using XModem transfer protocol or using
File Transfer Protocol (FTP). The getconfig xmodem
command can only be used when you are logged directly into the serial port. The
serial console must have an XModem software package installed. After the command
is entered, the router will be waiting for the download via XModem. You need to
run your XModem package and execute its standard download procedures. The getconfig ftp command
can be executed from a telnet session or the serial console, as long as there is
an IP connection to the router (either over the Ethernet connection or the DSL
line) and an FTP server available on the network. This form of the command
requires the following parameters: When using the ftp form
of the command, if the server is not accessible, the command will timeout,
which may take 30 or more seconds. This command executes the
"ping" command. It requires an IP address in standard decimal dot notation. Host
names are not accepted as input. This command sends an ICMP ECHO-REQUEST
datagram and waits for an ICMP ECHO-RESPONSE from the specified host. If the
host is not responding, the command will time out after 5 seconds. This command saves the
current configuration of the router into a file named using the <filename>
parameter. The configuration file can be saved using XModem transfer protocol or
using File Transfer Protocol (FTP). The putconfig xmodem
command can only be used when you are logged directly into the serial port. The
serial console must have an XModem software package installed. After the command
is entered, the router will be waiting for the download via XModem. You need to
run your XModem package and execute its standard download procedures. The putconfig ftp command
can be executed from a telnet session or the serial console, as long as there is
an IP connection to the router (either over the Ethernet connection or the phone
line) and an FTP server available on the network. This form of the command
requires the following parameters: When using the ftp form of
the command, if the server is not accessible, the command will timeout, which
may take 30 or more seconds.
You can exit the command
line interface by entering either quit, logout, logoff or exit.
This command will restart
the router. Any logins over telnet will be closed.
The set command
allows you to configure various parameters on the unit. The data will be
changed as soon as the command is executed and no warning prompt is issued.
firmware
<xmodem | ftp <server_ip> <username> <password>
<filename>>
getconfig <xmodem | ftp <server_ip> <username>
<password> <filename>>
ping
<ipaddress> | <hostname>
putconfig <xmodem | ftp <server_ip> <username>
<password> <filename>>
quit |
logout | logoff | exit
reboot
Set
<keyword><parameters>
|
Command |
Command Function |
|---|---|
|
Enables or disables the bridge function. When bridging is enabled, the routing function is disabled. Conversely, when bridging is disabled, routing is enabled | |
|
Displays current system mode (bridge or router) | |
|
Adds or reconfigures an entry in the static MAC address table, which is used when filtering is enabled. The MAC address may be entered with colons as separators. Each frame's source MAC address is compared to those in the address table; only if the MAC address is found in the table will the frame be forwarded | |
|
Enables or disables DHCP. DHCP will provide Ethernet-side IP addresses for devices that request them
| |
|
set dhcpcfg <<type> <start ipaddress> <netmask> <end ipaddress> <defaultrouter> <primary DNS ipaddress> <secondary DNS ipaddress> <primary WINS> <secondary WINS> <DNS Domain Name> <NetBIOS Node Type> <NetBIOS Scope ID> <lease duration>> | <relay ipaddress> |
Sets DHCP configuration. To be prompted for all of the required parameters, enter the command with no arguments |
|
Creates a static map of a MAC-to-IP address or hostname-to-IP address for use by the DHCP server. Up to 16 static address mappings can be entered by executing this command repeatedly. To remove a mapping, use the delete dhcpinfo command | |
|
Enables or disables Domain Name Service (DNS) | |
|
Configures primary and secondary DNS forwarders (servers) to be used by the DNS server on the router if the router is enabled. If the router is configured as a DNS server and it cannot resolve a DNS request, the router will send the request using this command to the primary DSN forwarder configured. If that server is unavailable, the secondary server is used. Enter the IP address of the primary forwarder first; then enter the secondary forwarder | |
|
Creates a static map of a hostname-to-IP the DNS server. Up to 64 static address mappings can be entered by repeatedly executing this command . To remove a mapping, use the delete dnsinfo command | |
|
Sets the primary DNS resolver. | |
|
Sets the DNS domain name. The name consists of a text string up to 64 characters long | |
|
This command enables the user to cycle the DSL interface through a reset sequence. The user may also disable the interface by entering "disconnect" and may bring it back up with "connect" | |
|
Sets the Ethernet communication mode | |
|
set ethip <ip address> <netmask>
|
Sets the IP address and the network mask of the Ethernet interface. If the IP address is changed, you will be prompted to confirm the change. You will be prompted to implement the change now. If you answer "y", the change takes effect immediately. If you answer "n", the change takes effect after the router is rebooted.. If you are logged in via telnet when the IP address is changed, and you answer "y", the telnet session will exit. If the address is changed through the serial port, the change takes effect immediately |
|
Sets the system hostname | |
|
Enables or disables the bridge packet filter function | |
|
set ipfiltercfg <rule> <direction> <action> <protocol> <sourceaddress> <mask> <destinationaddress> <mask> |
Sets IP filtering rules |
|
Sets the IP gateway (default route). This command requires a valid IP address and subnet mask | |
|
Enables or disables Network Address Port Translation. NAPT allows the use of private IP network addresses (per RFC 1918). With NAPT enabled and a NAPT server configured, the router can be used between an organization's LAN and the Internet (or a remote LAN) to translate IP addresses from private internal addresses to globally unique external addresses. To configure a NAPT server, see the set naptserver command | |
|
Configures one or more Network Address Port Translation (NAPT) servers on the host system. A NAPT server needs to be configured for each type of service that you want to allow through the router. For example, if a host on the local area network side of the router provides a web server that users need to access from the WAN side, you would need to configure a NAPT server using either TCP or UDP, with a <port> of "http", and with the <ipaddr> of the host system that provides the web server. NAPT must also be enabled to allow access through the router. Use show napt to see if it is enabled. If not, it can be enabled using the set napt command. Configuring no NAPT servers, even with NAPT enabled, sets up a secure firewall that prevents outside users from accessing any services on the LAN Options
| |
| set password <old password> <new password> <new password> |
The 5600 initially has no password. However, it is important set the password to protect it from being modified by users on the network. The user is prompted to type in the new password twice to verify it. To remove password protection after setting it, issue the set password command and enter nothing when prompted for the new password |
| set ppp <restart | connect | disconnect> | Allows the user to cycle the PPP interface through a reset sequence by using the restart option. The interface can be disabled using the disconnect option or enabled using the connect option |
| set pppauth <username> <password> | Configures the PPP authentication protocol. The router in its default configuration will not issue authentication requests though it will respond to them. To properly configure the router, it must be configured with the same username and password that is being used by the device at the other end of the connection. The <username> and <password> can each be up to 32 alphanumeric characters |
| set ripcfg <type> <mode> |
Configures the Routing Information Protocol on the router. The <protocol> must be specified as either rip1 (RIP version 1), rip2 (RIP version 2), or none (default is rip2). Also, a mode must be specified as either 'passive' or 'active' (the default). A routing protocol in passive mode will only listen to routing information from the network. A routing protocol in active mode will both listen and advertise routing information on the network |
| set route <host | net> <destination ipaddress> <gateway ipaddress> |
Adds static routes to the routing table for the specific host or network indicated by <destination>. The <gateway> argument indicates the network gateway to which packets should be addressed. Routes to a particular host must be distinguished from those to a network. The optional keywords net and host force the destination to be interpreted as a network or a host, respectively |
| set router <enable | disable> | Enables or disables router mode |
| set snmpcfg <community> <sysDescr> <sysLoc> <sysContact> <trapmgr> | Specifies the community string (similar to a password) and the System Description, System Location and System Contact for the Simple Network Management Protocol (SNMP). SNMP can be used by network management applications running remotely to retrieve and display status and statistics about the router |
| set spantree <mode> | Enables or disables spanning tree bridging. The spanning tree function is disabled by default. When spanning tree is enabled, it begins a negotiation process to determine which node will be the 'root' node. The modem will transition through several states (blocking, learning and forwarding) during which time command-line input will be suspended (10-30 seconds) |
|
set vc <<type> <vci> <mux> <rate>> | <<type> <vci> <type> <mux> <rate> <ip>> | <<type> <vpi> <vci> <rate> <ip>> |
Creates a Permanent Virtual Connection by specifying a VCI number (must be between 32 and 1023 and not previously used), and a Peak Cell Rate <rate> expressed in cells per second or the keyword "max" for maximum line rate. The VCI number must be the same number that is configured at the other end of the connection |
Displays the following general information about the router:
|
Command |
Command Function |
|---|---|
|
Displays the Address Resolution Protocol (ARP) cache. This table is created dynamically as the modem learns the IP address associated with the hardware (MAC) address of each of node on the network | |
|
Displays ATM and AAL5 information. Includes UNI version, number of configured VCCs, and allocated and available bandwidth. The Port Information displayed pertains specifically to the physical interface on the internal ATM adapter.
| |
|
Shows the total ATM layer and Adaptation Layer 5 (AAL5) statistics | |
| show bridge | Displays current system mode (bridge or router). Available in router mode only |
| show bridgefilter | Displays the bridge filtering as enabled or disabled. Bridge filtering is disabled by default, which causes it to act as a transparent learning bridge. When enabled, the bridge compares each frame against the user-supplied filtering database |
| show bridgemac |
Shows all MAC addresses that have been learned by the bridge and on which port they were received. The status shown indicates how the MAC address was received: Self = this is the modem's own MAC address Learned = learned by the bridge Static = the MAC address was manually entered in the static MAC address table |
| show bridgestats | Displays frame statistics on each of the ports on the bridge. It also displays the frame count of the packets discarded because of port learning (Forwarding Discards) and the number of packets that were discarded because they could not be forwarded within one second (Delay Discards) |
| show cfg | Displays the current parameter settings stored in flash memory on the router. If it is user-configurable, it is displayed |
| show conn | Displays the information about the PVC that is configured and its peak cell rate in cells per second (multiply the rate by .000424 to get Mbps). Also, a summary of the number of protocol data units (frames) transmitted and received and the number of errored PDU is displayed |
| show dhcp | Displays DHCP Mode as enabled or disabled |
| show dhcpcfg | Displays DHCP configuration |
| show dhcpinfo | Displays DHCP IP-to-MAC address table and the remaining lease time for each entry. A lease time of "Static" means it was configured manually using the set dhcpinfo command. Static entries can be removed from the table using the delete dhcpinfo command |
| show dns | Displays Domain Name Server (DNS) mode as enabled or disabled |
| show dnscfg | Displays the Domain Name Server (DNS) configuration. The Primary and Secondary DNS forwarders are listed (if any have been configured). The set dnscfg command configures the primary and secondary forwarders |
| show dnsinfo | Displays Domain Name Server (DNS) information. All currently configured hosts and their IP addresses are listed |
|
Displays the DNS Server configuration | |
| show domainname | Displays the modem's domain name. The set domainname command can be used to set this value |
| show dslinfo | Displays statistics for the modem. This includes: serial number, vendor ID, and version number of the unit. |
| show dslstats | Displays statistics for the Near End. Some of the stats are shown in "blocks". A block is equivalent to a codeword and the number of bytes in a block depends on the codeword size which is configurable. A CRC check is included at the end of each block. The "Uncorrected Blocks" counts the number of blocks that had more than one error in them and could not be corrected. The current and previous attenuation and Signal/Noise Ratio margin are also displayed in decibels. These values affect the transmission rates |
| show dslstatus | Displays current status of the DSL interface |
| show ethcfg | Displays the Ethernet Communication mode (half or full duplex) |
| show ethip | Displays the interface name, IP address, and subnet mask of the Ethernet interface. This display indicates the actual (manually configured) configuration and the current configuration. If the two do not match, then it indicates that the address/subnet mask have been modified from the command line, but the router has not yet been rebooted for the changed to take effect |
| show ethstats | Displays Ethernet statistics and any known errors that have occurred |
| show ethstatus | Displays status of the Ethernet interface |
| show hostname | Displays the modem hostname |
| show icmpstats | Displays the statistics on the Internet Control Message Protocol (ICMP) |
| show ip | Displays the current configuration of all IP interfaces configured on the router. The interface name, state (up or down), IP address and netmask are displayed |
| show ipfilter | Displays IP filtering mode as enabled or disabled (bridge only) |
| show ipfiltercfg | Displays IP filter configuration (bridge only) |
| show ipfilterstats | Displays IP filtering statistics (number of packets rejected or blocked) |
| show ipgateway | Displays IP gateway (default router) configuration |
| show ipstats | Displays collective statistics and errors IP interfaces on the router |
| show napt | Displays the current setting of Network Address Port Translation as either 'enabled' or 'disabled'. This setting is controlled by the set napt command |
| show naptmap | Shows the Transport Protocol (either TCP, UDP, or ICMP), and mapping of the LAN, WAN (PPP interface), and NAPT Port IP addresses |
| show naptserver |
Displays the configuration of all of the Network Address Port Translation Servers configured via the set naptserver command. This display shows the Transport Protocol (tcp or udp), and the mapping of each port to a local IP address. One or more NAPT servers should be configured if Network Address Port Translation is enabled. NAPT allows the use of a private IP address on the LAN segment mapped to a single public IP address on the router. With NAPT enabled and a NAPT server configured, all connections to the WAN from the LAN IP hosts appear to the WAN IP hosts as connections to and from the public IP address on the router. This is performed by mapping the private IP address and port of the LAN host to the public IP address and a possibly different port number on the router |
| show naptstats | Displays NAPT packet statistics |
| Displays a packet trace for the specified service. Possible services that can be specified are AAL5, DHCP, DNS, FTP, PPP and RIP | |
| show pppauth | Displays the current and default PPP Authentication username and password |
| show pppstats | Displays the PPP statistics and known errors that have occurred |
| show pppstatus | Displays the current PPP status |
| show ripcfg | Displays the current configuration of the Routing Information Protocol |
| show route | Displays the table of currently configured host and network static routes |
| show router | Displays current system mode (bridge or router) |
| Displays routing statistics including the number of bad routing redirects, number of dynamically created routes, number of new gateways configured due to redirects, number of unreachable destinations and the number of times a wildcard route was used | |
|
Displays the ports used by router-based servers | |
| show snmpcfg | Displays the current configuration of the SNMP parameters |
| show spantree | Displays the current configuration of the SNMP parameters |
| Displays the current configuration of the SNMP parameters | |
| Displays statistics for the Transmission Control Protocol | |
| Displays statistics for the User Datagram Protocol | |
| show vc | Displays the current configuration of all VCs configured on the router. The interface name, VC number and configured rate are displayed |
| show vcstats <vci> | Shows the total ATM Adaptation Layer 5 (AAL5) statistics for the specified <vc>. Valid VCI numbers are from 32-1023. For a complete description of the statistics shown, refer to show atmstats |