CTS iCPE User Manual

iCPE
Gateway Controller
Network Management User’s Manual
1
Trademarks
Contents are subject to revision without prior notice. All other trademarks remain the properties of their owners.
Copyright Statement
This publication may not be reproduced as a whole or in part, in any way whatsoever unless prior consent has been obtained from the owner.
FCC Warning
This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC Rules. These limitations are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult your local distributors or an experienced radio/TV technician for help. Shielded interface cables must be used in order to comply with emission limits.
Changes or modifications to the equipment, which are not approved by the party responsible for compliance, could affect the user’s authority to operate the equipment.
Copyright © 2016All Rights Reserved.
Company has an on-going policy of upgrading its products and it may be possible that information in this document is not up-to-date. Please check with your local distributors for the latest information. No part of this document can be copied or reproduced in any form without written consent from the company.
Trademarks: All trade names and trademarks are the properties of their respective companies.
2
Manual Version
Firmware Version
Modification
Date
0.90
1.00.00
First Release
20160119
3
Table of Content
1. OVERVIEW ....................................................................................................................... 8
1.1 Management Preparations ............................................................................................................ 8
1.1.1 Connecting the gateway controller .............................................................................. 8
1.1.2 Assigning IP Addresses ............................................................................................. 8
2. Command Line Interface (CLI) ......................................................................................... 10
2.1 Remote Console Management-Telnet ........................................................................................ 10
2.2 Navigating CLI ............................................................................................................................11
2.2.1 General Commands ................................................................................................. 11
2.2.2 Quick Keys ............................................................................................................. 12
2.2.3 Command Format ................................................................................................... 12
2.2.4 Login Username & Password ................................................................................... 14
2.3 User Mode .................................................................................................................................. 14
2.4 Privileged Mode ......................................................................................................................... 15
2.4.1 Copy-cfg Command ................................................................................................ 15
2.4.2 Firmware Command ................................................................................................ 16
2.4.3 Reload Command .................................................................................................... 16
2.4.4 Write Command ...................................................................................................... 17
2.4.5 Configure Command ............................................................................................... 17
2.5 Configuration Mode ................................................................................................................... 17
2.5.1 Entering Interface Numbers ...................................................................................... 18
2.5.2 No Command ......................................................................................................... 18
2.5.3 Show Command ...................................................................................................... 18
2.5.4 IP Command ........................................................................................................... 21
2.5.5 MAC Command ...................................................................................................... 23
2.5.6 Management Command ........................................................................................... 23
2.5.7 Mirror Command .................................................................................................... 24
2.5.8 MQTT Command .................................................................................................... 24
2.5.9 NTP Command ....................................................................................................... 26
2.5.10 QoS Command ...................................................................................................... 27
2.5.11 Security Command ................................................................................................ 33
2.5.12 SNMP-Server Command ........................................................................................ 33
2.5.13 Switch Command .................................................................................................. 36
4
2.5.14 Switch-info Command ........................................................................................... 36
2.5.15 Syslog Command .................................................................................................. 38
2.5.16 USB Command ..................................................................................................... 39
2.5.17 User Command ..................................................................................................... 39
2.5.18 VLAN Command .................................................................................................. 41
2.5.19 Z-Wave Command ................................................................................................. 47
2.5.20 Interface Command ............................................................................................... 48
2.5.21 Show interface statistics Command ......................................................................... 51
2.5.22 Show log Command .............................................................................................. 52
2.5.23 Show default-config, running-config and start-up-config Command ........................... 52
2.5.24 Show battery status Command ................................................................................ 52
3. WEB MANAGEMENT ..................................................................................................... 53
3.1 System Information .................................................................................................................... 55
3.2 User Authentication .................................................................................................................... 56
3.3 Network Management ................................................................................................................ 59
3.3.1 Network Configuration ............................................................................................ 60
3.3.2 System Service Configuration................................................................................... 62
3.3.3 Telnet Configuration ............................................................................................... 62
3.3.4 Time Server Configuration ....................................................................................... 63
3.3.5 Device Community ................................................................................................. 64
3.3.6 Trap Destination ..................................................................................................... 65
3.3.7 Trap Configuration .................................................................................................. 66
3.3.8 Mal-attempt Log Configuration ................................................................................ 66
3.4 Switch Management ................................................................................................................... 67
3.4.1 Switch Configuration ............................................................................................... 68
3.4.2 Broadcast Storm Control .......................................................................................... 69
3.4.3 Port Configuration ................................................................................................... 70
3.4.4 Rate Limit Configuration ......................................................................................... 71
3.4.5 QoS Priority Configuration ...................................................................................... 71
3.4.6 VLAN Configuration ............................................................................................... 75
3.4.6.1 Port Based VLAN ............................................................................................. 77
3.4.6.1.1 Configure Port Based VLAN ....................................................................... 77
3.4.6.2 IEEE 802.1q Tag VLAN ................................................................................... 79
5
3.4.6.2.1 Trunk VLAN Table ..................................................................................... 79
3.4.6.2.2 VLAN Interface .......................................................................................... 80
3.4.6.2.3 Management VLAN .................................................................................... 81
3.4.7 Mirroring Configuration........................................................................................... 82
3.4.8 Filter Configuration ................................................................................................. 83
3.5 Switch Monitor ........................................................................................................................... 83
3.5.1 Switch Port Status ................................................................................................... 84
3.5.2 Port Counters Rates ................................................................................................. 85
3.5.2.1 Port Traffic Statistics (Rates).............................................................................. 85
3.5.2.2 Port Packet Error Statistics (Rates)...................................................................... 86
3.5.2.3 Port Packet Analysis Statistics (Rates)................................................................. 87
3.5.3 Port Counters Events ............................................................................................... 87
3.5.3.1 Port Traffic Statistics (Events) ............................................................................ 88
3.5.3.2 Port Packet Error Statistics (Events) .................................................................... 88
3.5.3.3 Port Packet Analysis Statistics (Events) ............................................................... 89
3.5.4 IEEE 802.1q Tag VLAN Table.................................................................................. 90
3.5.5 MAC Address Table ................................................................................................ 90
3.5.6 Battery ROM Status ................................................................................................ 91
3.6 USB Config & Status ................................................................................................................. 91
3.7 MQTT Configuration ................................................................................................................. 92
3.8 Z-Wave ....................................................................................................................................... 94
3.8.1 Z-Wave Network Manager ....................................................................................... 94
3.8.1.1 Adding and Removing The Controller in An Existing Network .............................. 96
3.8.1.2 How to Initiate A Replication of Network Information from The Controller to Another
Controller ................................................................................................................... 96
3.8.1.3 Assigning The Controller as an SIS ..................................................................... 97
3.8.2 Z-Wave Node Controller .......................................................................................... 97
3.8.2.1 Notification Settings .......................................................................................... 99
3.8.2.2 Power Level Settings ....................................................................................... 108
3.8.2.3 Association Settings ........................................................................................ 109
3.8.2.4 Battery Status ................................................................................................. 111
3.8.2.5 Door Lock Settings ......................................................................................... 111
3.8.2.6 User Code Settings .......................................................................................... 113
6
3.8.2.7 Wake Up Settings ........................................................................................... 113
3.8.2.8 Sensor Multilevel Settings ............................................................................... 114
3.8.2.9 Basic Settings ................................................................................................. 117
3.8.2.10 Binary Settings ............................................................................................. 117
3.8.2.11 Switch Multilevel Settings ............................................................................. 118
3.8.2.12 Meter Settings ............................................................................................... 119
3.8.2.13 Thermostat Setpoint Settings .......................................................................... 121
3.8.2.14 Thermostat Mode Settings .............................................................................. 122
3.8.2.15 Configuration Settings ................................................................................... 123
3.9 Z-Wave Utility .......................................................................................................................... 124
3.9.1 Z-Wave HTTP Upgrade ......................................................................................... 124
3.9.2 Z-Wave Upgrade ................................................................................................... 125
3.9.3 Z-Wave Save Configuration ................................................................................... 126
3.10 System Utility ......................................................................................................................... 126
3.10.1 Ping ................................................................................................................... 127
3.10.2 Event Log ................................ ................................ ........................................... 128
3.10.3 HTTP Upgrade .................................................................................................... 128
3.10.4 FTP/TFTP Upgrade ............................................................................................. 129
3.10.5 Load Factory Settings .......................................................................................... 131
3.10.6 Load Factory Settings Except Network Configuration ............................................. 132
3.11 Save Configuration ................................................................................................................. 132
3.12 Reset System .......................................................................................................................... 133
3.13 Logout .................................................................................................................................... 133
APPENDIX A: DHCP Auto-Provisioning Setup ................................................................... 134
APPENDIX B: Free RADIUS readme ............................................................................... 143
APPENDIX C: Z-Wave Terminology ................................................................................ 144
APPENDIX D: Control Command Class Table ............................................................... 145
7
1. OVERVIEW
This controller is a Z-Wave static controller.
This product can be included and operated in any Z-Wave network with other Z-Wave certified devices from other manufacturers and/or other applications. All non-battery operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network.
This device is a security enabled Z-Wave Plus product that is able to use encrypted Z-Wave Plus message to Enabled Z-Wave Plus devices.
Replication refers to the protocol replication between Controllers that is used to exchange protocol data between different Controllers of the same network.
The controller ignores any Basic Command class if receiving Basic Set from a sensor.
The controller supports Association Command Class. It has one association group, which is Lifeline group with grouping identifier equal to 1. Maximum number of devices that can be added to the group is 1. When the device is reset, this group returns Device Reset Locally notification.
The controller supports the listed browsers: IE, Firefox and Google Chrome.
1.1 Management Preparations
The gateway controller can be accessed through both Telnet connection and a web browser such as Internet Explorer, Google Chrome or Firefox, etc Before you can access the gateway controller and configure it, you need to connect cables properly.
1.1.1 Connecting the gateway controller
It is extremely important that proper cables are used with correct pin arrangements when connecting the gateway controller to other devices such as switches, hubs, workstations, etc..
10/100/1000Base-T RJ-45 Ports
Depending on the model that you purchased, 2 10/100/1000Base-T RJ-45 ports are located on the front panel of the Gateway controller. These RJ-45 ports allow users to connect their traditional copper-based Ethernet devices to network. All these ports support auto-negotiation and MDI/MDIX auto-crossover, i.e. the crossover or straight through CAT-5 cable may be used.
1.1.2 Assigning IP Addresses
IP addresses have the format n.n.n.n, for example 168.168.8.100.
IP addresses are made up of two parts:
8
The first part (168.168.XXX.XXX in the example) indicates network address identifying the
network where the device resides. Network addresses are assigned by three allocation organizations. Depending on your location, each allocation organization assigns a globally unique network number to each network that wishes to connect to the Internet.
The second part (XXX.XXX.8.100 in the example) identifies the device within the network.
Assigning unique device numbers is your responsibility. If you are unsure of the IP addresses allocated to you, consult the allocation organization from which your IP addresses were obtained.
Remember that an address can be assigned to only one device on a network. If you connect to the outside, you must change all the arbitrary IP addresses to comply with those you have been allocated by the allocation organization. If you do not do this, your outside communications will not be connected.
A subnet mask is a filtering system for IP addresses. It allows you to further subdivide your network. You must use the proper subnet mask for a proper operation of a network with subnets defined.
9
2. Command Line Interface (CLI)
This chapter guides you to use Command Line Interface (CLI) via Telnet connection, specifically in:
Configuring the system Resetting the system Upgrading newly released firmware
2.1 Remote Console Management-Telnet
You can use Command Line Interface to manage the Gateway controller via Telnet session. For first­time users, you must first assign a unique IP address to the Gateway Controller before you can manage it remotely. Use any one of the RJ-45 ports on the front panel as the temporary management console port to login to the device with the default username & password and then assign the IP address using IP command in Global Configuration mode.
Follow steps described below to access the Gateway Controller through Telnet session:
Step 1. Use any one of the RJ-45 ports on the front panel as a temporary management console
port to login to the Gateway Controller.
Step 2. Ask the DHCP server for IP address and run Telnet client and connect to the given IP
address. For first-time users, make sure the IP address of your PC or workstation is assigned to an IP address between 192.168.0.2 and 192.168.0.254 with subnet mask
255.255.255.0.
Step 3. When asked for a username, enter admin. When asked for a password, leave the
password field blank and press Enter (by default, no password is required.)
Step 4. If you enter CLI successfully, the prompt display Switch> (the model name of your
device together with a greater than sign) will appear on the screen.
Step 5. Once you enter CLI successfully, you can set up the Switch’s IP address, subnet mask
and the default gateway using IP” command in Global Configuration mode. The telnet session will be terminated immediately once the IP address of the Switch has been changed.
Step 6. Use new IP address to login to the Gateway Controller via Telnet session again.
Limitation: Only one active Telnet session can access the Gateway Controller at a time.
10
2.2 Navigating CLI
Command Mode
Access Method
Prompt Displayed
Exit Method
User Mode
Login username & password
ICPE>
logout
Privileged Mode
From user mode, enter the enable command
ICPE#
disable, exit, logout
Configuration Mode
From the enable mode, enter the config or configure command
ICPE(config)#
exit
NOTE: By default, the model name will be used for the prompt display. For convenience, the
prompt display “ICPE” will be used throughout this user’s manual.
Entering the command…
To do this…
Available Modes
help
Obtain a list of available commands in the current mode.
User Mode Privileged Mode Configuration Mode
exit
Return to the previous mode or login screen.
User Mode Privileged Mode Configuration Mode
history
List all commands that have been used.
User Mode Privileged Mode Configuration Mode
logout
Logout from the CLI or terminate Telnet session.
User Mode Privileged Mode
After you successfully access to the Gateway Controller, you will be asked for a login username. Enter your authorized username and password, and then you will be directed to the User Mode. In CLI management, the User Mode only provides users with basic functions to operate the Gateway Controller. If you would like to configure advanced features of the Gateway Controller, such as, VLAN, QoS and Rate limit control, you must enter the Configuration Mode. The following table provides an overview of modes available in this Gateway Controller.
2.2.1 General Commands
This section introduces you some general commands that you can use in all modes, including “help”, “exit”, “history” and “logout”.
11
2.2.2 Quick Keys
Keys
Purpose
tab
Enter an unfinished command and press “Tab” key to complete the command.
?
Press “?” key in each mode to get available commands.
Unfinished command followed by ?
Enter an unfinished command or keyword and press “?” key to complete the command and get command syntax help.
Examples:
ICPE#h? help Show available commands history Show history commands
ICPE#he? <cr>
ICPE#help
Up arrow
Use Up arrow key to scroll through the previous entered commands, beginning with the most recent key-in commands.
Down arrow
Use Down arrow key to scroll through the previous entered commands, beginning with the commands that are entered first.
This means that you are in Global Configuration mode
This allows you to assign IP address.
Enter the IP address, subnet mask, and default gateway address.
Hostname
In CLI, there are several quick keys that you can use to perform several functions. The following table summarizes the most frequently used quick keys in CLI.
2.2.3 Command Format
While in CLI, you will see several symbols very often. As mentioned above, you might already know what “>”, “#” and (config)# represent. However, to perform what you intend the device to do, you have to enter a string of complete command correctly. For example, if you want to assign IP address for the Gateway Controller, you need to enter the following command with the required parameter and IP, subnet mask and default gateway:
IP command syntax: ICPE(config)#ip address [A.B.C.D] [255.X.X.X] [A.B.C.D]
ICPE(config)#ip address 192.168.1.198 255.255.255.255 192.168.1.254
12
The following table lists common symbols and syntax that you will see very frequently in this User’s
Symbols
Brief Description
>
Currently, the device is in User Mode.
#
Currently, the device is in Privileged Mode.
(config)#
Currently, the device is in Global Configuration Mode.
Syntax
Brief Description
[ ]
Brackets mean that this field is required information.
[A.B.C.D ]
Brackets represent that this is a required field. Enter an IP address or gateway address.
[255.X.X.X]
Brackets represent that this is a required field. Enter the subnet mask.
[port-based | 802.1p | dscp | vid]
There are four options that you can choose. Specify one of them.
[1-8191]
Specify a value between 1 and 8191.
[0-7] 802.1p_list [0-63] dscp_list
Specify one or more values or a range of values.
For example: specifying one value
ICPE(config)#qos 802.1p-map 1 0
ICPE(config)#qos dscp-map 10 3
For example: specifying three values (separated by commas)
ICPE(config)#qos 802.1p-map 1,3 0
ICPE(config)#qos dscp-map 10,13,15 3
For example: specifying a range of values (separating by a hyphen)
ICPE(config)#qos 802.1p-map 1-3 0
ICPE(config)#qos dscp-map 10-15 3
Manual for your reference:
13
2.2.4 Login Username & Password
Command
Description
exit
Quit the User mode or close the terminal connection.
help
Display a list of available commands in User mode.
history
Display the command history.
ping
Used to test the reachability of a host on an Internet Protocol (IP) network
logout
Logout from the Gateway Controller.
enable
Enter the Privileged mode.
Default Login
After you enter Telnet session, a login prompt will appear to request a valid and authorized username and password combination. For first-time users, enter the default login username adminand press
Enter key in password field (no password is required for default setting). When system prompt shows “ICPE>”, it means that the user has successfully entered the User Mode.
For security reasons, it is strongly recommended that you add a new login username and password using User command in Configuration Mode. When you create your own login username and password, you can delete the default username (admin) to prevent unauthorized accesses.
Forgot Your Login Username & Password?
If you forgot your login username and password, you can use the “reset button” to set all
configurations back to factory defaults. Once you have performed system reset to defaults, you can login with default username and password. Please note that if you use this method to gain access to the Gateway Controller, all configurations saved in Flash will be lost. It is strongly recommended that a copy of configurations is backed up in your local hard-drive or file server from time to time so that previously-configured settings can be restored to the Gateway Controller for use after you gain access again to the device.
2.3 User Mode
In User mode, only a limited set of commands are provided. Please note that in Use Mode, you have no authority to configure advanced settings. You need to enter Privileged mode and Configuration mode to set up advanced functions of a gateway Controller feature. For a list of commands available in User Mode, enter the question mark (?) or “help” command after the system prompt displays ICPE>.
14
2.4 Privileged Mode
Command
Description
copy-cfg
Restore or backup configuration file via FTP or TFTP server.
disable
Exit Enable Mode and return to User Mode
exit
Exit Enable Mode and return to User Mode.
firmware
Upgrade Firmware via FTP or TFTP server.
help
Display a list of available commands in Enable Mode.
history
Show commands that have been used.
logout
Logout from the Gateway Controller.
ping
Used to test the reachability of a host on an Internet Protocol (IP) network
reload
Restart the Gateway Controller.
write
Save your configurations to Flash.
configure
Enter Global Configuration mode
show
Show a list of commands or show the current setting of each listed command.
Command
Parameter
Description
ICPE# copy-cfg from ftp [A.B.C.D] [file name] [user_name] [password]
[A.B.C.D]
Enter the IP address of your FTP server.
[file_name]
Enter the configuration file name that you want to restore.
[user_name]
Enter the username for FTP server login.
[password]
Enter the password for FTP server login.
ICPE# copy-cfg from tftp [A.B.C.D] [file_name]
[A.B.C.D]
Enter the IP address of your TFTP server.
[file_name]
Enter the configuration file name that you want to restore.
Example
ICPE# copy-cfg from ftp 192.168.1.198 HS_0600_file.conf misadmin1 abcxyz
ICPE# copy-cfg from tftp 192.168.1.198 HS_0600_file.conf
Command / Example
ICPE# copy-cfg from default
The only place where you can enter the Privileged (Enable) Mode is in User Mode. When you successfully enter Enable mode, the prompt will be changed to ICPE# (the model name of your device together with a pound sign). Enter the question mark (?) or help command to view a list of commands available for use.
2.4.1 Copy-cfg Command
Use “copy-cfg” command to backup a configuration file via FTP or TFTP server or restore the Gateway Controller back to the defaults or to the defaults without changing IP configurations.
1. Restore a configuration file via FTP or TFTP server.
2. Restore the Gateway Controller back to default settings.
NOTE: There are two ways to set the Gateway Controller back to the factory default settings. Users
can use the “copy-cfg from default” command in CLI or simply press the “Reset Buttonlocated on the front panel to restore the device back to the initial state.
15
3. Restore the Gateway Controller back to default settings but keep IP configurations.
Command / Example
ICPE# copy-cfg from default keep-ip
Command
Parameter
Description
ICPE# copy-cfg to ftp [A.B.C.D] [file_name] [user_name] [password]
[A.B.C.D]
Enter the IP address of your FTP server.
[file_name]
Enter the configuration file name that you want to backup.
[user_name]
Enter the username for FTP server login.
[password]
Enter the password for FTP server login.
ICPE# copy-cfg to tftp [A.B.C.D] [file_name]
[A.B.C.D]
Enter the IP address of your TFTP server.
[file_name]
Enter the configuration file name that you want to backup.
Example
ICPE# copy-cfg to ftp 192.168.1.198 HS_0600_file.conf misadmin1 abcxyz
ICPE# copy-cfg to tftp 192.168.1.198 HS_0600_file.conf
Command
Parameter
Description
ICPE# firmware upgrade ftp [A.B.C.D] [file_name] [user_name] [password]
[A.B.C.D]
Enter the IP address of your FTP server.
[file_name]
Enter the firmware file name that you want to upgrade.
[user_name]
Enter the username for FTP server login.
[password]
Enter the password for FTP server login.
ICPE# firmware upgrade tftp [A.B.C.D] [file_name]
[A.B.C.D]
Enter the IP address of your TFTP server.
[file_name]
Enter the firmware file name that you want to upgrade.
Example
ICPE# firmware upgrade ftp 192.168.1.198 HS_0600_file.bin edgeswitch10 abcxyz
ICPE# firmware upgrade tftp 192.168.1.198 HS_0600_file.bin
Command / Example
ICPE# reload
4. Backup a configuration file to TFTP server.
2.4.2 Firmware Command
To upgrade Firmware via FTP or TFTP server.
2.4.3 Reload Command
To restart the Gateway Controller, enter the reload command.
16
2.4.4 Write Command
Command / Example
ICPE# write
Command / Example
ICPE# config ICPE(config)#
ICPE# configure ICPE(config)#
Command
Description
exit
Exit the Configuration Mode.
help
Display a list of available commands in Configuration Mode.
history
Show commands that have been used.
ip
Set up the IP address and enable DHCP mode & IGMP snooping.
mac
Set up each port’s MAC learning function.
management
Set up the system service type.
mirror
Set up port mirror configuration
mqtt
Set up mqtt configuration.
ntp
Set up required configurations for Network Time Protocol.
qos
Set up the priority of packets within the Gateway Controller.
security
Set up storm control settings.
snmp-server
Create a new SNMP community and trap destination and specify the trap types.
switch
Enable or disable SFP and counter polling function.
switch-info
Specify company name, host name, system location, etc.
usb
Enable or disable USB port functionality.
syslog
Enable or disable syslog server and assign server IP address.
user
Create a new user account.
vlan
Set up VLAN mode and VLAN configuration.
zwave
Set up Z-Wave configuration.
no
Disable a command or set it back to its default setting.
interface
Set up the selected interfaces’ advanced features.
To save running configurations to startup configurations, enter the write command. All unsaved configurations will be lost when you restart the Gateway Controller.
2.4.5 Configure Command
You can enter Global Configuration Mode only from Privileged Mode. You can type in “configure” or “config” to enter Global Configuration Mode. The display prompt will change from “ICPE#” to “ICPE(config)#” once you successfully enter Global Configuration Mode.
2.5 Configuration Mode
When you enter “configure” or “config” and press “Enter” in Privileged Mode, you will be directed to Global Configuration Mode where you can set up advanced gateway Controller functions, such as QoS, VLAN, and storm control security globally. Any command entered will be applied to running­configuration and the device’s operation. From this level, you can also enter different sub-configuration modes to set up specific configurations for VLAN, QoS, security or interfaces.
17
show
Show a list of commands or show the current setting of each listed command.
2.5.1 Entering Interface Numbers
Commands
Description
ICPE(config)# interface 1 ICPE(config-if-1)#
Enter a single interface. Only interface 1 will apply to commands entered.
ICPE(config)# interface 1,2 ICPE(config-if-1,2)#
Enter three discontinuous interfaces, separating by a comma. Interface 1, 2 will apply to commands entered.
In the Global Configuration Mode, you can configure a command that is only applied to interfaces specified. For example, you can set up each interface’s VLAN assignment, speed, or duplex mode. To configure, you must first enter the interface number. There are four ways to enter your interface numbers to signify the combination of different interfaces that apply to a command or commands.
The “interface” command can be used together with “QoS”, “VLAN” and “Security” commands. For
detailed usages, please refer to QoS, VLAN and Security sections below.
2.5.2 No Command
Most commands that you enter in Configuration mode can be negated using “no” command followed by the same or original command. The purpose of “no” command is to disable a function, remove a command, or set the setting back to the default value. In each sub-section below, the use of no command to fulfill different purposes will be introduced.
2.5.3 Show Command
The command “show” is very important for network administrators to get information about the device, receive outputs to verify a command’s configurations or troubleshoot a network configuration error.
“Show” command can be used in Privileged or Configuration mode. The following describes different uses of “show” command.
18
1. Display system information
Enter “show switch-info” command in Privileged or Configuration mode, and then the following similar screen page will appear.
Company Name: Display a company name for this Gateway Controller. Use “switch-info company- name [company-name]” command to edit this field.
System Object ID: Display the predefined System OID.
System Contact: Display contact information for this Gateway Controller. Use “switch-info sys-
contact [sys-contact]” command to edit this field.
System Name: Display a descriptive system name for this Gateway Controller. Use “switch-info sys- name [sys-name]” command to edit this field.
System Location: Display a brief location description for this Gateway Controller. Use “switch-info sys-location [sys-location]” command to edit this field.
Model Name: Display the product’s model name.
Host Name: Display the product’s host name.
DHCP Vendor ID: Display the product’s DHCP Vendor ID.
Firmware Version: Display the image version used in this device.
M/B Version: Display the main board version.
1000M Port Number: The number of ports transmitting at the speed of 1000Mbps
100M Port Number: The number of ports transmitting at the speed of 100Mbps
19
Serial Number: Display the serial number of this Gateway Controller.
Date Code: Displays the Gateway Controller Firmware date code.
Uptime: Display the time the device has been up.
Local Time: Display the time of the location where the Gateway Controller is.
2. Display or verify currently-configured settings
Refer to “interface command”, “ip command”, “mac command”, “qos command”, “security command”, “snmp-server command”, “user command”, and vlan command” sections.
3. Display interface information or statistics
Refer to “show interface statistics command” and “show sfp information command sections.
4. Show default, running and startup configurations
Refer to “show default-config command”, “show running-config command” and “show start-up-config command” sections.
5. Show battery status
Refer to show battery status command.
20
IP command
Parameter
Description
ICPE(config)# ip address [A.B.C.D] [255.X.X.X] [A.B.C.D]
[A.B.C.D]
Enter the desired IP address for the Gateway Controller.
[255.X.X.X]
Enter subnet mask of your IP address.
[A.B.C.D]
Enter the default gateway address.
ICPE(config)# ip dhcp snooping
Enable DHCP Snooping function
ICPE(config)# ip dhcp snooping dhcp-server [port_list]
[port_list]
Specify DHCP server trust ports.
ICPE(config)# ip name-server server1 [A.B.C.D]
[A.B.C.D]
Specify IP Address for Domain Name System (DNS) Server 1
ICPE(config)# ip name-server server2 [A.B.C.D]
[A.B.C.D]
Specify IP Address for Domain Name System (DNS) Server 2
No command
ICPE(config)# no ip address
Remove the Gateway Controller’s IP address.
ICPE(config)# ip name-server server1
Remove IP Address of Domain Name System (DNS) Server 1
ICPE(config)# ip name-server server2
Remove IP Address of Domain Name System (DNS) Server 2
Show command
ICPE(config)# show ip address
Show the current IP configurations or verify the configured IP settings.
ICPE(config)# show ip name-server
Show the current configured DNS IP address
IP command example
ICPE(config)# ip address
192.168.1.198 255.255.255.0
192.168.1.254
Set up the Gateway Controller’s IP to 192.168.1.198, subnet mask to 255.255.255.0, and default gateway to
192.168.1.254.
Command / Example
Description
ICPE(config)# ip address dhcp
Enable DHCP mode.
No command
ICPE(config)# no ip address dhcp
Disable DHCP mode.
Show command
2.5.4 IP Command
Configure IP address and related settings such as DHCP snooping and IGMP snooping.
1. Set up or remove the IP address of the Gateway Controller.
2. Enable the Gateway Controller to automatically get IP address from the DHCP server.
21
ICPE(config)# show ip address
Show the current IP configurations or verify the configured IP settings.
Command / Example
Parameter
Description
ICPE(config)# ip dhcp snooping
Enable DHCP snooping function.
ICPE(config)# ip dhcp snooping dhcp-server [port_list]
[port_list]
Specify DHCP server trust ports.
No command
ICPE(config)# no ip dhcp snooping
Disable IGMP snooping function.
ICPE(config)# no ip dhcp snooping dhcp-server
Remove all the DHCP server trust ports
Show command
ICPE(config)# show ip dhcp snooping
Show current DHCP snooping status including DHCP server trust ports.
Command / Example
Parameter
Description
Switch(config)# ip source
Globally enable IP source security.
Switch(config)# ip source binding [1-12]
[1-12]
Specify IP address security binding number and enable it.
Switch(config)# ip source binding [1-12] ip-address [A.B.C.D]
[A.B.C.D]
Specify IP address
No command
Switch(config)# no ip source
Globally disable IP source security.
Switch(config)# no ip source binding [1-12]
Disable IP address security binding.
Switch(config)# no ip source binding [1-12] ip­address [A.B.C.D]
Disable IP address security binding on the specified IP address.
Show command
Switch(config)# show ip shource
Show current status of IP source.
3. Enable or disable DHCP snooping globally.
4. Global IP address security configuration.
22
MAC Command
Parameter
Description
ICPE(config)# mac address-table aging-time [7-600000]
[7-600000]
Enter aging time for MAC address table. Numbers available are from 7 to 600000.
No command
ICPE(config)# no mac address-table aging-time
Set MAC address table aging time to the default value (300 seconds).
Show command
ICPE(config)# show mac aging-time
Show current MAC address table aging time.
ICPE(config)# show mac address­table
Show MAC addresses learned by the Gateway Controller
ICPE(config)# show mac address­table interface [port_list]
[port_list]
Show MAC addresses learned by the selected ports.
ICPE(config)# show mac address­table top
Show MAC addresses learned from the first entry.
MAC command example
ICPE(config)# mac address-table aging-time 600
Set MAC address table aging time to 600 seconds.
Management command
Parameter
Description
ICPE(config)# management smart­home-server [domain_name]
[domain_name]
By default, DHCP server plays a role in gateway. You may assign other device a gateway by typing IP address or domain name.
ICPE(config)# management console timeout [0 | 5-300]
[0 | 5-300]
Under RS-232 interface commands, specify session aging time within the range: zero or 5-300 seconds. (0 indicates never aging out)
ICPE(config)# management [ssh | telnet|web]
Select the system service type, SSH, telnet or web.
ICPE(config)# management telnet port [1-65535]
[1-65535]
Specify telnet port number.
No command
ICPE(config)# no management [ssh | telnet | web]
[ssh | telnet |
web]
Set system service type to Disabled.
ICPE(config)# no management telnet port
Disable telnet port number specified.
Show command
ICPE(config)# show management
Show the current system service type.
Management command example
2.5.5 MAC Command
Set up MAC address table aging time. Entries in the MAC address table containing source MAC addresses and their associated ports will be deleted if they are not accessed within the specified aging time.
2.5.6 Management Command
23
ICPE(config)# management ssh
Enable SSH system service type.
Mirror command
Parameter
Description
ICPE(config)# mirror mode [by­port]
[by-port]
Enable mirror mode by-port
ICPE(config)# mirror source [port_list]
[port_list]
Specify the source port(s) to be mirrored
ICPE(config)# mirror destination [port]
[port]
Specify the destination port for mirroring
No command
ICPE(config)# no mirror mode
Disable mirror mode
Show command
ICPE(config)# show mirror
Show port mirror information
Mirror command example
ICPE(config)# mirror mode by-port ICPE(config)# mirror source 1 ICPE(config)# mirror destination 2
Enable mirror mode and set port 2 as mirror destination and port 1 as source port.
MQTT command
Parameter
Description
ICPE(config)# mqtt [1-5]
[1-5]
Add a new MQTT ID
ICPE(config-mqtt-ID)# account enable
To activate the account
ICPE(config-mqtt-ID)# account name [user_name]
[user_name]
Specify the authorized user login name, up to 255 alphanumeric characters
ICPE(config-mqtt-ID)# account password [password]
[password]
Enter the desired user password, up to 255 alphanumeric characters.
ICPE(config-mqtt-ID)# active Enable MQTT function for the MQTT ID
ICPE(config-mqtt-ID)# clean­session
The clean session flag indicates the broker, whether the client wants to establish a persistent session or not. A persistent session (CleanSession is false) means, that the broker will store all subscriptions for the client and also all missed messages, when subscribing with Quality of Service (QoS) 1 or 2. If clean
2.5.7 Mirror Command
2.5.8 MQTT Command
Message Queue Telemetry Transport (MQTT) is a Client Server publish/subscribe messaging transport protocol. It is light weight, open, simple, and designed so as to be easy to implement. These characteristics make it ideal for use in many situations, including constrained environments such as for communication in Machine to Machine (M2M) and Internet of Things (IoT) contexts where a small code footprint is required and/or network bandwidth is at a premium.
24
session is set to true, the broker won’t store
anything for the client and will also purge all information from a previous persistent session.
ICPE(config-mqtt-ID)# client-id [id]
[id]
The client identifier (short Client ID) is an identifier of each MQTT client connecting to a MQTT broker. Specify the client identifier name, up to 23 alphanumeric characters
ICPE(config-mqtt-ID)# domain­name [domain_name]
[domain_name]
Assign a domain name, IP address or website typically, to the broker. The broker is primarily responsible for receiving all messages, filtering them, decide who is interested in it and then sending the message to all subscribed clients.
ICPE(config-mqtt-ID)# keep­alive [0-65535]
[0-65535]
The keep alive is a time interval, the clients commits to by sending regular PING Request messages to the broker. The broker response with PING Response and this mechanism will allow both sides to determine if the other one is still alive and reachable. 0 refers to disable. The default setting is 5.
ICPE(config-mqtt-ID)# port [0­65535]
[0-65535]
This refers to a list of Internet socket port
numbers used by protocols of the transport layer of the Internet Protocol Suite for the establishment of host-to-host connectivity. The configurable range is 0 ~ 65535.
ICPE(config-mqtt-ID)# tls psk
Transport Layer Security pre-shared key ciphersuites (TLS-PSK) is a set of cryptographic protocols that provide secure communication based on pre-shared keys (PSKs). These pre-shared keys are symmetric keys shared in advance among the communicating parties.
ICPE(config-mqtt-ID)# tls psk­identity [identity]
[identity]
Specify a name to the Identity, up to 127 alphanumeric characters.
ICPE(config-mqtt-ID)# tls psk­key [identity]
[identity]
Enter the desired user password, up to 127 alphanumeric characters.
No Command
ICPE(config)# no mqtt [1-5]
Remove MQTT ID
ICPE(config-mqtt-ID)# no account enable
Deactivate the account
ICPE(config-mqtt-ID)# no account name
Remove the authorized user login name
ICPE(config-mqtt-ID)# no account password
Remove the password
ICPE(config-mqtt-ID)# no active
Disable MQTT function for the MQTT ID
ICPE(config-mqtt-ID)# no clean-session
Disable clean session function
ICPE(config-mqtt-ID)# no client-id
Remove the client identifier
25
ICPE(config-mqtt-ID)# no domain-name
Remove a domain name
ICPE(config-mqtt-ID)# no keep-alive
Return to default value 5
ICPE(config-mqtt-ID)# no port
Return to default value 1883
ICPE(config-mqtt-ID)# no tls psk
Disable Transport Layer Security pre-shared key
function
ICPE(config-mqtt-ID)# no tls psk-identity
Remove the Identity name
ICPE(config-mqtt-ID)# no tls psk-key
Remove the password
Show Command
ICPE(config)# show mqtt [1-5]
Show the status of specified MQTT ID
ICPE(config-mqtt-ID)# show
Show the status of the MQTT ID
Command
Parameter
Description
ICPE(config)# ntp
Enable the Gateway Controller to synchronize the clock with a time server.
ICPE(config)# ntp daylight-saving [recurring | date]
[recurring | date]
Enable the day light savings.
ICPE(config)# ntp offset [Mm,w,d,hh:mm-Mm,w,d,hh:mm]
[Mm,w,d,hh:mm­Mm,w,d,hh:mm]
Offset setting for daylight saving function of recurring mode.
Mm=1-12, w=1-5, d=0-6(0=Sun, 6=Sat) Hh=0-23, mm=0-59, Days=1-365
ICPE(config)# ntp offset [Days,hh:mm-Days,hh:mm]
[Days,hh:mm­Days,hh:mm]
Offset setting for daylight saving function of date mode.
Mm=1-12, w=1-5, d=0-6(0=Sun, 6=Sat) Hh=0-23, mm=0-59, Days=1-365
ICPE(config)# ntp server1 [A.B.C.D]
[A.B.C.D]
Specify the primary time server IP address.
ICPE(config)# ntp server2 [A.B.C.D]
[A.B.C.D]
Specify the secondary time server IP address.
ICPE(config)# ntp syn-interval [1­8]
[1-8]
Specify the interval time to synchronize from NTP time server. The meanings of the value:
1:1hr, 2:2hrs 3:3hrs 4:4hrs 5:6hrs 6:8hrs 7:12hrs 8:24hrs
ICPE(config)# ntp time-zone [0­132]
[0-132]
Specify the time zone to that the Gateway Controller belongs. Use any key to view the
2.5.9 NTP Command
Set up required configurations for Network Time Protocol.
26
complete code list of 132 time zones. For example, “ICPE(config)# ntp time-zone ?”
No command
ICPE(config)# no ntp
Disable the Gateway Controller to synchronize the clock with a time server.
ICPE(config)# no ntp daylight-saving
Disable the daylight saving function.
ICPE(config)# no ntp offset
Set the offset value back to the default setting.
ICPE(config)# no ntp server1
Delete the primary time server IP address.
ICPE(config)# no ntp server2
Delete the secondary time server IP address.
ICPE(config)# no ntp syn-interval
Set the synchronization interval back to the default setting.
ICPE(config)# no ntp time-zone
Set the time-zone setting back to the default setting.
Show command
ICPE(config)# show ntp
Show or verify current time server settings.
NTP command example
ICPE(config)# ntp
Enable the Gateway Controller to synchronize the clock with a time server.
ICPE(config)# ntp server1 192.180.0.12
Set the primary time server IP address to
192.180.0.12.
ICPE(config)# ntp server2 192.180.0.13
Set the secondary time server IP address to
192.180.0.13.
ICPE(config)# ntp syn-interval 8
Set the synchronization interval to 24 hrs.
ICPE(config)# ntp time-zone 4
Set the time zone to GMT-8:00 Vancouver.
QoS command
Parameter
Description
ICPE(config)# qos [802.1p | dscp]
[802.1p | dscp]
Specify one QoS mode.
802.1p: Use “qos 802.1p_map” command to assign priority bits to a queue.
dscp: Use “qos dscp-map [0-63] dscp_list [0-
3]” to assign several DSCP values to a priority value.
No command
ICPE(config)# no qos
Disable QoS function.
Show command
ICPE(config)# show qos
Show or verify QoS configurations.
QoS command example
ICPE(config)# qos 802.1p
Enable QoS function and use 802.1p mode.
ICPE(config)# qos dscp
Enable QoS function and use DSCP mode.
2.5.10 QoS Command
1. Specify the desired QoS mode.
2. Set up the DSCP and queue mapping.
27
DSCP-map command
Parameter
Description
ICPE(config)# qos dscp-map [0-63] dscp_list [0-3]
[0-63] dscp_list
Specify the corresponding DSCP value you want to map to a priority queue.
[0-3]
Specify a queue to which the specified DSCP value is assigned.
No command
ICPE(config)# no qos dscp-map [0-63] dscp_list
Set the queue of the specific DCSP value back to the default.
Show command
ICPE(config)# show qos
Show or verify QoS configurations.
DSCP-map example
ICPE(config)# qos dscp-map 50 3
Mapping DSCP value 50 to priority queue 3.
28
3. Set up management traffic priority and port user priority.
Management-priority command
Parameter
Description
ICPE(config)# qos management­priority [0-7]
[0-7]
Specify management traffic default 802.1p priority bit.
No command
ICPE(config)# no qos management-priority
Set management traffic priority back to the default.
Management-priority example
ICPE(config)# qos management-priority 4
Set management traffic priority to 4.
NOTE: To check the setting of management traffic priority, please refer to 2.5.17 VLAN
Command.
Queuing-mode command
Parameter
Description
ICPE(config)# qos queuing-mode [weight]
[weight]
By default, “strict” queuing mode is used. If you want to use “weight” queuing mode, you
need to disable “strict” queuing mode.
Strict mode: Traffic assigned to queue 3 will be transmitted first, and the traffic assigned to
queue 2 will not be transmitted until queue 3’s
traffic is all transmitted, and so forth.
Weight mode: All queues have fair opportunity of dispatching. Each queue has the specific amount of bandwidth according to its assigned weight.
No command
ICPE(config)# no qos queuing-mode
Set the queuing mode to Strict mode.
Show command
ICPE(config)# show qos
Show or verify QoS configurations.
Queuing-mode example
ICPE(config)# qos queuing-mode weight
Change the queuing mode from strict to Weight.
Queuing-weighted command
Parameter
Description
ICPE(config)# qos queuing­weight [1:2:4:8]
[ _:_:_:_ ]
(1-32)
By default, queuing weight is “1:2:4:8”. Specify the value from 1 to 32.
No command
ICPE(config)# no qos queuing-weight
Set the queuing weight back to the default.
Show command
ICPE(config)# show qos
Show or verify QoS configurations.
4. Set up QoS queuing mode.
5. Set up queue weight.
29
Queuing-weighted example
ICPE(config)# qos queuing-weighted 1:7:14:21
Specify the queue weight as 1:7:14:21.
Remarking command
Parameter
Description
ICPE(config)# qos remarking [dscp | 802.1p]
[dscp |
802.1p]
Enable the specific remarking mode, DSCP or
802.1p Remarking.
ICPE(config)# qos remarking dscp [by-dscp]
[by-dscp]
Specify DSCP bit remarking mode.
ICPE(config)# qos remarking dscp-map [1-8]
[1-8]
Configure the DSCP and priority mapping ID.
ICPE(config)# qos remarking
802.1p-map [1-8]
[1-8]
Configure the 802.1p and priority mapping ID.
No command
ICPE(config)# no qos remarking dscp
Undo specify DSCP bit remarking mode
ICPE(config)# no qos remarking dscp-map [1-8]
[1-8]
Undo specify DSCP and priority mapping ID
ICPE(config)# no qos remarking
802.1p
Disable 802.1p bit remarking
ICPE(config)# no qos remarking
802.1p-map [1-8]
[1-8]
Undo specify a 802.1p value
Show command
ICPE(config)# show qos remarking
Show current DSCP, VID and 802.1p remarking configuration.
Remarking example
ICPE(config)# qos remarking 802.1p
Enable 802.1p remarking.
ICPE(config)# no qos remarking dscp
Disable DSCP remarking.
Mapping command
Parameter
Description
ICPE(config)# qos 802.1p-map [0-7] 802.1p_list [0-3]
[0-7]
802.1p_list
Specify 802.1p bit value.
[0-3]
Specify queue value.
No command
ICPE(config)# no qos 802.1p-map
Undo 802.1p mapping.
5. Set up 802.1p and DSCP remarking
6. Set up 802.1p priority mapping bit and queue mapping.
30
Loading...
+ 115 hidden pages