Zyxel NXC2500, NXC5500 CLI Reference Guide
Default Login Details
CLI Reference Guide
NXC Series
Wireless LAN Controller
IP Address https://192.168.1.1
User Name admin
Password 1234
Version 6.00 Edition 1, 1/2020
Copyright © 2019 Zyxel Communications Corporation
IMPORTANT!
READ CAREFULLY BEFORE USE.
KEEP THIS GUIDE FOR FUTURE REFERENCE.
This is a Reference Guide for a series of products intended for people who want to configure the NXC
via Command Line Interface (CLI).
Note: Some commands or command options in this guide may not be available in your
product. See your product's User’s Guide for a list of supported features. Every effort has
been made to ensure that the information in this guide is accurate.
Note: The version number on the cover page refers to the latest firmware version supported
by the NXC. This guide applies to versions 4.20, 4.21, 4.22, 4.30, 5.00, 5.10, 5.20, 5.30, 5.40,
and 6.00 at the time of writing.
How To Use This Guide
1 Read Chapter 1 on page 14 for how to access and use the CLI (Command Line Interface).
2 Read Chapter 2 on page 28 to learn about the CLI user and privilege modes.
Do not use commands not documented in this guide.
Related Documentation
•Quick Start Guide
The Quick Start Guide shows how to connect the NXC and access the Web Configurator.
• User’s Guide
The User’s Guide explains how to use the Web Configurator to configure the NXC.
Note: It is recommended you use the Web Configurator to configure the NXC.
Icons Used in Figures
Figures in this guide may use the following generic icons. The NXC icon is not an exact representation of
your device.
NXC Router Switch Internet
Server Desktop Laptop AP
Contents Overview
Contents Overview
Command Line Interface ................................ ....... ....... ....... ....... ....... ....... ....... ....... .............. .............. 14
User and Privilege Modes .................................................................................................................... 28
Object Reference ................................................................................................................................ 31
Status ......................................................................... ............................................................................. 33
Registration ...................................................................... .......................................... ............................ 37
Interfaces ................................................................................ ............................................................... 43
Route ................................................................................ ...................................................................... 62
AP Management .................................................................................................................................. 69
AP Group ............................................................................................................................................... 80
Wireless LAN Profiles .............................................................................................................................. 87
Rogue AP ............................................................................................................................................. 108
Bluetooth ............................................................................................................................................. 112
Wireless Frame Capture ..................................................................................................................... 115
Dynamic Channel Selection ............................................................................................................. 117
Auto-Healing ....................................................................................................................................... 118
Dynamic Guest ................................................................................................................................... 120
LEDs ...................................................................................................................................................... 123
Zones ......................................................................... ........................................................................... 125
ALG ................................................................................... ....... ....... ....... ....... ....... ................................. 127
Captive Portal ..................................................................................................................................... 130
RTLS ................................................................................... .................................................................... 141
Firewall ................................................................................................................................................. 142
User/Group ...................................................................... .................................................................... 149
Addresses ............................................................................................................................................ 157
Services ................................................................................... ............................................................. 161
Schedules ............................................................................................................................................ 164
AAA Server .......................................................................................................................................... 166
Authentication Objects ..................................................................................................................... 172
Authentication Server ........................................................................................................................ 175
Certificates .......................................................................................................................................... 177
DHCPv6 Objects ................................................................................................................................. 181
System ................................................................ .................................................................................. 183
System Remote Management .......................................................................................................... 190
Logs ...................................................................................................................................................... 200
Reports and Reboot ........................................................................................................................... 207
Session Timeout ................................................................................................................................... 213
File Manager ........................................................................................................................... ............ 214
Diagnostics .......................................................................................................................................... 232
Packet Flow Explore ........................................................................................................................... 237
NXC CLI Reference Guide
3
Contents Overview
Maintenance Tools .. ....... ....... ....... ....... ....... ...... ....... ....... ....... .............. ....... ....... ....... ....... ................... 239
Watchdog Timer ................................................................................................................................. 248
Managed AP Commands ................................................................................................................. 252
List of Commands ............................................................................................................................... 257
NXC CLI Reference Guide
4
Table of Contents
Table of Contents
Contents Overview..............................................................................................................................3
Table of Contents.................................................................................................................................5
Chapter 1
Command Line Interface..................................................................................................................14
1.1 Overview ......................................................................................................................................... 14
1.1.1 The Configuration File ........................................................................................................... 14
1.2 Accessing the CLI ........................................................................................................................... 14
1.2.1 Console Port .......................................................................................................................... 15
1.2.2 Web Configurator Console .................................................................................................. 15
1.2.3 Telnet ...................................................................................................................................... 18
1.2.4 SSH (Secure SHell) .................................................................................................................. 19
1.3 How to Find Commands in this Guide .........................................................................................19
1.4 How Commands Are Explained ................................................................................................... 20
1.4.1 Background Information ...................................................................................................... 20
1.4.2 Command Input Values ....................................................................................................... 20
1.4.3 Command Summary ............................................................................................................ 20
1.4.4 Command Examples ............................................................................................................ 20
1.4.5 Command Syntax ................ ................................................................................................. 20
1.4.6 Changing the Password ....................................................................................................... 21
1.5 CLI Modes ........................................................................................................................................ 21
1.6 Shortcuts and Help ......................................................................................................................... 22
1.6.1 List of Available Commands ................................................................................................ 22
1.6.2 List of Sub-commands or Required User Input ................................................................... 22
1.6.3 Entering Partial Commands ................................................................................................. 23
1.6.4 Entering a ? in a Command ................................................................................................23
1.6.5 Command History ................................................................................................................. 23
1.6.6 Navigation ............................................................................................................................. 23
1.6.7 Erase Current Command ..................................................................................................... 23
1.6.8 The no Commands ............................................................................................................... 23
1.7 Input Values .................................................................................................................................... 24
1.8 Saving Configuration Changes .................................................................................................... 27
1.9 Logging Out .................................................................................................................................... 27
Chapter 2
User and Privilege Modes .................................................................................................................28
2.1 User And Privilege Modes .............................................................................................................. 28
2.1.1 Debug Commands ............................................................................................................... 29
NXC CLI Reference Guide
5
Table of Contents
Chapter 3
Object Reference ................................ ... ............................................ .... .... ... ....................................31
3.1 Object Reference Commands ..................................................................................................... 31
3.1.1 Object Reference Command Example ............................................................................. 32
Chapter 4
Status...................................................................................................................................................33
4.1 Status Show Commands ................................................................................................................ 33
Chapter 5
Registration.........................................................................................................................................37
5.1 myZyxel.com overview .................................................................................................................. 37
5.1.1 Subscription Services Available on the NXC ...................................................................... 37
5.2 Registration Commands ................................................................................................................ 37
5.2.1 Command Examples ............................................................................................................ 38
5.3 Country Code ................................................................................................................................. 39
Chapter 6
Interfaces............................................................................................................................................43
6.1 Interface Overview ........................................................................................................................ 43
6.1.1 Types of Interfaces ................................................................................................................ 43
6.2 Interface General Commands Summary .................................................................................... 44
6.2.1 Basic Interface Properties and IP Address Commands .................................................... 44
6.2.2 DHCP Setting Commands ....................................................................................................47
6.2.3 Connectivity Check (Ping-check) Commands ................................................................. 52
6.3 Ethernet Interface Specific Commands ...................................................................................... 53
6.3.1 MAC Address Setting Commands ...................................................................................... 53
6.4 Port Commands .............................................................................................................................. 54
6.5 Port Role Commands ..................................................................................................................... 55
6.5.1 Port Role Examples ................................................. ....... ....... ....... ....... ....... ....... ....... .............. 55
6.6 USB Storage Specific Commands ................................................ ............................ ..................... 55
6.6.1 USB Storage General Commands Example ....................................................................... 57
6.7 VLAN Interface Specific Commands ...........................................................................................57
6.7.1 VLAN Interface Examples ..................................................................................................... 59
6.8 LAG Commands ..................... ........................................................................................................ 59
6.8.1 LAG Interface Command Example .................................................................................... 61
Chapter 7
Route...................................................................................................................................................62
7.1 Policy Route .................................................................................................................................... 62
7.2 Policy Route Commands ............................................................................................................... 62
7.2.1 Assured Forwarding (AF) PHB for DiffServ ........................................................................... 65
7.2.2 Policy Route Command Example ....................................................................................... 65
NXC CLI Reference Guide
6
Table of Contents
7.3 IP Static Route .... ............................................................................................................................. 66
7.4 Static Route Commands ............................................................................................................... 67
7.4.1 Static Route Commands Example ...................................................................................... 67
7.5 Learned Routing Information Commands .................................................................................. 68
7.5.1 show ip route Command Example ..................................................................................... 68
Chapter 8
AP Management................................................................................................................................69
8.1 AP Management Overview .......................................................................................................... 69
8.2 AP Management Commands ...................................................................................................... 70
8.2.1 AP Management Commands Example ............................................................................. 75
Chapter 9
AP Group ............................................................................................................................................80
9.1 Wireless Load Balancing Overview .............................................................................................. 80
9.2 AP Group Commands ................................................................................................................... 80
9.2.1 AP Group Examples .............................................................................................................. 85
Chapter 10
Wireless LAN Profiles ..........................................................................................................................87
10.1 Wireless LAN Profiles Overview .................................................................................................... 87
10.2 AP Radio & Monitor Profile Commands ..................................................................................... 87
10.2.1 AP Radio & Monitor Profile Commands Example ........................................................... 94
10.3 SSID Profile Commands ................................................................................................................ 95
10.3.1 SSID Profile Example ............................................................................................................ 99
10.4 Security Profile Commands ......................................................................................................... 99
10.4.1 Security Profile Example ................................................................................................... 103
10.5 MAC Filter Profile Commands ................................................................................................... 104
10.5.1 MAC Filter Profile Example ............................................................................................... 104
10.6 Layer-2 Isolation Profile Commands ......................................................................................... 105
10.6.1 Layer-2 Isolation Profile Example ..................................................................................... 106
10.7 ZyMesh Profile Commands ........................................................................................................ 106
Chapter 11
Rogue AP..........................................................................................................................................108
11.1 Rogue AP Detection Overview ................................................................................................. 108
11.2 Rogue AP Detection Commands ............................................................................................. 108
11.2.1 Rogue AP Detection Examples ....................................................................................... 109
11.3 Rogue AP Containment Overview ........................................................................................... 110
11.4 Rogue AP Containment Commands ....................................................................................... 111
11.4.1 Rogue AP Containment Example ................................................................................... 111
Chapter 12
Bluetooth...........................................................................................................................................112
NXC CLI Reference Guide
7
Table of Contents
12.1 Bluetooth Overview .................................................................................................................... 112
12.2 Bluetooth Commands ................................................................................................................ 113
12.3 Bluetooth Commands Example ................................................................................................114
Chapter 13
Wireless Frame Capture..................................................................................................................115
13.1 Wireless Frame Capture Overview ...........................................................................................115
13.2 Wireless Frame Capture Commands ....................................................................................... 115
13.2.1 Wireless Frame Capture Examples .................................................................................. 116
Chapter 14
Dynamic Channel Selection...........................................................................................................117
14.1 DCS Overview ............................................................................................................................. 117
14.2 DCS Commands ......................................................................................................................... 117
Chapter 15
Auto-Healing....................................................................................................................................118
15.1 Auto-Healing Overview ............................................................................................................. 118
15.2 Auto-Healing Commands ......................................................................................................... 118
15.2.1 Auto-Healing Examples .................................................................................................... 119
Chapter 16
Dynamic Guest ................................................................................................................................120
16.1 Dynamic Guest Overview ......................................................................................................... 120
16.2 Dynamic Guest Commands ..................................................................................................... 120
16.2.1 Dynamic Guest Examples ................................................................................................ 122
Chapter 17
LEDs ...................................................................................................................................................123
17.1 LED Suppression Mode ............................................................................................................... 123
17.2 LED Suppression Commands ..................................................................................................... 123
17.2.1 LED Suppression Commands Example ........................................................................... 123
17.3 LED Locator ................................................................................................................................. 124
17.4 LED Locator Commands ............................................................................................................ 124
17.4.1 LED Locator Commands Example .................................................................................. 124
Chapter 18
Zones.................................................................................................................................................125
18.1 Zones Overview .......................................................................................................................... 125
18.2 Zone Commands Summary ...................................................................................................... 126
18.2.1 Zone Command Examples .................................................................................. ............ 126
Chapter 19
ALG....................................................................................................................................................127
NXC CLI Reference Guide
8
Table of Contents
19.1 ALG Introduction ........................................................................................................................ 127
19.2 ALG Commands ......................................................................................................................... 128
19.3 ALG Commands Example ......................................................................................................... 129
Chapter 20
Captive Portal...................................................................................................................................130
20.1 Captive Portal Overview ........................................................................................................... 130
20.1.1 Web Authentication Policy Commands ........................................................................ 130
20.1.2 Customizing the WWW Login Page ................................................................................ 137
Chapter 21
RTLS....................................................................................................................................................141
21.1 RTLS Introduction ......................................................................................................................... 141
21.2 RTLS Commands ......................................................................................................................... 141
Chapter 22
Firewall..............................................................................................................................................142
22.1 Firewall Overview ........................................................................................................................ 142
22.2 Firewall Commands .................................................................................................................... 143
22.2.1 Firewall Sub-Commands .................................................................................................. 144
22.2.2 Firewall Command Examples .......................................................................................... 145
22.3 Session Limit Commands ........................................................................................................... 147
Chapter 23
User/Group.......................................................................................................................................149
23.1 User Account Overview ............................................................................................................. 149
23.1.1 User Types ........................................................................................................................... 149
23.2 User/Group Commands Summary ........................................................................................... 150
23.2.1 User Commands ................................................................................................................ 150
23.2.2 User Group Commands ................................................................................................... 151
23.2.3 User Setting Commands ...................................................................................................151
23.2.4 MAC Auth Commands ..................................................................................................... 153
23.2.5 Additional User Commands ............................................................................................. 154
Chapter 24
Addresses.........................................................................................................................................157
24.1 Address Overview ....................................................................................................................... 157
24.2 Address Commands Summary ................................................................................................. 157
24.2.1 Address Object Commands ............................................................................................ 158
24.2.2 Address Group Commands ............................................................................................. 159
Chapter 25
Services.............................................................................................................................................161
NXC CLI Reference Guide
9
Table of Contents
25.1 Services Overview ...................................................................................................................... 161
25.2 Services Commands Summary .................................................................................................161
25.2.1 Service Object Commands ............................................................................................. 161
25.2.2 Service Group Commands .............................................................................................. 162
Chapter 26
Schedules.........................................................................................................................................164
26.1 Schedule Overview .................................................................................................................... 164
26.2 Schedule Commands Summary ............................................................................................... 164
26.2.1 Schedule Command Examples ...................................................................................... 165
Chapter 27
AAA Server .................... ............................................. ... .... ............................................ ...................166
27.1 AAA Server Overview ................................................................................................................. 166
27.2 Authentication Server Command Summary ........................................................................... 166
27.2.1 aaa group server ad Commands ................................................................................... 167
27.2.2 aaa group server ldap Commands ................................................................................ 168
27.2.3 aaa group server radius Commands ............................................................................. 169
27.2.4 aaa group server Command Example .......................................................................... 171
Chapter 28
Authentication Objects...................................................................................................................172
28.1 Authentication Objects Overview ............................................................................................ 172
28.2 aaa authentication Commands .............................................................................................. 172
28.2.1 aaa authentication Command Example ...................................................................... 173
28.3 test aaa Command ................................................................................................................... 174
28.3.1 Test a User Account Command Example ...................................................................... 174
Chapter 29
Authentication Server......................................................................................................................175
29.1 Authentication Server Overview ............................................................................................... 175
29.2 Authentication Server Commands ...................................................................................... ..... 175
29.2.1 Authentication Server Command Examples ................................................................. 176
Chapter 30
Certificates .......................................................................................................................................177
30.1 Certificates Overview ................................................................................................................ 177
30.2 Certificate Commands .............................................................................................................. 177
30.3 Certificates Commands Input Values ...................................................................................... 177
30.4 Certificates Commands Summary ........................................................................................... 178
30.5 Certificates Commands Examples ........................................................................................... 180
Chapter 31
DHCPv6 Objects...............................................................................................................................181
NXC CLI Reference Guide
10
Table of Contents
31.1 DHCPv6 Object Commands Summary .................................................................................... 181
31.1.1 DHCPv6 Object Commands ........................................................................................... 181
31.1.2 DHCPv6 Object Command Examples ........................................................................... 182
Chapter 32
System...............................................................................................................................................183
32.1 System Overview ........................................................................................................................ 183
32.2 Customizing the WWW Login Page .......................................................................................... 183
32.3 Host Name Commands ............................................................................................................. 186
32.4 Time and Date ........................................................................................................................... 186
32.4.1 Date/Time Commands ..................................................................................................... 186
32.5 Console Port Speed .................................................................................................................. 187
32.6 DNS Overview ............................................................................................................................ 187
32.6.1 DNS Commands ................................................................................................................ 188
32.6.2 DNS Command Example ................................................................................................. 189
32.7 Language Commands .............................................................................................................. 189
Chapter 33
System Remote Management........................................................................................................190
33.1 Remote Management Overview ............................................................................................. 190
33.1.1 Remote Management Limitations .................................................................................. 190
33.1.2 System Timeout .................................................................................................................. 190
33.2 Common System Command Input Values ............................................................................. 191
33.3 HTTP/HTTPS Commands .............................................................................................................. 191
33.3.1 HTTP/HTTPS Command Examples .................................................................................... 192
33.4 SSH ................................................................................................................................................ 193
33.4.1 SSH Implementation on the NXC .................................................................................... 193
33.4.2 Requirements for Using SSH ..............................................................................................193
33.4.3 SSH Commands ...................................... ........................................................................... 193
33.4.4 SSH Command Examples ................................................................................................. 194
33.5 Telnet ........................................................................................................................................... 194
33.6 Telnet Commands ...................................................................................................................... 195
33.6.1 Telnet Commands Examples ........................................................................................... 195
33.7 Configuring FTP .......................................................................................................................... 196
33.7.1 FTP Commands ................................................................................................................. 196
33.7.2 FTP Commands Examples ................................................................................................ 196
33.8 SNMP ........................................................................................................................................... 197
33.8.1 Supported MIBs ................................................................................................................. 197
33.8.2 SNMP Traps ......................................................................................................................... 197
33.8.3 SNMP Commands ............................................................................................................. 198
33.8.4 SNMP Commands Examples ............................................................................................ 199
Chapter 34
Logs...................................................................................................................................................200
NXC CLI Reference Guide
11
Table of Contents
34.1 Log Commands Summary ......................................................................................................... 200
34.1.1 Log Entries Commands ....................................................................................................201
34.1.2 System Log Commands ................................................................................................... 201
34.1.3 Debug Log Commands ................................................................................................... 202
34.1.4 Remote Syslog Server Log Commands .......................................................................... 203
34.1.5 E-mail Profile Log Commands ......................................................................................... 203
34.1.6 Console Port Log Commands ......................................................................................... 205
34.1.7 Access Point Logging Commands ................................................................................. 205
Chapter 35
Reports and Reboot........................................... .... .... ... ............................................. ... .... ...............207
35.1 Report Commands Summary ...................................................................................................207
35.1.1 Report Commands ........................................................................................................... 207
35.1.2 Report Command Examples ........................................................................................... 208
35.1.3 Session Commands ........................................................................................................... 208
35.2 Email Daily Report Commands ................................................................................................. 209
35.2.1 Email Daily Report Example ............................................................................................. 211
35.3 Reboot ......................................................................................................................................... 212
Chapter 36
Session Timeout.......... ............................................ .... ... .... .... ...........................................................213
Chapter 37
File Manager ....................................................................................................................................214
37.1 File Directories ............................................................................................................................. 214
37.2 Configuration Files and Shell Scripts Overview ...................................................................... 214
37.2.1 Comments in Configuration Files or Shell Scripts ........................................................... 215
37.2.2 Errors in Configuration Files or Shell Scripts ..................................................................... 216
37.2.3 NXC Configuration File Details ......................................................................................... 216
37.2.4 Configuration File Flow at Restart ................................................................................... 217
37.3 File Manager Commands Input Values ................................................................................... 217
37.4 File Manager Commands Summary ........................................................................................ 218
37.5 File Manager Command Example ........................................................................................... 219
37.6 FTP File Transfer ............................................................................................................................ 219
37.6.1 Command Line FTP File Upload ....................................................................................... 219
37.6.2 Command Line FTP Configuration File Upload Example ............................................. 220
37.6.3 Command Line FTP File Download ................................................................................. 220
37.6.4 Command Line FTP Configuration File Download Example ........................................ 220
37.7 Firmware Update Scheduling Commands .............................................................................. 221
37.8 NXC File Usage at Startup ......................................................................................................... 221
37.9 Notification of a Damaged Recovery Image or Firmware ................................ ................... 222
37.10 Restoring the Recovery Image (NXC5200 Only) ................................................................... 223
37.11 Restoring the Firmware ............................................................................................................ 225
37.12 Restoring the Default System Database ................................................................................ 227
NXC CLI Reference Guide
12
Table of Contents
37.12.1 Using the atkz -u Debug Command (NXC5200 Only) ................................................ 229
Chapter 38
Diagnostics.......................................................................................................................................232
38.1 Diagnostics .................................................................................................................................. 232
38.2 Diagnosis Commands ................................................................................................................ 232
38.3 Diagnosis Commands Example ................................................................................................233
Chapter 39
Packet Flow Explore ........................................................................................................................237
39.1 Packet Flow Explore ................................................................................................................... 237
39.2 Packet Flow Explore Commands ..............................................................................................237
39.3 Packet Flow Explore Commands Example ........................................................... ....... ....... ..... 238
Chapter 40
Maintenance Tools ...................... .... ............................................ .... ... .... .... .....................................239
40.1 Maintenance Tools Commands ............................................................................................... 239
40.1.1 Command Examples ........................................................................................................243
Chapter 41
Watchdog Timer............................... .... ... ............................................ .... .... .....................................248
41.1 Hardware Watchdog Timer ........................................................ ....... ....... ....... ....... ....... ............ 248
41.2 Software Watchdog Timer ........................................................................ ....... ....... ....... ............ 248
41.3 Application Watchdog .............................................................................................................. 249
41.3.1 Application Watchdog Commands Example ............................................................... 250
Chapter 42
Managed AP Commands...............................................................................................................252
42.1 Managed Series AP Commands Overview ................................................................. ............ 252
42.2 Accessing the AP CLI ................................................................................................................. 252
42.3 CAPWAP Client Commands ..................................................................................................... 252
42.3.1 CAPWAP Client Commands Example ............................................................................ 253
42.4 DNS Server Commands .............................................................................................................. 255
42.4.1 DNS Server Commands Example .................................................................................... 255
42.4.2 DNS Server Commands and DHCP ..................................................................... ............ 255
List of Commands ............................................................................................................................257
NXC CLI Reference Guide
13
Command Line Interface
This chapter describes how to access and use the CLI (Command Line Interface).
1.1 Overview
If you have problems with your NXC, customer support may request that you issue some of these
commands to assist them in troubleshooting.
Use of undocumented commands or misconfiguration can damage the
NXC and possibly render it unusable.
1.1.1 The Configuration File
CHAPTER 1
When you configure the NXC using either the CLI (Command Line Interface) or the web configurator,
the settings are saved as a series of commands in a configuration file on the NXC. You can store more
than one configuration file on the NXC. However, only one configuration file is used at a time.
You can perform the following with a configuration file:
• Back up NXC configuration once the NXC is set up to work in your network.
• Restore NXC configuration.
• Save and edit a configuration file and upload it to multiple NXCs in your network to have the same
settings.
Note: You may also edit a configuration file using a text editor.
1.2 Accessing the CLI
You can access the CLI using a terminal emulation program on a computer connected to the console
port, from the web configurator or access the NXC using Telnet or SSH (Secure SHell).
Note: The NXC might force you to log out of your session if reauthentication time, lease time,
or idle timeout is reached. See Chapter 23 on page 149 for more information about
these settings.
NXC CLI Reference Guide
14
1.2.1 Console Port
The default settings for the console port are as follows.
Table 1 Managing the NXC: Console Port
SETTING VALUE
Speed 115200 bps
Data Bits 8
Parity None
Stop Bit 1
Flow Control Off
When you turn on your NXC, it performs several internal tests as well as line initialization. You can view
the initialization information using the console port.
• Garbled text displays if your terminal emulation program’s speed is set lower than the NXC’s.
• No text displays if the speed is set higher than the NXC’s.
• If changing your terminal emulation program’s speed does not get anything to display, restart the
NXC.
• If restarting the NXC does not get anything to display, contact your local customer support.
Figure 1 Console Port Power-on Display
Flash: 8 MiB
Chapter 1 Command Line Interface
BootModule Version: V0.9.1 | 2012-12-28 13:01:22
DRAM: Size = 1024 Mbytes
DRAM POST: Testing: 262144K
After the initialization, the login screen displays.
Figure 2 Login Screen
Welcome to NXC
Username:
Enter the user name and password at the prompts.
Note: The default login username is admin and password is 1234. The username and password
are case-sensitive.
1.2.2 Web Configurator Console
The Console allows you to use CLI commands from directly within the Web Configurator rather than
having to use a separate terminal program. In addition to logging in directly to the NXC’s CLI, you can
also log into other devices on the network through this Console. It uses SSH to establish a connection.
NXC CLI Reference Guide
15
Chapter 1 Command Line Interface
Note: To view the functions in the Web Configurator user interface that correspond directly to
specific NXC CLI commands, use the CLI Messages window (described in the User’s
Guide) in tandem with this one.
Figure 3 Console
The following table describes the elements in this screen.
Table 2 Console
LABEL DESCRIPTION
Command Line
Enter commands for the device that you are currently logged into here. If you are logged into
the NXC, see the CLI Reference Guide for details on using the command line to configure it.
Device IP Address
This is the IP address of the device that you are currently logged into.
Logged-In User
This displays the username of the account currently logged into the NXC through the Console
Window.
You can log into the Web Configurator with a different account than used to log into the NXC
through the Console.
NXC CLI Reference Guide
16
Chapter 1 Command Line Interface
Table 2 Console (continued)
LABEL DESCRIPTION
Connection
Status
This displays the connection status of the account currently logged in.
If you are logged in and connected, then this displays ‘Connected’.
If you lose the connection, get disconnected, or logout, then this displays ‘Not Connected’.
Tx/RX Activity
Monitor
This displays the current upload / download activity. The faster and more frequently an LED
flashes, the faster the data connection.
Before you use the Console, ensure that:
• Your web browser of choice allows pop-up windows from the IP address assigned to your NXC.
• Your web browser allows Java programs.
• You are using the latest version of the Java program (http://www.java.com).
To login in through the Console:
1 Click the Console button on the Web Configurator title bar.
2 Enter the IP address of the NXC and click OK.
NXC CLI Reference Guide
17
Chapter 1 Command Line Interface
3 Next, enter the user name of the account being used to log into your target device and then click OK.
4 You may be prompted to authenticate your account password, depending on the type of device that
you are logging into. Enter the password and click OK.
5 If your login is successful, the command line appears and the status bar at the bottom of the Console
updates to reflect your connection state.
1.2.3 Telnet
Use the following steps to Telnet into your NXC.
NXC CLI Reference Guide
18
Chapter 1 Command Line Interface
1 If your computer is connected to the NXC over the Internet, skip to the next step. Make sure your
computer IP address and the NXC IP address are on the same subnet.
2 In Windows, click Start (usually in the bottom left corner) and Run. Then type
address. For example, enter
3 Click OK. A login screen displays. Enter the user name and password at the prompts.
Note: The default login username is admin and password is 1234. The username and password
are case-sensitive.
1.2.4 SSH (Secure SHell)
You can use an SSH client program to access the CLI. The following figure shows an example using a
text-based SSH client program. Refer to the documentation that comes with your SSH program for
information on using it.
Note: The default login username is admin and password is 1234. The username and password
are case-sensitive.
Figure 4 SSH Login Example
C:\>ssh2 admin@192.168.1.1
Host key not found from database.
Key fingerprint:
xolor-takel-fipef-zevit-visom-gydog-vetan-bisol-lysob-cuvun-muxex
You can get a public key's fingerprint by running
% ssh-keygen -F publickey.pub
on the keyfile.
Are you sure you want to continue connecting (yes/no)? yes
telnet and the NXC’s IP
telnet 192.168.1.1 (the default management IP address).
Host key saved to C:/Documents and Settings/user/Application Data/SSH/
hostkeys/
ey_22_192.168.1.1.pub
host key for 192.168.1.1, accepted by user Tue Aug 09 2005 07:38:28
admin's password:
Authentication successful.
1.3 How to Find Commands in this Guide
You can simply look for the feature chapter to find commands. In addition, you can use the List of
Commands at the end of the guide. This section lists the commands in alphabetical order that they
appear in this guide.
If you are looking at the CLI Reference Guide electronically, you might have additional options (for
example, bookmarks or Find...) as well.
NXC CLI Reference Guide
19
Chapter 1 Command Line Interface
1.4 How Commands Are Explained
Each chapter explains the commands for one keyword. The chapters are divided into the following
sections.
1.4.1 Background Information
Note: See the User’s Guide for background information about most features.
This section provides background information about features that you cannot configure in the web
configurator. In addition, this section identifies related commands in other chapters.
1.4.2 Command Input Values
This section lists common input values for the commands for the feature in one or more tables
1.4.3 Command Summary
This section lists the commands for the feature in one or more tables.
1.4.4 Command Examples
This section contains any examples for the commands in this feature.
1.4.5 Command Syntax
The following conventions are used in this guide.
• A command or keyword in courier new must be entered literally as shown. Do not abbreviate.
• Values that you need to provide are in italics.
• Required fields that have multiple choices are enclosed in curly brackets
• A range of numbers is enclosed in angle brackets <>.
• Optional fields are enclosed in square brackets
• The
| symbol means OR.
For example, look at the following command to create a TCP/UDP service object.
service-object object-name {tcp | udp} {eq <1..65535> | range <1..65535> <1..65535>}
1 Enter service-object exactly as it appears.
2 Enter the name of the object where you see object-name.
{}.
[].
3 Enter
4 Finally, do one of the following.
tcp or udp, depending on the service object you want to create.
•Enter eq exactly as it appears, followed by a number between 1 and 65535.
NXC CLI Reference Guide
20
Chapter 1 Command Line Interface
•Enter range exactly as it appears, followed by two numbers between 1 and 65535.
1.4.6 Changing the Password
It is highly recommended that you change the password for accessing the NXC. See Section 23.2 on
page 150 for the appropriate commands.
1.5 CLI Modes
You run CLI commands in one of several modes.
Table 3 CLI Modes
USER PRIVILEGE CONFIGURATION SUB-COMMAND
What Guest users
can do
What User users
can do
What Limited-
Admin users can
do
What Admin users
can do
How you enter it Log in to the NXC Type enable in User
What the prompt
looks like
How you exit it Type exit Type disable Type exit Type exit
Unable to access Unable to access Unable to access Unable to access
• Look at (but not
run) available
commands
•Look at system
information (like
Status screen)
•Run basic
diagnostics
•Look at system
information (like
Status screen)
•Run basic
diagnostics
Router> Router# Router(config)#
Unable to access Unable to access Unable to access
• Look at system
information (like
Status screen)
• Run basic
diagnostics
• Look at system
information (like
Status screen)
• Run basic
diagnostics
mode
Unable to access Unable to access
• Configure simple
features (such as
an address
object)
• Create or remove
complex parts
(such as an
interface)
Type configure
terminal in User or
Privilege mode
• Configure
complex parts
(such as an
interface) in the
NXC
Type the command
used to create the
specific part in
Configuration mode
(varies by part)
Router(zone)#
Router(configif-ge)#
...
See Chapter 23 on page 149 for more information about the user types. User users can only log in, look
at (but not run) the available commands in User mode, and log out. Limited-Admin users can look at
the configuration in the web configurator and CLI, and they can run basic diagnostics in the CLI. Admin
users can configure the NXC in the web configurator or CLI.
At the time of writing, there is not much difference between User and Privilege mode for admin users.
This is reserved for future use.
NXC CLI Reference Guide
21
Chapter 1 Command Line Interface
1.6 Shortcuts and Help
1.6.1 List of Available Commands
A list of valid commands can be found by typing ? or [TAB] at the command prompt. To view a list of
available commands within a command group, enter <command> ? or <command> [TAB].
Figure 5 Help: Available Commands Example 1
Router> ?
<cr>
apply
atse
clear
configure
------------------[Snip]-------------------shutdown
telnet
test
traceroute
write
Router>
Figure 6 Help: Available Command Example 2
Router> show ?
<wlan ap interface>
aaa
access-page
account
ad-server
address-object
------------------[Snip]-------------------wlan
workspace
zone
Router> show
1.6.2 List of Sub-commands or Required User Input
To view detailed help information for a command, enter <command> <sub command> ?.
Figure 7 Help: Sub-command Information Example
Router(config)# ip telnet server ?
;
<cr>
port
rule
|
Router(config)# ip telnet server
NXC CLI Reference Guide
22
Chapter 1 Command Line Interface
Figure 8 Help: Required User Input Example
Router(config)# ip telnet server port ?
<1..65535>
Router(config)# ip telnet server port
1.6.3 Entering Partial Commands
The CLI does not accept partial or incomplete commands. You may enter a unique part of a command
and press
[TAB] to have the NXC automatically display the full command.
For example, if you enter
displays.
If you enter a partial command that is not unique and press
that start with the partial command.
Figure 9 Non-Unique Partial Command Example
Router# c [TAB]
clear configure copy
Router# co [TAB]
configure copy
config and press [TAB] , the full command of configure automatically
1.6.4 Entering a ? in a Command
Typing a ? (question mark) usually displays help information. However, some commands allow you to
input a ?, for example as part of a string. Press [CTRL+V] on your keyboard to enter a ? without the NXC
treating it as a help query.
1.6.5 Command History
The NXC keeps a list of commands you have entered for the current CLI session. You can use any
commands in the history again by pressing the up () or down () arrow key to scroll through the
previously used commands and press
[TAB], the NXC displays a list of commands
[ENTER].
1.6.6 Navigation
Press [CTRL]+A to move the cursor to the beginning of the line. Press [CTRL]+E to move the cursor to the
end of the line.
1.6.7 Erase Current Command
Press [CTRL]+U to erase whatever you have currently typed at the prompt (before pressing [ENTER]).
1.6.8 The no Commands
When entering the no commands described in this document, you may not need to type the whole
command. For example, with the “[no] mss <536..1452>” command, you use “mss 536” to specify
the MSS value. But to disable the MSS setting, you only need to type “no mss” instead of “no mss 536”.
NXC CLI Reference Guide
23
1.7 Input Values
You can use the ? or [TAB] to get more information about the next input value that is required for a
command. In some cases, the next input value is a string whose length and allowable characters may
not be displayed in the screen. For example, in the following example, the next input value is a string
called
<description>.
Router# configure terminal
Router(config)# interface ge1
Router(config-if-ge)# description
<description>
Chapter 1 Command Line Interface
The following table provides more information about input values like
Table 4 Input-Value Formats for Strings in CLI Commands
TAG # VALUES LEGAL VALUES
* 1*
all -- ALL
authentication key 32-40
16-20
Used in MD5 authentication keys and text authentication key
0-16 alphanumeric or _-
Used in text authentication keys
0-8 alphanumeric or _-
certificate name 1-31 alphanumeric or ;`~!@#$%^&()_+[\]{}',.=-
community string 0-63 alphanumeric or .-
connection_id 1+ alphanumeric or -_:
contact 1-61 alphanumeric, spaces, or '()+,/:=?;!*#@$_%-.
country code 0 or 2 alphanumeric
custom signature file
name
description Used in keyword criteria for log entries
distinguished name 1-511 alphanumeric, spaces, or .@=,_-
domain name 0+ lower-case letters, numbers, or .-
email 1-63 alphanumeric or .@_-
0-30 alphanumeric or _-.
1-64 alphanumeric, spaces, or '()+,/:=?;!*#@$_%-.
Used in other commands
1-61 alphanumeric, spaces, or '()+,/:=?;!*#@$_%-
Used in ip dns server
1-248 alphanumeric or .-
Used in domainname, ip dhcp pool, and ip domain
1-255 alphanumeric or ._-
“0x” or “0X” + 32-40 hexadecimal values
alphanumeric or ;|`~!@#$%^&*()_+\\{}':,./<>=-
first character: alphanumeric or -
first character: letter
first character: alphanumeric or -
first character: alphanumeric or -
<description>.
NXC CLI Reference Guide
24
Chapter 1 Command Line Interface
Table 4 Input-Value Formats for Strings in CLI Commands (continued)
TAG # VALUES LEGAL VALUES
e-mail 1-64 alphanumeric or .@_-
encryption key 16-64
8-32
file name 0-31 alphanumeric or _-
filter extension 1-256 alphanumeric, spaces, or '()+,/:=?;!*#@$_%.-
fqdn Used in ip dns server
1-253 alphanumeric or .-
Used in ip, time server, device HA, certificates, and
interface ping check
1-255 alphanumeric or .-
full file name 0-256 alphanumeric or _/.-
hostname Used in hostname command
1-64 alphanumeric or .-_
Used in other commands
1-253 alphanumeric or .-
import configuration
file
import shell script 1-
initial string 1-64 alphanumeric, spaces, or '()+,/:=!*#@$_%-.&
key length -- 512, 768, 1024, 1536, 2048
license key 25 “S-” + 6 upper-case letters or numbers + “-” +
mac address -- aa:bb:cc:dd:ee:ff (hexadecimal)
mail server fqdn lower-case letters, numbers, or -.
name 1-31 alphanumeric or _-
notification message 1-81 alphanumeric, spaces, or '()+,/:=?;!*#@$_%-
password: less than 15
chars
password: less than 8
chars
126+”.conf”
26+”.zysh”
1-15 alphanumeric or `~!@#$%^&*()_\-+={}|\;:'<,>./
1-8 alphanumeric or ;/?:@&=+$\.-_!~*'()%,#$
“0x” or “0X” + 16-64 hexadecimal values
alphanumeric or ;\|`~!@#$%^&*()_+\\{}':,./
<>=-
first character: alphanumeric or -
first character: alphanumeric or -
first character: alphanumeric or -
first character: alphanumeric or -
alphanumeric or ;`~!@#$%^&()_+[]{}',.=add “.conf” at the end
alphanumeric or ;`~!@#$%^&()_+[]{}',.=add “.zysh” at the end
16 upper-case letters or numbers
NXC CLI Reference Guide
25
Chapter 1 Command Line Interface
Table 4 Input-Value Formats for Strings in CLI Commands (continued)
TAG # VALUES LEGAL VALUES
password Used in user and ip
1-63 alphanumeric or `~!@#$%^&*()_-+={}|\;:'<,>./
Used in e-mail log profile SMTP authentication
1-63 alphanumeric or `~!@#$%^&*()_-+={}|\;:'<>./
Used in device HA synchronization
1-63 alphanumeric or ~#%^*_-={}:,.
Used in registration
6-20 alphanumeric or .@_-
phone number 1-20 numbers or ,+
preshared key 16-64 “0x” or “0X” + 16-64 hexadecimal values
alphanumeric or ;|`~!@#$%^&*()_+\{}':,./<>=-
profile name 1-31 alphanumeric or _-
first character: letters or _-
proto name 1-16 lower-case letters, numbers, or -
protocol name 1-31 alphanumeric or _-
first character: letters or _-
quoted string less
than 255 chars
quoted string less
than 63 chars
quoted string 0+ alphanumeric, spaces, or punctuation marks
realm 1-253 alphanumeric or -_
service name 0-63 alphanumeric or -_@$./
spi 2-8 hexadecimal
string less than 15
chars
string: less than 63
chars
string 1+ alphanumeric or -_@
subject 1-61 alphanumeric, spaces, or '()+,./:=?;!*#@$_%-
system type 0-2 hexadecimal
timezone [-+]hh -- -12 through +12 (with or without “+”)
url 1-511 alphanumeric or '()+,/:.=?;!*#@$_%-
url “http://”+
1-255 alphanumeric, spaces, or ;/?:@&=+$\.-
_!~*'()%,
1-63 alphanumeric, spaces, or ;/?:@&=+$\.-_!~*'()%
enclosed in double quotation marks (“)
must put a backslash (\) before double
quotation marks that are part of input value
itself
first character: alphanumeric or -_
used in domain authentication
1-15 alphanumeric or -_
1-63 alphanumeric or `~!@#$%^&*()_-+={}|\;:'<,>./
alphanumeric or ;/?:@&=+$\.-_!~*'()%,
“https://”+
starts with “http://” or “https://”
may contain one pound sign (#)
NXC CLI Reference Guide
26
Chapter 1 Command Line Interface
Table 4 Input-Value Formats for Strings in CLI Commands (continued)
TAG # VALUES LEGAL VALUES
user name 1-31 alphanumeric or _-
first character: letters or _-
username 1-31 alphanumeric or _-
first character: alphanumeric or _domain authorization
username 6-20 alphanumeric or .@_-
registration
user name 1+ alphanumeric or -_.
logging commands
user@domainname 1-80 alphanumeric or .@_-
vrrp group name: less
than 15 chars
week-day sequence,
i.e. 1=first,2=second
xauth method 1-31 alphanumeric or _-
xauth password 1-31 alphanumeric or ;|`~!@#$%^&*()_+\{}':,./<>=-
mac address 0-12 (even
1-15 alphanumeric or _-
11-4
hexadecimal
number)
for example: xx-xx-xx-xx-xx-xx
1.8 Saving Configuration Changes
Use the write command to save the current configuration to the NXC.
Note: Always save the changes before you log out after each management session. All
unsaved changes will be lost after the system restarts.
1.9 Logging Out
Enter the exit or end command in configure mode to go to privilege mode.
Enter the
exit command in user mode or privilege mode to log out of the CLI.
NXC CLI Reference Guide
27
User and Privilege Modes
This chapter describes how to use these two modes.
2.1 User And Privilege Modes
This is the mode you are in when you first log into the CLI. (Do not confuse ‘user mode’ with types of user
accounts the NXC uses. See Chapter 23 on page 149 for more information about the user types. ‘User’
type accounts can only run ‘exit’ in this mode. However, they may need to log into the device in order
to be authenticated for ‘user-aware’ policies, for example a firewall rule that a particular user is exempt
from.)
Type ‘enable’ to go to ‘privilege mode’. No password is required. All commands can be run from here
except those marked with an asterisk. Many of these commands are for trouble-shooting purposes, for
example the htm (hardware test module) and debug commands. Customer support may ask you to run
some of these commands and send the results if you need assistance troubleshooting your device.
CHAPTER 2
For admin logins, all commands are visible in ‘user mode’ but not all can be run there. The following
table displays which commands can be run in ‘user mode’. All commands can be run in ‘privilege
mode’.
The htm and psm commands are for Zyxel’s internal manufacturing
process.
Table 5 User (U) and Privilege (P) Mode Commands
COMMAND MODE DESCRIPTION
apply
atse
clear
configure
copy
debug (*)
delete
details
diag
diag-info
dir
disable
enable
P Applies a configuration file.
U/P Displays the seed code
U/P Clears system or debug logs or DHCP binding.
U/P Use ‘configure terminal’ to enter configuration mode.
P Copies configuration files.
U/P For support personnel only! The device needs to have the deb ug flag enabled.
P Deletes configuration files.
P Performs diagnostic commands.
P Provided for support personnel to collect internal system information. It is not
recommended that you use these.
P Has the NXC create a new diagnostic file.
P Lists files in a directory.
U/P Goes from privilege mode to user mode
U/P Goes from user mode to privilege mode
NXC CLI Reference Guide
28
Chapter 2 User and Privilege Modes
Table 5 User (U) and Privilege (P) Mode Commands (continued)
COMMAND MODE DESCRIPTION
exit
htm
U/P Goes to a previous mode or logs out.
U/P Goes to htm (hardware test module) mode for testing hardware components.
You may need to use the htm commands if your customer support Engineer asks
you to during troubleshooting.
Note: These commands are for Zyxel’s internal manufacturing process.
interface
no packet-trace
nslookup
packet-trace
ping
psm
U/P Dials or disconnects an interface.
U/P Turns of packet tracing.
U/P Resolves an IP address to a host name and vice-versa.
U/P Performs a packet trace.
U/P Pings an IP address or host name.
U/P Goes to psm (product support module) mode for setting product parameters.
You may need to use the htm commands if your customer support Engineer asks
you to during troubleshooting.
Note: These commands are for Zyxel’s internal manufacturing process.
reboot
release
rename
renew
run
setenv
show
shutdown
telnet
test aaa
traceroute
write
P Restarts the device.
P Releases DHCP information from an interface.
P Renames a configuration file.
P Renews DHCP information for an interface.
P Runs a script.
U/P Turns stop-on-error on (terminates booting if an error is found in a configuration
file) or off (ignores configuration file errors and continues booting).
U/P Displays command statistics. See the associated command chapter in this
guide.
P Writes all d data to disk and stops the system processes. It does not turn off the
power.
U/P Establishes a connection to the TCP port number 23 of the specified host name
or IP address.
U/P Tests whether the specified user name can be successfully authenticated by an
external authentication server.
P Traces the route to the specified host name or IP address.
P Saves the current configuration to the NXC. All unsaved changes are lost after
the NXC restarts.
Subsequent chapters in this guide describe the configuration commands. User/privilege mode
commands that are also configuration commands (for example, ‘show’) are described in more detail in
the related configuration command chapter.
2.1.1 Debug Commands
Debug commands marked with an asterisk (*) are not available when the debug flag is on and are for
Zyxel service personnel use only. The debug commands follow a syntax that is Linux-based, so if there is a
NXC CLI Reference Guide
29
Chapter 2 User and Privilege Modes
Linux equivalent, it is displayed in this chapter for your reference. You must know a command listed here
well before you use it. Otherwise, it may cause undesired results.
Table 6 Debug Commands
COMMAND SYNTAX DESCRIPTION LINUX COMMAND EQUIVALENT
debug alg
debug app
debug app show l7protocol
(*)
debug ca (*)
debug force-auth (*)
debug gui (*)
debug hardware (*)
debug interface
debug interface ifconfig
FTP/SIP ALG debug commands
Application patrol debug command
Shows app patrol protocol list
Certificate debug commands
Authentication policy debug
commands
Web Configurator related debug
commands
Hardware debug commands
Interface debug commands
Shows system interfaces detail
> cat /etc/l7_protocols/
protocol.list
> ifconfig [interface]
[interface]
debug ip dns
debug ip virtual-server
debug logging
debug manufacture
debug network arpignore
(*)
debug no registration
server (*)
debug policy-route (*)
debug service-register
debug show ipset
debug show registration-
DNS debug commands
Virtual Server (NAT) debug commands.
System logging debug commands
Manufacturing related debug
commands
Enable/Display the ignoring of ARP
responses for interfaces which don't
own the IP address
Set the myZyxel.com registration/
update server to the official site
Policy route debug command
Service registration debug command
Lists the NXC‘s received cards
myZyxel.com debug commands
cat /proc/sys/net/ipv4/
conf/*/arp_ignore
server status
debug [cmdexec|corefile|ip
ZLD internal debug commands
|kernel|mac-idrewrite|observer|switch
|system|zyinetpkt|zyshipt-op] (*)
debug update server (*)
Update server debug command
NXC CLI Reference Guide
30
Loading...