ZyXEL Communications VMG1312 Cli Reference Manual
  1. Manuals
  2. Brands
  3. ZyXEL Communications Manuals
  4. Wireless Router
  5. VMG1312
  6. Cli reference manual

ZyXEL Communications VMG1312 Cli Reference Manual

Hide thumbs Also See for VMG1312:
Table of Contents

Advertisement

Quick Links

www.zyxel.com
ZyXEL VMG1312 Broadband Router
CLI Reference Manual
Version 1.0
04/22/2013
1
ZyXEL Confidential

Advertisement

Table of Contents
loading

Related Manuals for ZyXEL Communications VMG1312

Summary of Contents for ZyXEL Communications VMG1312

  • Page 1 ZyXEL VMG1312 Broadband Router CLI Reference Manual Version 1.0 04/22/2013 ZyXEL Confidential...

  • Page 2: Table Of Contents

    www.zyxel.com Table of Contents Overview ......................3 Control Key Support ................... 4 ....................... 5 ADSL ....................... 18 ......................19 BRCTL ....................... 21 ..................22 DEFAULTGATEWAY ......................... 23 ....................24 DHCPSERVER ..................... 26 DUMPCFG ......................26 ECHO ....................27 EXITONIDLE ......................28 HELP ......................

  • Page 3: Overview

    www.zyxel.com ....................58 DUMPMDM ....................59 DUMPSYSINFO ......................59 UPTIME .................... 60 SAVE_DEFAULT ......................61 CELLD ....................... 62 XDSLCLI ...................... 68 LOGDEST ....................... 69 ..................70 VIRTUALSERVER ......................71 WLCTL ..................112 DHCPCONDSERV ....................113 IGMPCMD ....................114 LANHOSTS ......................114 WLAN ....................

  • Page 4: Control Key Support

    www.zyxel.com Selection” section. The CLI is part of the Configuration Management System (CMS), so CMS must also be enabled make menuconfig in order to have the CLI. The CLI has a “>” prompt character. If you type “sh”, you will enter the busybox shell, which has the “#” prompt character.

  • Page 5: Adsl

    www.zyxel.com 4. Clear to the beginning of line: CTL+u 5. Clear to the end of line: CTL+k 6. Delete: DEL key, or CTL+h 7. Terminate CTL-c (can ‘t terminate certain running application such as ping) The rest of the document describes each command in detail. Examples are also provided. ADSL NAME adsl –...
  • Page 6 www.zyxel.com COMMANDS start: Starts the Broadcom ADSL driver. This command calls BcmAdsl_Initialize to initialize the driver and BcmAdsl_ConnectionStart to start ADSL PHY connection if [--up] is specified. This command takes parameters that can specify various connection modes. These parameters are the same as in “configure” command.
  • Page 7 www.zyxel.com To show the “NonLinearityFlag”,“NumberOfAffectedBins” and “Echo-to-Noise Ratio (ENR)”. --version: Show current version. --help: Show the adsl support commands. OPTIONS Options for the start and configure commands : adsl start [--up] [--mod <a|d|l|t|2|p|e|m|v>] [--lpair <(i)nner|(o)uter>] [--trellis <on|off>] [--snr <snrQ4>] [--bitswap <on|off>][--sesdrop <on|off>][--sra <on|off>][--CoMinMgn<on|off>][--i24k<on|off>][--phyReXmt...
  • Page 8 www.zyxel.com --snr <snrQ4> : Specify SNR margin as Q4 number --bitswap <on|off> : Enables or disables ADSL bitswap --sesdrop <on|off>: Enables or disables SESdrop --sra <on|off> : Enables or disables SRA --CoMinMgn <on|off> : Enables or disables Co Minimum Margin Drop --i24k <on|off>...
  • Page 9 www.zyxel.com Options for the stop command adsl stop : Options for the connection command adsl connection [--up] [--down] [--loopback] [--reverb] [--medley] [--noretrain] [--L3][--diagMode][--Lo] [--tones <xmtStart xmtNum xmtMap rcvStart rcvNum rcvMap>] [--normal][--freezeReverb][--freezeMedley] --up : Starts ADSL connection in normal mode --down : Puts ADSL PHY in idle mode --loopback : Puts ADSL PHY in ATM cell loopback mode.
  • Page 10 www.zyxel.com Tone configuration command does not cause ADSL PHY retrain automatically. To experience the effect of this command ADSL connection must be restarted using for example adsl connection –down followed by adsl connection –up command. Tone selection is not affected by adsl configure commands and has to be changed explicitly. --normal : Puts modem in Normal mode --freezeReverb :...
  • Page 11 www.zyxel.com --show : Displays more statistics about ADSL connection. --stats : Displays all available statistics about ADSL connection. --SNR : Displays signal to noise ratio (SNR) per tone in dB --QLN : Displays Quiet Line Noise (QLN) per tone in dBm/Hz --Hlog : Displays Hlog (Channel Response) per tone in dB --Hlin :...
  • Page 12 www.zyxel.com Tone number -180.0000 -180.0000 -180.0000 . . . Tone number -90.0000 -142.0000 -143.0000 -144.0000 . . . Tone number Hlog 0.0000 0.0000 0.0000 0.0000 . . . Hlin scale factor: DS = 0 US = 0 Tone number Hlin .
  • Page 13 www.zyxel.com Line 0 DS HLOG (dB) (grouped by 8 tones): 0 : -96.0 -96.0 -96.0 -96.0 -96.0 -8.4 -7.1 -6.1 -5.5 -5.2 10 : -4.9 -4.8 -4.6 -4.5 -4.5 -4.4 -4.4 -4.5 -4.6 -4.7 . . . Line 0 US HLOG (dB) (grouped by 8 tones): 0 : -96.0 -96.0 -96.0 -96.0 -96.0 -96.0 -96.0 -96.0 -96.0 -96.0 .
  • Page 14 www.zyxel.com adsl qlnmntr [--time] [--freq] --time : Sets the time in seconds for which QLN monitoring is to be done. If set to 0 , monitoring will be done for ever. --freq : Sets the frequency in milli-seconds of QLN reporting. At the end of monitoring time , the result is available in the QLN MIB info and can be seen using adsl info --QLN : Also, during the monitoring period the updated results is being updated in MIB and can be seen...
  • Page 15 www.zyxel.com . . . [99-INF]: 0 Guidelines and description for diag command adsl diag [--logstart < nBytes to store statuses > ] [--logpause ] [--logstop] [--loguntilbufferfull] [--loguntilretrain] adsl --logstart : Start logging statues locally and will wrap around when the buffer is full adsl --logpause : Pause logging adsl --logstop :...
  • Page 16 www.zyxel.com ADSL_INVALID_NUMBER_OF_PARAMETERS 106 EXAMPLES ° A simple initialization. > adsl start [--up] > adsl start > adsl connection --up ° A more complex initialization. > adsl start --up --mod d l--lpair I > adsl start > adsl connection --up --mod dl --lpair I °...
  • Page 17 www.zyxel.com BERT Total Time = 60 sec BERT Elapsed Time = 60 sec BERT Bits Tested = 0x000000001A1E5500 bits BERT Err Bits = 0x0000000000000067 bits ° Display minimal ADSL state. > adsl info –-state adsl: ADSL driver and PHY status Status: Showtime Channel: FAST, Upstream rate = 8064 Kbps, Downstream rate = 1024 Kbps °...

  • Page 18: Arp

    www.zyxel.com --show : To show the “NonLinearityFlag”,“NumberOfAffectedBins” and “Echo-to-Noise Ratio (ENR)”. --setThld : To setting “NumberOfAffectedBins” Guidelines and description for --version command adsl --version Show current version. Guidelines and description for --help command adsl --help Show the adsl support commands. EXAMPLES >...

  • Page 19: Brctl

    www.zyxel.com ° Show ARP table. > arp show IP address HW type Flags HW address Mask Device 192.168.1.3 0x1 0x2 00:01:03:E3:4F:F9 * br0 192.168.1.2 0x1 0x6 00:11:22:33:44:55 * br0 ° Delete ARP entry for IP address 192.168.1.2. > arp delete 192.168.1.2 BRCTL NAME brctl –...
  • Page 20 www.zyxel.com Makes the interface <device> a port of the bridge <bridge>. This means that all frames received on <device> will be processed as if destined for the bridge. Also, when sending frames on <bridge>, <device> will be considered as a potential output interface. delif <bridge>...

  • Page 21: Cat

    www.zyxel.com <addr> is group_mac_address/src_mac_address. clearportsnooping <bridge> <port> <addr> Removes an entry for a port <port> from the port snooping table of the bridge <bridge>. The format of the <addr> is group_mac_address/src_mac_address. showportsnooping <bridge> Display the current contents of the port snooping table. enableportsnooping <enable>...

  • Page 22: Defaultgateway

    www.zyxel.com cat [FILE] ... DESCRIPTION Concatenates FILE(s) and prints them to standard output COMMANDS None. OPTIONS None. EXAMPLES ° Display system memory > cat /proc/meminfo DEFAULTGATEWAY NAME defaultgateway – configure or show the default gateway or default route SYNOPSIS defaultgateway config [<interface(s) sperated by ',' with NO SPACE. eg.
  • Page 23 www.zyxel.com IPoA does not support DHCP. If the default gateway is configured with the "auto" option, the system needs to be rebooted before it can take effect. If there are multiple WAN interfaces with DHCP or PPP enabled, multiple remote gateway addresses may be received and the first received will be chosen to be the default gateway.

  • Page 24: Dhcpserver

    www.zyxel.com > df ° Display the space available on the flash root file system df /dev/mtdblock0 DHCPSERVER NAME dhcpserver – allow a user to configure, or show the DHCP Server data SYNOPSIS dhcpserver config <start IP address> <end IP address> <leased time (hour)> dhcpserver show dhcpserver --help DESCRIPTION...
  • Page 25 www.zyxel.com dhcpserver config <start IP address> <end IP address> <leased time (hour)>. <start IP address> The IP address of the first address in the range. The value of range start must be less than or equal to the value of range end. Valid values: any valid IP address.

  • Page 26: Dumpcfg

    www.zyxel.com Usage: dhcpserver config <start IP address> <end IP address> <leased time (hour)> dhcpserver show dhcpserver –help DUMPCFG NAME dumpcfg – displays the system’s configuration SYNOPSIS dumpcfg [dynamic] DESCRIPTION dumpcfg displays the system’s configuration which is in text XML format. COMMANDS None.

  • Page 27: Exitonidle

    www.zyxel.com SYNOPSIS echo [OPTION]... [STRING]... DESCRIPTION echo displays a line of text, or an environment variable’s value. Notice that “ls” command is not supported in the CLI. Echo can be used to display files and subdirectories using wildcard „*‟. COMMANDS None.

  • Page 28: Help

    www.zyxel.com By default, the CLI will automatically log you out after 600 seconds of inactivity. To set the exit-on-idle timeout to a different value, use exitonidle set [number of seconds]. To disable exit-on-idle, set the number of seconds to 0. The exit-on-idle value is only effective for the current session.
  • Page 29 www.zyxel.com ifconfig [interface] ifconfig interface [aftype] options | address ... DESCRIPTION Ifconfig is used to configure the kernel-resident network interfaces. It is used at boot time to set up interfaces as necessary. After that, it is usually only needed when debugging or when system tuning is needed.
  • Page 30 www.zyxel.com mtu N This parameter sets the Maximum Transfer Unit (MTU) of an interface. dstaddr addr Set the remote IP address for a point-to-point link (such as PPP). This keyword is now obsolete; use the pointopoint keyword instead. netmask addr Set the IP network mask for this interface.

  • Page 31: Kill

    www.zyxel.com outfill N This parameter sets the interface outfill timeout. keepalive N This parameter sets the interface keepalive timeout. txqueuelen length Set the length of the transmit queue of the device. It is useful to set this to small values for slower devices with a high latency (modem links, ISDN) to prevent fast bulk transfers from disturbing interactive traffic like telnet too much.

  • Page 32: Lan

    www.zyxel.com pid... Specify the list of processes that kill should sigal. -signal given as a signal name or number. -l List all signal names and numbers. EXAMPLES ° Terminate the process with pid 120 > kill 120 ° Send KILL signal to the process with pid 120 >...
  • Page 33 www.zyxel.com ° Enable or disable the DHCP server on the primary LAN interface. DHCP server is not supported on the secondary LAN interface. ° Enable or disable the DHCP client on the primary LAN interface. When DHCP client is enabled, the user must first disable DHCP server.

  • Page 34: Loglevel

    www.zyxel.com Default value is enable for the primary LAN interface. --dhcpclient <enable|disable> Options for the delete command lan delete --ipaddr <primary|secondary> --ipaddr <primary|secondary> primary|secondary – specify which LAN interface will be deleted. Valid values: primary or secondary. Options for the show command lan show [<primary|secondary>] primary|secondary –...

  • Page 35: Logout

    www.zyxel.com loglevel – get or set the CMS logging levels for applications that support this feature SYNOPSIS loglevel get appname loglevel set appName [Debug|Notice|Error] appname is the name of an app that supports CMS loglevels. Currently, this is httpd, tr69c, smd, ssk, telnetd, sshd, consoled, upnp, dnsproxy.

  • Page 36: Meminfo

    www.zyxel.com Login: admin Password: > logout Bye bye. Have a nice day!!! MEMINFO NAME meminfo – display various information about memory usage by various applications and also the CMS shared memory. This command is useful for diagnosing memory leaks. SYNOPSIS meminfo [appname] [command] DESCRIPTION meminfo has two variants.

  • Page 37: Passwd

    www.zyxel.com For the most up-to-date usage info on meminfo, type meminfo –h For more details on how to use the meminfo command, please see the CMS Devlopement and Porting Guide, available from DocSafe. EXAMPLES Display basic memory statistics for the current app: >...

  • Page 38: Ppp

    www.zyxel.com ping – send ICMP echo requests to target host SYNOPSIS ping [OPTIONS] host DESCRIPTION Ping sends out ICMP echo requests over the ICMP protocol to a host on the network. The default number of the ICMP echo request packets ping sends out is four. To continually send out packets without stop, use "-c 0"...
  • Page 39 www.zyxel.com ppp is used to control the ppp interfaces. Ppp command brings up the ppp connection with "up" option, and brings down the connection with "down" option. For ppp connection in on-demand mode, in addition to the "up" option, traffic to the ppp interface needs to be initiated to bring the connection up. <ppp interface name (eg.

  • Page 40: Psp

    www.zyxel.com > ps NAME psp – various operations on the persistent scratch pad SYNOPSIS psp [command] psp [command token] DESCRIPTION psp allows you to perform various operations on the persistent scratch pad area of the flash memory. Commands are: list all the entries in the psp (identified by their names/”tokens”) list: dump <token>: dump the contents of the specified token.

  • Page 41: Pwd

    www.zyxel.com NAME pwd – print name of current working directory SYNOPSIS DESCRIPTION pwd is a CLI command used to display name of current working directory. EXAMPLES ° To see current working directory. >pwd REBOOT NAME reboot – reboot the system SYNOPSIS reboot DESCRIPTION...

  • Page 42: Restoredefault

    www.zyxel.com RESTOREDEFAULT NAME restoredefault – restore modem configuration to factory defaults SYNOPSIS restoredefault DESCRIPTION restoredefault is a CLI command used to erase all configurations made by user, and restore the modem back to factory default configuration. Once this command is executed, modem reboots automatically with default configuration.
  • Page 43 www.zyxel.com COMMANDS add add a new route entry delete delete a route entry show show current content of routing table including static and dynamic route entries OPTIONS ipaddress the destination network or host IP address in dotted decimal notation. subnetmask when adding a network route, the netmask must be specified.

  • Page 44: Save

    www.zyxel.com The netmask for the destination net; 255.255.255.255 for a host destination and 0.0.0.0 for the default route. Flags Possible flags include U (route is up) H (target is a host) G (use gateway) R (reinstate route for dynamic routing) D (dynamically installed by daemon or redirect) M (modified from routing daemon or redirect) FILES...

  • Page 45: Swversion

    www.zyxel.com DESCRIPTION sntp command synchronizes automatically the router‟s time with the specified internet timer servers. OPTIONS disable If SNTP is enable, disable it (require reboot). date Show the current date and time of the routeer. zones Show the list of the supported zones. EXAMPLES To set up sntp server with “Pacific Time, Tijuana”...

  • Page 46: Sysinfo

    > swversion -b 091104_1517 Display DSL phy and driver version > swversion –d A2pB026.d22f Display CPE Model name > swversion -m VMG1312-B10B Display Bootloader (CFE) version > swversion -c 1.0.38-112.118 SYSINFO NAME sysinfo – display the general system information SYNOPSIS...

  • Page 47: Tftp

    www.zyxel.com OPTIONS None. EXAMPLES ° Display the system information > sysinfo TFTP NAME tftp – tftp client to update software or retrieve and backup the configuration data. SYNOPSIS Usage: tftp [OPTION]... tftp_server_ip_address DESCRIPTION Tftp client is used for transferring files to and from a remote site. Broadcom extend its capacity to update the software and configuration data from a remote tftp server as well as backup the configuration to the remote tftp server.

  • Page 48: Wan

    www.zyxel.com 2). To restore configuration data: > tftp -g -t c -f mdm.config 192.168.1.2 3). To update software: > tftp -g -t i -f bcm96345_fs_kernel 192.168.1.2 4). To transmit and retrieve files: > tftp -p -r remote_file -l local_file 192.168.1.2 >...
  • Page 49 www.zyxel.com wan add service add a service layer 3 WAN interface – such as pppoe, ipoe, bridge and pppoa and ipoa connection based on a layer 2 interface. wan show interface displays the current layer 2 interfaces configured in the system with information on xDSL type (ATM/PTM) and port, link type andncapsulation service category wan show...
  • Page 50 www.zyxel.com <port> <--priority> (ptm) port: port number of the PTM VCC to add. Valid values: 0-1. Priority: normal/high/both. Options for the add service command Usage: wan add service <interfacename> --protocol <bridge|ipoe|pppoe|ipoa|pppoa> wan add service <L2interfacename> --protocol bridge [--service <servicename>] wan add service <L2interfacename> --protocol ipoe [--firewall <enable|disable>] [--nat <enable|disable>] [--igmp <enable|disable>] [--ipaddr <wanipaddress>...
  • Page 51 www.zyxel.com Vcmux - RFC2684 VC-MUX (null encapsulation). Default value: llc for bridge, pppoe, ipoe, or ipoa. Vcmux for pppoa. --service <servicename> The service name of the WAN interface. Valid values: strings of 32 characters. Default value: <protocol>_<vpi>_<vci>. --firewall <enable|disable> The firewall state of the IPOE or IPoA interface. Notice that firewall is always enabled on a PPPoE or a PPPoA interface.
  • Page 52 www.zyxel.com PPP connection will be torn down when there is no user data activity over the WAN interface for more than this idle time period. Default value: 30 minutes. --pppipextension <disable|enable> The PPP IP extension mode of a PPPoE or PPPoA interface. This option is only applied to a PPPoE or PPPoA interface.
  • Page 53 www.zyxel.com Valid values: 0 - 255. Default value: 0 vci: VCI of the VCC to add. Valid values: 32 - 65535. Default value: 35 If <port.vpi.vci> is obmitted then it will display summary state of all existing WAN services. Options for the --help command wan –help [<bridge|pppoe|pppoa|ipoe|ipoa>] <bridge|pppoe|pppoa|ipoe|ipoa>...
  • Page 54 www.zyxel.com > wan add service ptm0/0 --protocol ipoe --dhcpclient enable --nat enable --firewall enable --dnsifname ptm0 --gatewayifname ptm0 To delete: > wan delete service ptm0 > wan delete interface ptm 0 --priority normal ° Configure a bridge configuration ATM interface: To add: >...
  • Page 55 www.zyxel.com Con. Service Interface Proto. IGMP Status Name Name address ipoe_0_0_1 ptm0 IPoE Disable Connected 10.6.37.15 Wan show (ATM): All services associated with atm2 is activated. Con. Service Interface Proto. IGMP Status Name Name address 0.0.35 pppoe_0_0_35 ppp0 PPPoE Disable Connected 10.6.33.155 0.0.36 pppoa_0_0_36 pppoa1 PPPoA...

  • Page 56: Exit

    www.zyxel.com wan delete service L3IfName wan show interface wan show [<port.vpi.vci>] wan --help <bridge|pppoe|pppoa|ipoe|ipoa> wan –help ipoa Usage: wan add service <L2interfacename> --protocol ipoa --ipaddr <wanipaddress> <wansubnetmask [--service <servicename>] [--firewall <enable|disable>] [--nat <enable|disable>] [--igmp <enable|disable>] wan delete interface atm <port.vpi.vci> wan delete interface ptm <port>...

  • Page 57: Quit

    www.zyxel.com exit is used to log out current user console. After exit command is executed, a bye bye message appears. Hit return to see a new Login prompt. EXAMPLES ° Logout user admin. Login: admin Password: > exit Bye bye. Have a nice day!!! QUIT NAME quit –...

  • Page 58: Dumpmdm

    www.zyxel.com syslog DESCRIPTION syslog can displays or delete the log message and messages is create by system or application debug mode then the messages contains errors and alerts. COMMANDS syslog dump syslog clear syslog help OPTIONS None. EXAMPLES ° Display the system log information >...

  • Page 59: Dumpsysinfo

    www.zyxel.com EXAMPLES ° Display the system’s date model configuration not saved in flash memory. > dumpmdm DUMPSYSINFO NAME dumpsysinfo – displays all system’s configuration information. SYNOPSIS dumpsysinfo DESCRIPTION dumpsysinfo will displays system’s configuration information including “MDM”,”config”,”sysinfo”,”psp”,”CPE”,“version”,”network”,”Wireless”,”kernel”,”memory”,”modules”. COMMANDS None. OPTIONS None. EXAMPLES °...

  • Page 60: Save_Default

    www.zyxel.com uptime DESCRIPTION uptime gives a one line display of the following information. The current time, how long the system has been running, how many users are currently logged on, and the system load averages for the past 1, 5, and 15 minutes.

  • Page 61: Celld

    www.zyxel.com None. EXAMPLES ° Display the system log information > save_default show ° Save the settings information > save_default save ° Delete the settings information > save_default clean CELLD NAME celld –Celld is used to handle the 3G process. after the 3G dongle is inserted or disconnected, celld will get the message and celld will decide if 3G needs to be dial up or down, celld will communicate with pppd by sending CMS message to pppd, and after pppd is dial up or down, it will send CMS message back to celld to let celld know the 3G status.

  • Page 62: Xdslcli

    www.zyxel.com celld powerUpTimeout <time>OPTIONS None. EXAMPLES ° Setting the celld debug level > celld loglevel Error ° Setting the celld check time > celld checkingTime 5 °Setting the celld power up timeout > celld powerUpTimeout 5 XDSLCLI NAME xdslcli – allow a user to control the Broadcom BCM63xx ADSL driver SYNOPSIS xdslcli start [options] xdslcli stop...
  • Page 63 www.zyxel.com ° display status and information of XDSL driver and connection ° display statistics for XDSL driver and connection All information is displayed to stdout. A program or shell script that calls this utility can redirect stdout COMMANDS start: Starts the Broadcom XDSL driver. This command calls BcmXdsl_Initialize to initialize the driver and BcmXdsl_ConnectionStart to start XDSL PHY connection if [--up] is specified.
  • Page 64 www.zyxel.com Command to configure shape of snrclamping mask. info : About the xdsl link information. nlnm : To show the “NonLinearityFlag”,“NumberOfAffectedBins” and “Echo-to-Noise Ratio (ENR)”. --version: Show current version. --help: Show the xdsl support commands. OPTIONS Options for the start and configure commands : xdsl start [--up] [--mod <a|d|l|t|2|p|e|m|v>] [--lpair <(i)nner|(o)uter>] [--trellis <on|off>]...
  • Page 65 www.zyxel.com --lpair <(i)nner|(o)uter>: (i)nner –inner loop pair is used (o)uter – outer loop pair is used --trellis <on|off> : Enabled or disables trellis coding --snr <snrQ4> : Specify SNR margin as Q4 number --bitswap <on|off> : Enables or disables XDSL bitswap --sesdrop <on|off>: Enables or disables SESdrop --sra <on|off>...
  • Page 66 www.zyxel.com (D)BM - DBM mode (F)BM - FBM mode --ccw : Enables special CRC workaround for Centillium modems Options for the stop command xdsl stop : Options for the connection command xdsl connection [--up] [--down] [--loopback] [--reverb] [--medley] [--noretrain] [--L3][--diagMode][--Lo] [--tones <xmtStart xmtNum xmtMap rcvStart rcvNum rcvMap>] [--normal][--freezeReverb][--freezeMedley] --up :...
  • Page 67 www.zyxel.com Specifies tones which can be used by XDSL PHY. Tone ranges should be given separated by commas. For example, to select tones 0 to 100 and 200 to 300 use: --tones 0-100,200-300 : Tone configuration command does not cause XDSL PHY retrain automatically. To experience the effect of this command XDSL connection must be restarted using for example xdsl connection –down followed by xdsl connection –up command.

  • Page 68: Logdest

    www.zyxel.com Displays the shortest message about XDSL PHY connection state, e.g. xdsl: XDSL driver and PHY status Status: Showtime Channel: FAST, Upstream rate = 8064 Kbps, Downstream rate = 1024 Kbps --show : Displays more statistics about XDSL connection. --stats : Displays all available statistics about XDSL connection.

  • Page 69: Dns

    www.zyxel.com logdest DESCRIPTION logdest will displays a application debug level, where appname is one of: httpd, http_ssl, tr69c, smd, ssk, telnetd, sshd, consoled, upnp, dnsproxy loglevel is "Standard Error", "Syslog" or "Telnet". COMMANDS usage: logdest get appname logdest set appname logdest OPTIONS None.

  • Page 70: Virtualserver

    www.zyxel.com If the default dns is configured with the "auto" option, the system needs to be rebooted before it can take effect. If there are multiple WAN interfaces with DHCP or PPP enabled, multiple remote gateway addresses may be received and the first received will be chosen to be the default dns. OPTIONS None EXAMPLES...

  • Page 71: Wlctl

    www.zyxel.com EXAMPLES o Display the current Port mapping rule(virtual server) > virtualserver show o Disable the current Port mapping rule(virtual server) > virtualserver disable 1-xxx WLCTL NAME wlctl –This command available in the Broadcom WLAN client utility. (refer by WLTool-80211-TI300-R.pdf) SYNOPSIS The command syntax is as follows: wlctl [-a|i <adapter>] [-h] [-d|u|x] <command>...
  • Page 72 www.zyxel.com Syntax: > wlctl ver Example: 4.150 RC6.0 wl0: May 8 2007 20:35:49 version 4.150.6.0 cmds Generates a short list of available commands. Syntax: > wlctl cmds Example: a_rate counters nvset set_pmk a_mrate csscantimer nvget scan ap closed nvram_get spect atten closednet noise scanresults list Lists all installed wireless adapters.
  • Page 73 www.zyxel.com wepkey xxxx The amode or authentication mode choices are open or shared. Reinitializes and marks the adapter up (operational). Syntax: > wlctl up This command makes the interface operational. It does all the necessary initialization to bring up the interface.
  • Page 74 www.zyxel.com ‧ Restore to a known good default state. Marks the adapter down, but does not reset the hardware (disabled). Syntax: > wlctl out On dual-band cards, the card must be band-locked before use. restart Restarts the driver. Syntax: > wlctl restart The driver must already be down (you should do a wlctl down before restarting the driver).
  • Page 75 www.zyxel.com > wlctl event_msgs Event messages bit vector: WLC_E_SET_SSID 0 /* indicates status of set SSID */ WLC_E_JOIN 1 /* differentiates join IBSS from found (WLC_E_START) IBSS */ WLC_E_START 2 /* STA founded an IBSS or AP started a BSS */ WLC_E_AUTH 3 /* 802.11 AUTH request */ counters Returns the driver counter values.
  • Page 76 www.zyxel.com Example return: wl0: May 8 2007 20:35:49 version 4.150.6.0 …………… …………… srdump Prints the contents of SPROM to STDOUT (dumps 64 16-bit words of the SROM present on-board). For details of the individual locations, check the Broadcom SROM memory map for that specific design.
  • Page 77 www.zyxel.com cis_source Display which source is used for the SDIO CIS cisconvert Print CIS tuple for given name=value pair rdvar Read a named variable to the srom wrvar Write a named variable to the srom nvram_source Display which source is used for nvram nvram_dump print nvram variables to stdout nvset...
  • Page 78 www.zyxel.com 1: PS (power-save) 2: FAST PS mode wake set driver power-save mode sleep state: 0: core-managed 1: awake promisc set promiscuous mode ethernet address reception 0 - disable 1 - enable monitor set monitor mode 0 - disable 1 - enable active monitor mode (interface still operates) frag Deprecated.
  • Page 79 www.zyxel.com valid values for 802.11a are (6, 9, 12, 18, 24, 36, 48, 54) valid values for 802.11b are (1, 2, 5.5, 11) valid values for 802.11g are (1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54) -1 (default) means automatically determine the best rate a_rate force a fixed rate for the A PHY: valid values for 802.11a are (6, 9, 12, 18, 24, 36, 48, 54)
  • Page 80 www.zyxel.com Get the current mcs set chanspecs Get all the valid chanspecs (default: all within current locale): -b band (5(a) or 2(b/g)) -w bandwidth, 10,20 or 40 [-c country_abbrev] chanspec Set <channel>[a,b][n][u,l] channel number (0-224) band a=5G, b=2G, default to 2G if channel <= 14 bandwidth, n=10, none for 20 &...
  • Page 81 www.zyxel.com txpwrlimit Return current tx power limit powerindex Set the transmit power for A band(0-63). -1 - default value atten Set the transmit attenuation for B band. Args: bb radio txctl1. auto to revert to automatic control manual to supspend automatic control phyreg Get/Set a phy register: offset [ value ] [ band ]...
  • Page 82 www.zyxel.com set the pll to reset value Usage: wlctl pllreset pcieserdesreg g/set SERDES registers: dev offset [val] ampdu_activate_test actiate ampdu_tid enable/disable per-tid ampdu; usage: wlctl ampdu_tid <tid> [0/1] ampdu_retry_limit_tid Set per-tid ampdu retry limit; usage: wlctl ampdu_retry_limit_tid <tid> [0~31] ampdu_rr_retry_limit_tid Set per-tid ampdu regular rate retry limit;...
  • Page 83 www.zyxel.com usage: wlctl actframe <Dest Mac Addr> <data> channel dwell-time <BSSID> antdiv Set antenna diversity for rx 0 - force use of antenna 0 1 - force use of antenna 1 3 - automatic selection of antenna diversity txant Set the transmit antenna 0 - force use of antenna 0 1 - force use of antenna 1 3 - use the RX antenna selection that was in force during...
  • Page 84 www.zyxel.com keys Prints a list of the current WEP keys Print Tx Sequence Couter for key at specified key index. wsec_test Generate wsec errors wsec_test <test_type> <keyindex|xx:xx:xx:xx:xx:xx> type 'wlctl wsec_test ?' for test_types tkip_countermeasures Enable or disable TKIP countermeasures (TKIP-enabled AP only) 0 - disable 1 - enable wsec_restrict...
  • Page 85 www.zyxel.com 8 - WSEC in software 0x80 - FIPS enabled 0x100 - WAPI enabled auth set/get 802.11 authentication type. 0 = OpenSystem, 1= SharedKey, 2=Open/Shared wpa_auth Bitvector of WPA authorization modes: WPA-NONE WPA-802.1X/WPA-Professional WPA-PSK/WPA-Personal WPA2-802.1X/WPA2-Professional WPA2-PSK/WPA2-Personal disable WPA wpa_cap set/get 802.11i RSN capabilities set_pmk Set passphrase for PMK in driver-resident supplicant.
  • Page 86 www.zyxel.com -n N, --nprobes=N number of probes per scanned channel -a N, --active=N dwell time per channel for active scanning -p N, --passive=N dwell time per channel for passive scanning -h N, --home=N dwell time for the home channel between channel scans -c L, --channels=L comma or space separated list of channels to scan iscan_c...
  • Page 87 www.zyxel.com --bss_type=BT [bss/infra|ibss/adhoc] bss type to scan -b MAC, --bssid=MAC particular BSSID MAC address to scan, xx:xx:xx:xx:xx:xx -n N, --nprobes=N number of probes per scanned channel -a N, --active=N dwell time per channel for active scanning -p N, --passive=N dwell time per channel for passive scanning -h N, --home=N dwell time for the home channel between channel scans -c L, --channels=L...
  • Page 88 www.zyxel.com channels Return valid channels for the current settings. channels_in_country Return valid channels for the country specified. Arg 1 is the country abbreviation Arg 2 is the band(a or b) curpower Return current tx power settings. -q (quiet): estimated power only. curppr Return current tx power per rate offset.
  • Page 89 www.zyxel.com integer - 0: default 1: optimize bandwidth 2: optimize distance [-1, -99]: dBm trigger value roam_delta Set the roam candidate qualification delta. roam_delta [integer [, a/b]] roam_scan_period Set the roam candidate qualification delta. (integer) suprates Returns or sets the 11g override for the supported rateset With no args, returns the rateset.
  • Page 90 www.zyxel.com For a specific built-in country definition: wlctl country <built-in> [<advertised-country>] Where <built-in> is a country country code followed by '/' and regulatory revision number. For example, "US/3". And where <advertised-country> is either a long name or country code from ISO 3166. If <advertised-country>...
  • Page 91 www.zyxel.com lazywds Set or get "lazy" WDS mode (dynamically grant WDS membership to anyone). noise Get noise (moving average) right after tx in dBm fqacurcy Manufacturing test: set frequency accuracy mode. freqacuracy syntax is: fqacurcy <channel> Arg is channel number 1-14, or 0 to stop the test. crsuprs Manufacturing test: set carrier suppression mode.
  • Page 92 www.zyxel.com AP only (G mode): Check for beacons without NONERP element(0=Examine beacons, 1=Ignore beacons) pktcnt Get the summary of good and bad packets. upgrade Upgrade the firmware on an embedded device gmode Set the 54g Mode (LegacyB|Auto||GOnly|BDeferred|Performance|LRS) gmode_protection Get G protection mode. (0=disabled, 1=enabled) gmode_protection_control Get/Set 11g protection mode control alg.(0=always off, 1=monitor local association, 2=monitor overlapping BSS)
  • Page 93 www.zyxel.com rssi_levels: Variable number of RSSI levels (maximum 8) in increasing order (e.g. -85 -70 -60). An event will be posted each time the RSSI of received beacons/packets crosses a level. fasttimer Deprecated. Use fast_timer. slowtimer Deprecated. Use slow_timer. glacialtimer Deprecated.
  • Page 94 www.zyxel.com 3 = wlan automatic 4 = wlan automatic with noise reduction interference_override Get/Set interference mitigation override. Choices are: 0 = no interference mitigation 1 = non wlan 2 = wlan manual 3 = wlan automatic 4 = wlan automatic with noise reduction -1 = remove override, override disabled frameburst Disable/Enable frameburst mode...
  • Page 95 www.zyxel.com Clear all host-ip addresses arp_stats Display ARP offload statistics arp_stats_clear Clear ARP offload statistics Get/Set wireless ethernet bridging mode Get/Set the beacon period (bi=beacon interval) dtim Get/Set DTIM wds_remote_mac Get WDS link remote endpoint's MAC address wds_wpa_role_old Get WDS link local endpoint's WPA role (old) wds_wpa_role Get/Set WDS link local endpoint's WPA role authe_sta_list...
  • Page 96 www.zyxel.com count (0-254) channel number (0-224) band a=5G, b=2G bandwidth n=10, non for 20 & 40 ctl sideband, l=lower, u=upper, default no ctl sideband constraint Send an 802.11h Power Constraint IE Usage: wlctl constraint 1-255 db rm_req Request a radio measurement of type basic, cca, or rpi specify a series of measurement types each followed by options.
  • Page 97 www.zyxel.com <xx>: value 0 to disable, 1 to enable U-APSD per AC wme_dp Set AC queue discard policy. Usage: wlctl wme_dp <be> <bk> <vi> <vo> <xx>: value 0 for newest-first, 1 for oldest-first wme_counters print WMM stats wme_clear_counters clear WMM counters wme_tx_params wlctl wme_tx_params [be|bk|vi|vo [short|sfb|long|lfb|max_rate <value>] ...] wme_maxbw_params...
  • Page 98 www.zyxel.com Bit 5 - Assoc/Reassoc Req Example: wlctl add_ie 3 10 00:90:4C 0101050c121a03 to add this IE to beacons and probe responses del_ie Delete a vendor proprietary IE from 802.11 management packets Usage: wlctl del_ie <pktflag> length OUI hexdata <pktflag>: Bit 0 - Beacons Bit 1 - Probe Rsp Bit 2 - Assoc/Reassoc Rsp Bit 3 - Auth Rsp...
  • Page 99 www.zyxel.com set/get the delta statistics interval in seconds (0 to disable) delta_stats get the delta statistics for the last interval assoc_info Returns the assoc req and resp information [STA only] autochannel auto channel selection: 1 to issue a channel scanning; 2 to set chanspec based on the channel scan result;...
  • Page 100 www.zyxel.com staname get/set station name: Maximum name length is 15 bytes apname get AP name otpdump Dump raw otp otpstat Dump OTP status nrate -r legacy rate (CCK, OFDM)-m mcs index-s stf mode (0=SISO,1=CDD,2=STBC(not supported),3=SDM)-w Override mcs only to support STA's with/without STBC capability mimo_txbw get/set mimo txbw (2=20Mhz(lower), 3=20Mhz upper, 4=40Mhz, 5=40Mhz dup<mcs32 only) cac_addts...
  • Page 101 www.zyxel.com cac_tspec_ea Get specific TSPEC for given STA with matching TSINFO eg. 'wlctl cac_tspec 0xaa 0xbb 0xcc xx:xx:xx:xx:xx:xx' where 0xaa 0xbb & 0xcc are TSINFO octets and xx is mac address phy_txpwrindex usage: (set) phy_txpwrindex core0_idx core1_idx core2_idx core3_idx (get) phy_txpwrindex, return format: core0_idx core1_idx core2_idx core3_idxSet/Get txpwrindex phy_test_tssi wlctl phy_test_tssi val...
  • Page 102 www.zyxel.com usage: wlctl phytable table_id offset width_of_table_element [table_element] Set/get table element of a table with the given ID at the given offset Note that table width supplied should be 8 or 16 or 32 table ID, table offset can not be negative pavars Set/get temp PA parameters usage: wlctl down wlctl pavars pa2gw0a0=0x1 pa2gw1a0=0x2 pa2gw2a0=0x3 ...
  • Page 103 www.zyxel.com where utx = TX unicast antenna configuration urx = RX unicast antenna configuration dtx = TX default (non-unicast) antenna configuration drx = RX default (non-unicast) antenna configuration txcore Usage: wlctl txcore -k <CCK core mask> -o <OFDM core mask> -s <1..4> -c <core bitmap> -k CCK core mask -o OFDM core mask -s # of space-time-streams...
  • Page 104 www.zyxel.com For (NREV < 7), the NPHY buffer returned has the format: In 20MHz [(uint16)num_bytes, <I(core0), Q(core0), I(core1), Q(core1)>] In 40MHz [(uint16)num_bytes(core0), <I(core0), Q(core0)>, (uint16)num_bytes(core1), <I(core1), Q(core1)>] txfifo_sz set/get the txfifo size; usage: wlctl txfifo_sz <fifonum> <size_in_bytes> rate_histo Get rate hostrogram pkteng_start start packet engine tx usage: wlctl pkteng_start <xx:xx:xx:xx:xx:xx>...
  • Page 105 www.zyxel.com del -- Removes a pattern from the list clr -- Clear current list offset -- Starting offset for the pattern mask -- Mask to be used for pattern. Bit i of mask => byte i of the pattern value -- Value of the pattern wowl_wakeind usage: wowl_wakeind [clear] Shows last system wakeup event indications from PCI and D11 cores...
  • Page 106 www.zyxel.com obss_scan_params set/get Overlapping BSS scan parameters Usage: wlctl obss_scan a b c d e ...; where a-Passive Dwell, {5-1000TU}, default = 100 b-Active Dwell, {10-1000TU}, default = 20 c-Width Trigger Scan Interval, {10-900sec}, default = 300 d-Passive Total per Channel, {200-10000TU}, default = 200 e-Active Total per Channel, {20-1000TU}, default = 20 f-Channel Transition Delay Factor, {5-100}, default = 5 g-Activity Threshold, {0-100%}, default = 25...
  • Page 107 www.zyxel.com Usage: wlctl pkt_filter_clear_stats <id> pkt_filter_enable Enable/disable a packet filter. Usage: wlctl pkt_filter_enable <id> <0|1> pkt_filter_list List installed packet filters. Usage: wlctl pkt_filter_list [val] val: 0 (disabled filters) 1 (enabled filters) pkt_filter_mode Set packet filter match action. Usage: wlctl pkt_filter_mode <value> value: 1 - Forward packet on match, discard on non-match (default).
  • Page 108 www.zyxel.com get Receive MCS rateset for 11N device mimo_ss_stf get/set SS STF mode. Usage: wlctl mimo_ss_stf <value> <-b a | b> value: 0 - SISO; 1 - CDD -b(band): a - 5G; b - 2.4G assoclistinfo AP only: Get the list of yet another form of associated station info scblist AP only: Get STA list assertlog get external assert logs...
  • Page 109 www.zyxel.com led_blink_sync set/get led_blink_sync Usage: wlctl led_blink_sync [0-3] [0/1] cca_get_stats Usage: wlctl cca_stats [-c channel] [-s num seconds][-a] -c channel: Optional. specify channel. 0 = All channels. Default = current channel -s num_seconds: Optional. Default = 10, Max = 60 -i: list individual measurements in addition to the averages -curband: Only recommend channels on current band itfr_get_stats...
  • Page 110 www.zyxel.com chanim_acs_record get the auto channel scan record. Usage: wlctl acs_record dngl_wd Enable or disable dongle watchdog timer Usage: wlctl dngl_wd <on/off>(to turn on\off) <exptime in sec> set/get tsf register Usage: wlctl tsf [<high> <low>] tpc_mode Enable/disable AP TPC. Usage: wlctl tpc_mode <mode> 0 - disable, 1 - BSS power control, 2 - AP power control, 3 - Both (1) and (2) tpc_period Set AP TPC periodicity in secs.
  • Page 111 www.zyxel.com send bogus deauth Usage: wlctl mfp_dedauth mfp_assoc send assoc Usage: wlctl mfp_assoc mfp_auth send auth Usage: wlctl mfp_auth mfp_reassoc send reassoc Usage: wlctl mfp_reassoc monitor_lq Start/Stop monitoring link quality metrics - RSSI and SNR Usage: wlctl monitor_lq <0: turn off / 1: turn on monitor_lq_status Returns averaged link quality metrics - RSSI and SNR values scb_probe...

  • Page 112: Dhcpcondserv

    www.zyxel.com ratetbl_ppr Usage: For get: wlctl ratetbl_ppr For set: wlctl ratetbl_ppr <rate> <ppr> EXAMPLES None DHCPCONDSERV NAME dhcpcondserv –configure DHCP conditional serving pool SYNOPSIS Usage: dhcpcondserv add pool dhcpcondserv del pool <pool index>|all dhcpcondserv set pool <pool index> [--enable <1|0>] [--vendorclassidmode <0:Exact|1:Prefix|2:Suffix|3:Substring>] [--vendorclassid <id1,id2,...>] [--clientid <client-id type field1 field2,...>]...

  • Page 113: Igmpcmd

    www.zyxel.com 1. pool and option index will be updated if previous one deleted. 2. vendorclassid and sourceinterface can be multiple choices with comma separated. 3. clientid type has four type,llt,en,ll and other. llt has three fields -- Hardware type, Time and Link-layer address. en has two fields -- Enterprise number and Identifier.

  • Page 114: Lanhosts

    www.zyxel.com ° Setting the IGMP Query Interval > igmpcmd qi 10 LANHOSTS NAME lanhosts –Show hosts on LAN side. SYNOPSIS Usage: lanhosts show all lanhosts show brx lanhosts help DESCRIPTION This command can be used to find LAN side PC or NB or some work station and bridge interface. OPTIONS None EXAMPLES...

  • Page 115: Udpechod

    www.zyxel.com [--bandwidth <20MHZ|40MHZ>] wlan get chquality wlan show [<primary|secondary:1|secondary:2|secondary:3>] wlan --help <wep|psk|wpa|psk2|wpa2|psk-psk2|wpa-wpa2> DESCRIPTION This command can be used to get and setting wireless interface parameter then save to config. Allow a user to add/delete/show the LWAN interfaces and connection sevice for the xDSL router. WLAN is used to configure the wireless networking protocols for each LWAN interface.

  • Page 116: Xtm

    www.zyxel.com This command can be used to get and setting udpecho service.You can specify some “Port”,”IP Address”,”Interface”. OPTIONS None EXAMPLES ° Display the udpechod information > udpechod show ° Setting the udpechod connection destination > udpechod set sourceip 172.21.1.1 ° Setting the udpechod destination port >...
  • Page 117 www.zyxel.com <mpaal_priority> <mpaal_weight> [<tdte_index>]] [--add <port_mask.vpi.vci> aal0pkt|aal0cell [<tdte_index>]] [--add <port_mask.ptmpri_mask> <mpaal_priority> <mpaal_weight> [<tdte_index>]] [--delete <port_mask.vpi.vci>|<port_mask.ptmpri_mask>] [--addq <port_id.vpi.vci>|<port_id.ptmpri_id> <size> <priority> [wrr|wfq <weight>]] [--deleteq <port_id.vpi.vci>|<port_id.ptmpri_id> <qid>] [--state <port_mask.vpi.vci>|<port_mask.ptmpri_mask> enable|disable] [--show [<port_mask.vpi.vci>|<port_mask.ptmpri_mask>]] [--sendoam <port_id.vpi.vci> f5seg|f5end|f4seg|f4end] [--createnetdev <port_mask.vpi.vci>|<port_mask.ptmpri_mask> <netdevname>] [--deletenetdev <port_mask.vpi.vci>|<port_mask.ptmpri_mask>] port_mask: bit mask of one or more port ids port_id: 0x01 = PORT_PHY0_LATENCY0 0x02 = PORT_PHY0_LATENCY1...

  • Page 118: Tr69C

    www.zyxel.com TR69C NAME tr69c –this command is setting connection Request Port. SYNOPSIS Usage: tr69c ConnReqPort <Port> tr69c show DESCRIPTION Tr69c this command is setting connection Request Port by CPE CLI mode.The tr69 protocol is a DSL Forum (which was later renamed as Broadband Forum) technical specification entitled CPE WAN Management Protocol (CWMP).

  • Page 119: Radvdconf

    <Brick|Original|Brick_ODM> DESCRIPTION User can be change the Web gui style by this command. But in VMG1312 the Web gui style are fixed Brick Style. OPTIONS None EXAMPLES None RADVDCONF NAME radvdconf – this command is to configure the radvd DNSSL feature.

  • Page 120: Vcautohunt

    www.zyxel.com VCAUTOHUNT NAME vcautohunt – this command is to configure the vcautohunt feature. SYNOPSIS Usage: vcAutoHunt help vcAutoHunt show vcAutoHunt send vcAutoHunt save service(hex) : bit0: PPPoE/VC (1),bit1:PPPoE/LLC (2) ,bit2:PPPoA/VC (4), bit3: PPPoA/LLC (8), bit4:Enet/VC (10), bit5 :Enet/LLC (20) vcAutoHunt add <PvcId 0~1>...

  • Page 121: Sys

    www.zyxel.com EXAMPLES ° Display the vcAutoHunt information > vcAutoHunt show TR064 NAME tr064 –this command is setting tr064 enable or disable behavior. SYNOPSIS Usage: tr064 config [--auth <enable|disable>] tr064 show DESCRIPTION tr064 this command is setting enable or disable behavior by CPE CLI mode.The tr064 protocol is a working text will specify the method for configuring DSL CPE through software on PCs inside the LAN.
  • Page 122 This option will show the CPE firmware information. Example as below: > sys atsh Version : V1.00(AABQ.0)20121017 Bootbase Version : V1.57 | 12/21/2012 19:52:59 Vendor Name : ZyXEL Communications Corp. Product Model : DSL-401HNU-B1Bv2 Serial Number : S120Y48000039 First MAC Address : FCF52836B30B Last MAC Address...
  • Page 123 www.zyxel.com Serial Number: S120Y48000039 ledctl This option will be control the CPE LED on|off. Example as below: > sys ledctl WLAN 0 Wireless LED OFF This option will be control CPE Button status as “Reset Button Status”,” WL Button Status”,” WL EN Button Status”.
  • Page 124 www.zyxel.com Example as below: > sys usbtest S USB Test Start At Port 1 and Port 2 atmt This option will be setting the CPE reduce bootup time But haven't CSM system in CPE. EXAMPLES None ZyXEL Confidential...

Table of Contents