ZyXEL NXC Series Reference Guide
Quick Start Guide
NXC Series
Wireless LAN Controller
Versions: 4.20
Edition 1, 01/2015
CLI Reference Guide
Default Login Details
IP Address https://192.168.1.1
User Name admin
Password 1234
www.zyxel.com
Copyright © 2011
Copyright © 2015 ZyXEL Communications Corporation
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).
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.
How To Use This Guide
1 Read Chapter 1 on page 15 for how to access and use the CLI (Command Line Interface).
2 Read Chapter 2 on page 31 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.
It is recommended you use the Web Configurator to configure the NXC.
Contents Overview
Contents Overview
Command Line Interface ........................................................................................................... 15
User and Privilege Modes ......................................................................................................... 31
Object Reference ................ ... ... ... .... ... ... ... ... ....................................... ... .... ... ... ... .... ... ... ... .......... 35
Status ............................................................... ...................... ....................... ............................. 37
Registration ............................................................................................................................... 41
Interfaces ..................................... ....................................................... ....................................... 47
Route ......................................................................................................................................... 65
AP Management ........................................................................................................................ 73
AP Group ................................................................................................................................... 79
Wireless LAN Profiles ...................... ... ... ... ... .... ...................................... .... ... ... ... .... ... ... ... .......... 87
Rogue AP ................................................................................................................................ 105
Wireless Frame Capture ..................... ... ... ... .... ... ... ... .... ... ... ... .... ... ... ... ... .... ... ........................... 109
Dynamic Channel Selection .....................................................................................................111
Auto-Healing ....................................... ....................................................... ...............................113
Dynamic Guest .........................................................................................................................115
LEDs ............................... .................................................... ......................................................119
Zones .................................. ................... ................... .................... ................... ........................121
ALG ......................................................................................................................................... 125
Captive Portal .......................................................................................................................... 127
RTLS ........................................................................................................................................ 133
Firewall .................................................................................................................................... 135
User/Group .............................................................................................................................. 143
Addresses .............................. ................... .................... ................... ................... ..................... 151
Services ................................. ....................................................... ........................................... 155
Schedules ................................. ................................................. .............................................. 159
AAA Server .............................................................................................................................. 161
Authentication Objects ................. .... ... ... ... ... ....................................... ... .... ... ... ... .... ... ... ... ........ 167
Authentication Server ............................................... .... ... ... ... .... ... ........................................... 171
ENC ......................................................................................................................................... 173
Certificates ................................... ....................... ....................... ...................... ........................ 177
System ................................... ...................... ....................... ....................... .............................. 181
System Remote Management ................................................................................................. 187
DHCPv6 Objects ..................................................................................................................... 199
File Manager ............................................................................................................................ 201
Logs ....................................... .................................................... .............................................. 219
Reports and Reboot ................................................................................................................ 227
Session Timeout ....................... ... .... ... ... ... ... ....................................... ... .... ... ... ... .... ................. 233
Diagnostics .............................................................................................................................. 235
NXC CLI Reference Guide
3
Contents Overview
Packet Flow Explore ................................................................................................................ 237
Maintenance Tools ...................................................................................................................239
Watchdog Timer ....................................................................................................................... 245
Managed AP Commands ................ ... ... ... ... .... ... ... ... .... ... ... ... ....................................... ... ... .... . 249
List of Commands .................................................................................................................... 255
4
NXC CLI Reference Guide
Table of Contents
Table of Contents
Contents Overview...............................................................................................................................3
Table of Contents .................................................................................................................................5
Chapter 1
Command Line Interface....................................................................................................................15
1.1 Overview ................... ... ... .... ... ... ... .... ... ....................................... ... ... ... ..............................................15
1.1.1 The Configuration File .............................................................................................................15
1.2 Accessing the CLI .............................................................................................................................15
1.2.1 Console Port .................... ... .... ... ... ... ....................................... ... ... .... ... ... ... ..............................16
1.2.2 Web Configurator Console ......................................................................................................17
1.2.3 Telnet ..... ... .... ... ... ... .... ... ....................................... ...................................... .... ..........................20
1.2.4 SSH (Secure SHell) .................................................................................................................20
1.3 How to Find Commands in this Guide ...............................................................................................21
1.4 How Commands Are Explained ........................................................................................................21
1.4.1 Background Information ..... .... ... ... ... ... .... ... ... ... .... ... ....................................... ... ... ... ... .... ..........21
1.4.2 Command Input Values ...........................................................................................................21
1.4.3 Command Summary ............... ... ... ... ... .... ...................................... .... ... ... ... .... ... ... ... ... .... ..........22
1.4.4 Command Examples .................................... ... ....................................... ... .... ... ... ... .................22
1.4.5 Command Syntax ............................... .... ... ....................................... ... ... ... .... ... ... ....................22
1.4.6 Changing the Password ..........................................................................................................22
1.5 CLI Modes ....... ....................................... ... ... ....................................... ... .... ... ....................................22
1.6 Shortcuts and Help ............................................................................................................................23
1.6.1 List of Available Commands ....................................................................................................23
1.6.2 List of Sub-commands or Required User Input .......................................................................24
1.6.3 Entering Partial Commands ....... ... ... ... .... ... ... ... .... ...................................... .... ... ... ... ... .... ... .......25
1.6.4 Entering a ? in a Command .....................................................................................................25
1.6.5 Command History ............... .... ... ... ....................................... ... ... ... .... ... ... .................................25
1.6.6 Navigation .............. .... ... ... ....................................... ... ... .... ... ... .................................................25
1.6.7 Erase Current Command ................. ... .... ... ..............................................................................25
1.6.8 The no Commands ..................................................................................................................25
1.7 Input Values .................... .... ... ... ... .... ... ....................................... ... ... ... ..............................................26
1.8 Saving Configuration Changes .........................................................................................................29
1.9 Logging Out .................................. .... ...................................... .... ... ... .................................................29
Chapter 2
User and Privilege Modes..................................................................................................................31
2.1 User And Privilege Modes .................................................................................................................31
2.1.1 Debug Commands ........... ... .... ...................................... .... ... ... ... ... .... .......................................33
NXC CLI Reference Guide
5
Table of Contents
Chapter 3
Object Reference................................................................................................................................35
3.1 Object Reference Commands ...........................................................................................................35
3.1.1 Object Reference Command Example ....................................................................................36
Chapter 4
Status...................................................................................................................................................37
4.1 Status Show Commands ...................................................................................................................37
Chapter 5
Registration.........................................................................................................................................41
5.1 myZyXEL.com overview ............................... .... ... ... ... .... ... ... ....................................... ... ... .................41
5.1.1 Subscription Services Available on the NXC ...........................................................................41
5.2 Registration Commands ............................ ........................................................................................42
5.2.1 Command Examples .................................... ... ....................................... ... .... ... ... ... .................42
5.3 Country Code ............ ... ... .... ...................................... .... ... ... ... .... ... ....................................................43
Chapter 6
Interfaces.............................................................................................................................................47
6.1 Interface Overview ....................... .... ... ... ... ....................................... ... ... .... ... ... ... .... ... .......................47
6.1.1 Types of Interfaces ................................. ... ... ... .... ... ....................................... ... ... ... ... ..............47
6.2 Interface General Commands Summary ...........................................................................................47
6.2.1 Basic Interface Properties and IP Address Commands ..........................................................48
6.2.2 DHCP Setting Commands ............... ....................................... ... ... .... ... ... ... ..............................52
6.2.3 Connectivity Check (Ping-check) Commands .........................................................................56
6.3 Ethernet Interface Specific Commands ............................ ... ... .... ... ... ... ... .... ... ... ... ..............................57
6.3.1 MAC Address Setting Commands ...........................................................................................57
6.4 Port Commands ........................ ... .... ...................................... .... ... ... ... ... ...........................................58
6.5 Port Role Commands ........................................................................................................................59
6.5.1 Port Role Examples .................................................................................................................59
6.6 USB Storage Specific Commands ....................................................................................................59
6.6.1 USB Storage General Commands Example ............................................................................61
6.7 VLAN Interface Specific Commands ...................... ... .... ... ....................................... ... ... ....................61
6.7.1 VLAN Interface Examples .. .... ... ... ... ... .... ...................................... .... ... ... ... .... ... .......................63
Chapter 7
Route....................................................................................................................................................65
7.1 Policy Route ....... .... ...................................... .... ... ... ....................................... ... ... .... ..........................65
7.2 Policy Route Commands ...................................................................................................................65
7.2.1 Assured Forwarding (AF) PHB for DiffServ .............................................................................68
7.2.2 Policy Route Command Example ............................................................................................69
7.3 IP Static Route ..................................................................................................................................69
7.4 Static Route Commands ...................................................................................................................70
6
NXC CLI Reference Guide
Table of Contents
7.4.1 Static Route Commands Example ...........................................................................................70
7.5 Learned Routing Information Commands ..................... ... ... ... .... ... ... ... ... .... ... ... ... .... ... ... ... ... .... ... ... . ...71
7.5.1 show ip route Command Example .......................... .......................... ......................... .............. 71
Chapter 8
AP Management..................................................................................................................................73
8.1 AP Management Overview ...............................................................................................................73
8.2 AP Management Commands .............. ... ... ... .....................................................................................74
8.2.1 AP Management Commands Example ...................................................................................78
Chapter 9
AP Group.............................................................................................................................................79
9.1 Wireless Load Balancing Overview ...................................................................................................79
9.2 AP Group Commands .......................................................................................................................79
9.2.1 AP Group Examples ................................................................................................................83
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 ... ... .... ... ... ... ... .... ... ... ... .... ... ... ... ... .... ... .......92
10.3 SSID Profile Commands .................................................................................................................93
10.3.1 SSID Profile Example ............................................................................................................95
10.4 Security Profile Commands ............................ ...... ....... ... ...... ....... ...... ....... ...... ....... ...... ...... ..............95
10.4.1 Security Profile Example .......................................................................................................98
10.5 MAC Filter Profile Commands .............. ...... ....... ...... ....... ...... ....... ... ...... ....... ...... ....... ...... .................99
10.5.1 MAC Filter Profile Example ...................................................................................................99
10.6 Layer-2 Isolation Profile Commands .............................................................................................100
10.6.1 Layer-2 Isolation Profile Example ........................................................................................101
10.7 ZyMesh Profile Commands ...........................................................................................................101
Chapter 11
Rogue AP...........................................................................................................................................105
11.1 Rogue AP Detection Overview ......................................................................................................105
11.2 Rogue AP Detection Commands ..................................................................................................105
11.2.1 Rogue AP Detection Examples ............................................................................................106
11.3 Rogue AP Containment Overview .................................................................................................107
11.4 Rogue AP Containment Commands .............................................................................................108
11.4.1 Rogue AP Containment Example ........................................................................................108
Chapter 12
Wireless Frame Capture...................................................................................................................109
12.1 Wireless Frame Capture Overview ...................................... .... ... ... ... ... .... ... ..................................109
NXC CLI Reference Guide
7
Table of Contents
12.2 Wireless Frame Capture Commands ...................... .... ... ... ... .... ... ... ... ....................................... .....109
12.2.1 Wireless Frame Capture Examples .....................................................................................110
Chapter 13
Dynamic Channel Selection.............................................................................................................111
13.1 DCS Overview ............................................................................................................................... 111
13.2 DCS Commands ........................................................................................................................... 111
Chapter 14
Auto-Healing .....................................................................................................................................113
14.1 Auto-Healing Overview .................................................................................................................113
14.2 Auto-Healing Commands ..............................................................................................................113
14.2.1 Auto-Healing Examples .......................................................................................................114
Chapter 15
Dynamic Guest..................................................................................................................................115
15.1 Dynamic Guest Overview ..............................................................................................................115
15.2 Dynamic Guest Commands ..........................................................................................................115
15.2.1 Dynamic Guest Examples ...................................................................................................117
Chapter 16
LEDs...................................................................................................................................................119
16.1 LED Suppression Mode ............................. .... ... ... ... .... ... ... ... .........................................................119
16.2 LED Suppression Commands ........ ... ... ... ......................................................................................119
16.2.1 LED Suppression Commands Example ..............................................................................120
16.3 LED Locator ..................................................................................................................................120
16.4 LED Locator Commands ...............................................................................................................120
16.4.1 LED Locator Commands Example ......................................................................................120
Chapter 17
Zones.................................................................................................................................................121
17.1 Zones Overview ............................................................................................................................121
17.2 Zone Commands Summary ..........................................................................................................122
17.2.1 Zone Command Examples ..................................................................................................123
Chapter 18
ALG ....................................................................................................................................................125
18.1 ALG Introduction ...........................................................................................................................125
18.2 ALG Commands ............................................................................................................................126
18.3 ALG Commands Example .............................................................................................................126
Chapter 19
Captive Portal....................................................................................................................................127
8
NXC CLI Reference Guide
Table of Contents
19.1 Captive Portal Overview ................................................................................................................127
19.1.1 Web Authentication Policy Commands ........................................... ... ... ... .... ... ... ... ... .... ... ... ..127
19.1.2 qrcode-auth-profile Commands ........................................................................................... 130
19.1.3 page-customization Commands ..........................................................................................131
19.1.4 Customizing the User Logout Page .....................................................................................132
Chapter 20
RTLS ..................................................................................................................................................133
20.1 RTLS Introduction .........................................................................................................................133
20.2 RTLS Commands ..........................................................................................................................133
Chapter 21
Firewall ..............................................................................................................................................135
21.1 Firewall Overview ..........................................................................................................................135
21.2 Firewall Commands .............................................................................................................. ........136
21.2.1 Firewall Sub-Commands .....................................................................................................138
21.2.2 Firewall Command Examples ..............................................................................................139
21.3 Session Limit Commands .............................................................................................................140
Chapter 22
User/Group........................................................................................................................................143
22.1 User Account Overview .................................................................................................................143
22.1.1 User Types ..........................................................................................................................143
22.2 User/Group Commands Summary .......................... ....................................... ...............................144
22.2.1 User Commands ..................................................................................................................144
22.2.2 User Group Commands .......................................................................................................145
22.2.3 User Setting Commands .....................................................................................................145
22.2.4 MAC Auth Commands .........................................................................................................147
22.2.5 Additional User Commands .................................................................................................148
Chapter 23
Addresses .........................................................................................................................................151
23.1 Address Overview .........................................................................................................................151
23.2 Address Commands Summary .....................................................................................................152
23.2.1 Address Object Commands .................................................................................................152
23.2.2 Address Group Commands ................................................................................................. 153
Chapter 24
Services.............................................................................................................................................155
24.1 Services Overview ........................................................................................................................155
24.2 Services Commands Summary .....................................................................................................155
24.2.1 Service Object Commands ................................ ...................................................... ............155
24.2.2 Service Group Commands ..................................................................................................156
NXC CLI Reference Guide
9
Table of Contents
Chapter 25
Schedules..........................................................................................................................................159
25.1 Schedule Overview .......................................................................................................................159
25.2 Schedule Commands Summary ...................................................................................................159
25.2.1 Schedule Command Examples ...........................................................................................160
Chapter 26
AAA Server........................................................................................................................................161
26.1 AAA Server Overview ...................................................................................................................161
26.2 Authentication Server Command Summary ................................ ... ... ... .... ... ..................................161
26.2.1 aaa group server ad Commands .........................................................................................162
26.2.2 aaa group server ldap Commands ......................................................................................163
26.2.3 aaa group server radius Commands ...................................................................................164
26.2.4 aaa group server Command Example .................................................................................166
Chapter 27
Authentication Objects.....................................................................................................................167
27.1 Authentication Objects Overview ..................................................................................................167
27.2 aaa authentication Commands .....................................................................................................167
27.2.1 aaa authentication Command Example ...............................................................................168
27.3 test aaa Command ........................................................................................................................169
27.3.1 Test a User Account Command Example ............................................................................169
Chapter 28
Authentication Server ......................................................................................................................171
28.1 Authentication Server Overview ........................... .................................... .....................................171
28.2 Authentication Server Commands ................................................................................................171
28.2.1 Authentication Server Command Examples ........................................................................172
Chapter 29
ENC ....................................................................................................................................................173
29.1 ENC Overview ...............................................................................................................................173
29.2 ENC-Agent Commands .................................................................................................................173
29.2.1 ENC-Agent Command Examples ........................................................................................175
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
10
NXC CLI Reference Guide
Table of Contents
Chapter 31
System...............................................................................................................................................181
31.1 System Overview ..........................................................................................................................181
31.2 Customizing the WWW Login Page ..............................................................................................181
31.3 Host Name Commands .................................................................................................................183
31.4 Time and Date ..............................................................................................................................183
31.4.1 Date/Time Commands .................................................... ............................................. ........184
31.5 Console Port Speed .....................................................................................................................185
31.6 DNS Overview ..............................................................................................................................185
31.6.1 DNS Commands ..................................................................................................................185
31.6.2 DNS Command Example ....................................................................................................186
Chapter 32
System Remote Management..........................................................................................................187
32.1 Remote Management Overview .................................................................................................... 187
32.1.1 Remote Management Limitations ........................................................................................187
32.1.2 System Timeout ...................................................................................................................187
32.2 Common System Command Input Values ....................................................................................188
32.3 HTTP/HTTPS Commands .............................................................................................................188
32.3.1 HTTP/HTTPS Command Examples ....................................................................................189
32.4 SSH ...............................................................................................................................................190
32.4.1 SSH Implementation on the NXC ........................................................................................190
32.4.2 Requirements for Using SSH ................................... ... .... ... ... ... ... .........................................190
32.4.3 SSH Commands ..................................................................................................................190
32.4.4 SSH Command Examples ...................................................................................................191
32.5 Telnet ............................................................................................................................................191
32.6 Telnet Commands .........................................................................................................................192
32.6.1 Telnet Commands Examples ................................................... ............................................ 192
32.7 Configuring FTP ...........................................................................................................................193
32.7.1 FTP Commands ..................................................................................................................193
32.7.2 FTP Commands Examples ..................................................................................................193
32.8 SNMP ...........................................................................................................................................194
32.8.1 Supported MIBs ...................................................................................................................194
32.8.2 SNMP Traps ........................................................................................................................194
32.8.3 SNMP Commands ...............................................................................................................195
32.8.4 SNMP Commands Examples ..............................................................................................196
32.9 TR-069 ..........................................................................................................................................196
32.9.1 TR-069 Commands .............................................................................................................197
32.9.2 TR-069 Commands Examples ............................................................................................198
32.10 Language Commands .................................................................................................................198
Chapter 33
DHCPv6 Objects................................................................................................................................199
NXC CLI Reference Guide
11
Table of Contents
33.1 DHCPv6 Object Commands Summary .........................................................................................199
33.1.1 DHCPv6 Object Commands ................................................................................................199
33.1.2 DHCPv6 Object Command Examples .................................................................................200
Chapter 34
File Manager......................................................................................................................................201
34.1 File Directories ..............................................................................................................................201
34.2 Configuration Files and Shell Scripts Overview ............... ....................................... ... ..................201
34.2.1 Comments in Configuration Files or Shell Scripts ...............................................................202
34.2.2 Errors in Configuration Files or Shell Scripts .......................................................................203
34.2.3 NXC Configuration File Details ................................ ............................................................203
34.2.4 Configuration File Flow at Restart .......................................................................................204
34.3 File Manager Commands Input Values .........................................................................................204
34.4 File Manager Commands Summary .............................................................................................205
34.5 File Manager Command Example ........................ ....... ...... ... ....... ...... ....... ...... ....... ...... ...... .... ........206
34.6 FTP File Transfer ..........................................................................................................................206
34.6.1 Command Line FTP File Upload .........................................................................................206
34.6.2 Command Line FTP Configuration File Upload Example ....................................................207
34.6.3 Command Line FTP File Download .....................................................................................207
34.6.4 Command Line FTP Configuration File Download Example ...............................................208
34.7 Firmware Update Scheduling Commands ....................................................................................208
34.8 NXC File Usage at Startup ............................................................................................................208
34.9 Notification of a Damaged Recovery Image or Firmware .............................................................209
34.10 Restoring the Recovery Image (NXC5200 Only) ........................................................................210
34.11 Restoring the Firmware ...............................................................................................................212
34.12 Restoring the Default System Database .....................................................................................215
34.12.1 Using the atkz -u Debug Command (NXC5200 Only) .......................................................216
Chapter 35
Logs...................................................................................................................................................219
35.1 Log Commands Summary ............................................................................................................219
35.1.1 Log Entries Commands .......................................................................................................220
35.1.2 System Log Commands ......................................................................................................220
35.1.3 Debug Log Commands ........................................................................................................221
35.1.4 E-mail Profile Log Commands .............................................................................................222
35.1.5 Console Port Log Commands .............................................................................................224
35.1.6 Access Point Logging Commands .............................. ....................... ...................... ............224
Chapter 36
Reports and Reboot..........................................................................................................................227
36.1 Report Commands Summary ........................................................................................................227
36.1.1 Report Commands ..............................................................................................................227
36.1.2 Report Command Examples ...............................................................................................228
12
NXC CLI Reference Guide
Table of Contents
36.1.3 Session Commands ............................................................................................................228
36.2 Email Daily Report Commands ............................ .........................................................................229
36.2.1 Email Daily Report Example .......................... .......................................................... ............231
36.3 Reboot ...........................................................................................................................................232
Chapter 37
Session Timeout...............................................................................................................................233
Chapter 38
Diagnostics .......................................................................................................................................235
38.1 Diagnostics ....................................................................................................................................235
38.2 Diagnosis Commands ...................................................................................................................235
38.3 Diagnosis Commands Example ....................................................................................................235
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 ...........................................................................................................241
Chapter 41
Watchdog Timer................................................................................................................................245
41.1 Hardware Watchdog Timer .................. ... ... .... ...................................... .... ... ... ... .... ... ... ... ... ............245
41.2 Software Watchdog Timer .............................................................. ... ... .... ... ... ... .... ... ... ... ...............245
41.3 Application Watchdog ...................................................................................................................246
41.3.1 Application Watchdog Commands Example ........................................................................247
Chapter 42
Managed AP Commands..................................................................................................................249
42.1 Managed Series AP Commands Overview ...................................................................................249
42.2 Accessing the AP CLI ...................................................................................................................249
42.3 CAPWAP Client Commands .........................................................................................................250
42.3.1 CAPWAP Client Commands Example .................................................................................251
42.4 DNS Server Commands ................................................................................................................252
42.4.1 DNS Server Commands Example ....................................................................................... 252
42.4.2 DNS Server Commands and DHCP ........................ ....................................................... .....253
List of Commands ............................................................................................................................255
NXC CLI Reference Guide
13
Table of Contents
14
NXC CLI Reference Guide
CHAPTER 1
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
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.
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).
NXC CLI Reference Guide
15
Chapter 1 Command Line Interface
The NXC might force you to log out of your session if reauthentication time,
lease time, or idle timeout is reached. See Chapter 22 on page 143 for more
information about these settings.
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
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.
16
Figure 2 Login Screen
Welcome to NXC
Username:
NXC CLI Reference Guide
Chapter 1 Command Line Interface
Enter the user name and password at the prompts.
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.
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
NXC CLI Reference Guide
17
Chapter 1 Command Line Interface
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.
Y ou can log into the Web Configurator with a different account than used to log into
the NXC through the Console.
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.
18
NXC CLI Reference Guide
Chapter 1 Command Line Interface
2 Enter the IP address of the NXC and click OK.
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.
NXC CLI Reference Guide
19
Chapter 1 Command Line Interface
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.
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
and the NXC’s IP address. For example, enter telnet 192.168.1.1 (the default
management IP address).
3 Click OK. A login screen displays. Enter the user name and password at the prompts.
telnet
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.
The default login username is admin and password is 1234. The username
and password are case-sensitive.
20
NXC CLI Reference Guide
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
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
Chapter 1 Command Line Interface
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.
1.4 How Commands Are Explained
Each chapter explains the commands for one keyword. The chapters ar e divided into the
following sections.
1.4.1 Background Information
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
NXC CLI Reference Guide
21
Chapter 1 Command Line Interface
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
tcp or udp, depending on the service object you want to create.
4 Finally , do one of the following.
•Enter
•Enter
eq exactly as it appears, followed by a number between 1 and 65535.
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
22.2 on page 144 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
Unable to access Unable to access Unable to access Unable to access
• Look at (but not
run) available
commands
Unable to access Unable to access Unable to access
22
NXC CLI Reference Guide
Chapter 1 Command Line Interface
Table 3 CLI Modes (continued)
USER PRIVILEGE CONFIGURATION SUB-COMMAND
What LimitedAdmin 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
• Look at system
information (like
Status screen)
• Run basic
diagnostics
• Look at system
information (like
Status screen)
• Run basic
diagnostics
Router> Router# Router(config)# (varies by part)
• 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
Router(zone)#
Router(configif-ge)#
...
See Chapter 22 on page 143 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.
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
[TAB].
<command> ? or <command>
NXC CLI Reference Guide
23
Chapter 1 Command Line Interface
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
Figure 8 Help: Required User Input Example
Router(config)# ip telnet server port ?
<1..65535>
Router(config)# ip telnet server port
24
NXC CLI Reference Guide
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.
Chapter 1 Command Line Interface
For example, if you enter
config and press [TAB] , the full command of configure
automatically displays.
If you enter a partial command that is not unique and press
commands that start with the partial command.
Figure 9 Non-Unique Partial Command Example
Router# c [TAB]
clear configure copy
Router# co [TAB]
configure copy
1.6.4 Entering a ? in a Command
Typing a ? (questio n 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
[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
25
Chapter 1 Command Line Interface
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
Router# configure terminal
Router(config)# interface ge1
Router(config-if-ge)# description
<description>
<description>.
The following table provides more information about input values like
<description>.
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 -
26
NXC CLI Reference Guide
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 + “-” + 16
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
upper-case letters or numbers
NXC CLI Reference Guide
27
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://”+
user name 1-31 alphanumeric or _-
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 (#)
first character: letters or _-
28
NXC CLI Reference Guide
Chapter 1 Command Line Interface
Table 4 Input-Value Formats for Strings in CLI Commands (continued)
TAG # VALUES LEGAL VALUES
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.
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
29
Chapter 1 Command Line Interface
30
NXC CLI Reference Guide
Loading...