CTS iCPE User Manual

Gateway controller network management
Table of Contents

Advertisement

iCPE
Gateway Controller
Network Management User's Manual
Version 0.90
1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the iCPE and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for CTS iCPE

  • Page 1 Gateway Controller Network Management User’s Manual Version 0.90...
  • Page 2 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.
  • Page 3 Manual Version Firmware Version Modification Date 0.90 1.00.00 First Release 20160119...
  • Page 4: Table Of Contents

    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 ....................
  • Page 5 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 ....................
  • Page 6 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)................
  • Page 7 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 ...................
  • Page 8: Overview

    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.
  • Page 9  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. ...
  • Page 10: Command Line Interface (Cli)

    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.
  • Page 11: Navigating Cli

    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. 2.2.1 General Commands This section introduces you some general commands that you can use in all modes, including “help”, “exit”, “history”...
  • Page 12: Quick Keys

    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 Hostname This allows you to Enter the IP address, subnet mask, and assign IP address.
  • Page 13 [1-8191] Specify a value between 1 and 8191. 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) [0-7] 802.1p_list [0-63] dscp_list ICPE(config)#qos 802.1p-map 1,3 0...
  • Page 14: Login Username & Password

    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>”. Command...
  • Page 15: Privileged Mode

    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.
  • Page 16: Firmware Command

    Enter the configuration file name that you want to [file_name] [file_name] 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 2.4.2 Firmware Command To upgrade Firmware via FTP or TFTP server. Command Parameter...
  • Page 17: Write Command

    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.
  • Page 18: Entering Interface Numbers

    There are four ways to enter your interface numbers to signify the combination of different interfaces that apply to a command or commands. Commands Description ICPE(config)# interface 1 Enter a single interface. Only interface 1 will apply to ICPE(config-if-1)# commands entered.
  • Page 19 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.
  • Page 20 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.
  • Page 21: Ip Command

    255.255.255.0, and default gateway to 192.168.1.254 192.168.1.254. 2. Enable the Gateway Controller to automatically get IP address from the DHCP server. Command / Example Description ICPE(config)# ip address dhcp Enable DHCP mode. No command ICPE(config)# no ip address dhcp Disable DHCP mode. Show command...
  • Page 22 No command ICPE(config)# no ip dhcp snooping Disable IGMP snooping function. Remove all the DHCP server trust ports ICPE(config)# no ip dhcp snooping dhcp-server Show command Show current DHCP snooping status ICPE(config)# show ip dhcp snooping including DHCP server trust ports.
  • Page 23: Mac Command

    [7-600000] Numbers available are from 7 to 600000. No command Set MAC address table aging time to the ICPE(config)# no mac address-table aging-time default value (300 seconds). Show command ICPE(config)# show mac aging-time Show current MAC address table aging time.
  • Page 24: Mirror Command

    ICPE(config)# management ssh Enable SSH system service type. 2.5.7 Mirror Command Mirror command Parameter Description ICPE(config)# mirror mode [by- [by-port] Enable mirror mode by-port port] ICPE(config)# mirror source [port_list] Specify the source port(s) to be mirrored [port_list] ICPE(config)# mirror destination...
  • Page 25 ICPE(config-mqtt-ID)# tls psk- Enter the desired user password, up to 127 [identity] key [identity] 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...
  • Page 26: Ntp Command

    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...
  • Page 27: Qos Command

    132 time zones. For example, “ICPE(config)# ntp time-zone ?” No command Disable the Gateway Controller to ICPE(config)# no ntp 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.
  • Page 28 Specify a queue to which the specified DSCP [0-3] 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.
  • Page 29 [0-7] priority [0-7] priority bit. No command Set management traffic priority back to the ICPE(config)# no qos management-priority 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.
  • Page 30 Show current DSCP, VID and 802.1p ICPE(config)# show qos remarking remarking configuration. Remarking example ICPE(config)# qos remarking 802.1p Enable 802.1p remarking. ICPE(config)# no qos remarking dscp Disable DSCP remarking. 6. Set up 802.1p priority mapping bit and queue mapping. Mapping command Parameter Description [0-7] Specify 802.1p bit value.
  • Page 31 Specify the 802.1p remarking value. priority [0-7] ICPE(config-802.1p-map-ID)# Exit the entry. exit DSCP Remarking No command ICPE(config)# no qos remarking Set the specific entry back to the default [1-8] 802.1p-map [1-8] setting. [ active | Disable the mapping entry, or set 802.1p value ICPE(config-802.1p-map-ID)# no...
  • Page 32 ICPE(config)# qos 802.1p-map Map priority bit 6 and 7 to queue 4. 6-7 3 ICPE(config)# no qos 802.1p- Delete or remove 802.1p priority bit 6 and 7’s mapping. map 6-7 8. Use interface command to set up default class and ingress and egress rate limit.
  • Page 33: Security Command

    ICPE(config-if-1-3)# qos rate-limit ingress 1550 limit to 1550. Set the selected interfaces’ queue 3 to egress rate ICPE(config-if-1-3)# qos rate-limit egress 3 1550 1550. 2.5.11 Security Command When a device on the network is malfunctioning or application programs are not well designed or properly configured, broadcast storms may occur, which may degrade network performance or in the worst situation cause a complete halt.
  • Page 34 Exit command ICPE(config-community-NAME)# exit Return to Global Configuration Mode. Snmp-server example Create a new community “mycomm” and edit ICPE(config)# snmp-server community mycomm the details of this community account. Activate the SNMP community “mycomm”. ICPE(config-community-mycomm)# active ICPE(config-community-mycomm)# description Add a description for “mycomm” community.
  • Page 35 Show command ICPE(config)# show snmp- [1-3] Show the specified trap destination information. server trap-destination [1-3] Show SNMP trap destination information in ICPE(config)# show snmp-server trap-destination Global Configuration mode. View this trap destination account’s information. ICPE(config-trap-ACCOUNT)# show Exit command ICPE(config- trap-ACCOUNT)# exit Return to Global Configuration Mode.
  • Page 36: Switch Command

    A trap will be sent when the device’s power is down. warm-start: A trap will be sent when the device restarts. No command ICPE(config)# no snmp-server trap-type auth- Authentication failure trap will not be sent. fail Show command Show the current enable/disable status of each ICPE(config)# show snmp-server trap-type type of trap.
  • Page 37 Switch-info Command Parameter Description ICPE(config)# switch-info Enter a company name for this Gateway company-name [company_name] Controller, up to 55 alphanumeric characters. [company_name] Enter the user-defined DHCP vendor ID up to 55 alphanumeric characters. Please make sure ICPE(config)# switch-info you have an exact DHCP Vendor ID with the...
  • Page 38: Syslog Command

    No command Delete the entered company name information. ICPE(config)# no switch-info company-name Delete the entered DHCP vendor ID ICPE(config)# no switch-info dhcp-vendor-id information. Delete the entered system contact information.
  • Page 39: Usb Command

    ICPE(config)# syslog Enable syslog and assign server1 IP address ICPE(config)# syslog server1 192.168.0.222 192.168.0.222 2.5.16 USB Command USB command Parameter Description ICPE(config)# usb [usb_list] [usb_list] Enable specified usb ports No Command ICPE(config)# no usb [usb_list] Disable specified usb ports. Show Command...
  • Page 40 ICPE(config-user-USERNAME)# no description Remove the configured description. Remove the configured level value. The account ICPE(config-user-USERNAME)# no level level will return to the default setting. ICPE(config-user-USERNAME)# no password Remove the configured password value. Show command ICPE(config)# show user Show the specified account’s information.
  • Page 41: Vlan Command

    ICPE(config)# no user radius server2 Delete the specified IP address. Show command ICPE(config)#show user radius Show current RADIUS settings. User command example ICPE(config)# user radius Enable RADIUS authentication. ICPE(config)# user radius radius-port 1812 Set RADIUS server port number to 1812.
  • Page 42 Preamble Type/LEN PAYLOAD Original frame 802.1q Preamble Type/LEN PAYLOAD FCS TCI/P/C/VID frame PRE Preamble 62 bits Used to synchronize traffic SFD Start Frame Delimiter 2 bits Marks the beginning of the header DA Destination Address 6 bytes The MAC address of the destination SA Source Address 6 bytes The MAC address of the source...
  • Page 43 1. Use “Interface” command to configure a group of ports’ 802.1q VLAN settings. VLAN & Interface command Parameter Description ICPE(config)# interface [port_list] [port_list] Enter several discontinuous port numbers separated by commas or a range of ports with a hyphen. For example:1,2 Specify the selected ports’...
  • Page 44 ICPE(config)# interface 1-2 Set port 1 to port 3’s Access-VLAN ID ICPE(config-if-1-2)# vlan dot1q-vlan access-vlan (PVID) to 10. ICPE(config-if-1-2)# vlan dot1q-vlan mode access Set the selected ports to access mode (untagged). ICPE(config-if-1-2)# vlan dot1q-vlan mode trunk Enable native VLAN for untagged traffic.
  • Page 45 ICPE(config)# vlan dot1q-vlan Globally enable 802.1q VLAN. ICPE(config)# vlan dot1q-vlan [1- [1-4094] Enter a VID number to create a 802.1q 4094] VLAN. Note : 802.1q VLAN ID need to be created under interface global command. In here you can only modify it instead of creating a new VLAN ID.
  • Page 46 ICPE(config)# no vlan dot1q-vlan Disable 802.1q VLAN isolation isolation ICPE(config-vlan-ID)# no name Remove the descriptive name for the specified VLAN ID. ICPE(config)# no vlan isolation up- Undo uplink ports. link-port [port_list] ICPE(config)# no vlan port-based Disable port-based VLAN. ICPE(config)# no vlan port-based...
  • Page 47: Z-Wave Command

    Enter the configuration file name that you want to [file_name] [file_name] restore. 2. Restore the Z-Wave of Gateway Controller back to default settings. Command / Example ICPE# z-wave copy-cfg from default 3. Backup a configuration file to TFTP server. Command Parameter Description ICPE# z-wave copy- Enter the IP address of your FTP server.
  • Page 48: Interface Command

    In order to save configuration setting permanently, users need to save configuration first before resetting the Gateway Controller. Show Command ICPE# show zwave event Show Z-Wave Event log that keeps a record of Z- Wave information. ICPE# show zwave mode...
  • Page 49 Parameter Description Set the selected interfaces’ to auto-negotiation. ICPE(config-if-PORT-PORT)# auto-negotiation When auto-negotiation is enabled, speed configuration will be ignored. No command ICPE(config-if-PORT-PORT)# no Set auto-negotiation setting to the default auto-negotiation setting. 3. Set up port description. Command Parameter Description Switch(config-if-PORT-PORT)#...
  • Page 50 Switch(config-if-PORT-PORT)# [0|32- Configure egress rate limit, set zero or from qos rate-limit egress [0|32- 1000000] 32Kbps to 1000Mbps. 1000000] Switch(config-if-PORT-PORT)# [0-7] Port default 802.1p bit. Specify desired port qos user-priority [0-7] default 802.1p bit between 0 and 7. No command Switch(config-if-PORT-PORT)# no Undo ingress rate limit.
  • Page 51: Show Interface Statistics Command

    vlan port-based [name] Note : Need to create a port-based VLAN group first at Switch Management-->VLAN Configuration-->Port Based VLAN-- >Configure VLAN. No command Set the selected ports’ PVID to the default Switch(config-if-PORT-PORT)# no vlan dot1q-vlan access-vlan setting. Switch(config-if-PORT-PORT)# no Remove VLAN dot1q mode. vlan dot1q-vlan mode Switch(config-if-PORT-PORT)# no Disable native VLAN for untagged traffic.
  • Page 52: Show Log Command

    Switch(config)# show interface Display error packets statistics (events) for statistics error each port. Switch(config)# show interface Display error packets statistics (events) for the [port_list] statistics error [port_list] selected ports. Switch(config)# show interface Display error packets statistics (rates) for each statistics error rate port.
  • Page 53: Web Management

    3. WEB MANAGEMENT The Gateway Controller can be managed via a Web browser. The default IP of the Gateway Controller is set under DHCP mode. You can change the Switch’s IP address to the intended one later in its Network Management menu. Follow these steps to manage the Gateway Controller through a Web browser: 1.
  • Page 54 After a successful login, the screen appears as below. 1. System Information: Name the Gateway Controller, specify the location and check the current version of information. 2. User Authentication: Create and view the registered user list. 3. Network Management: Set up or view the IP address and related information about the Gateway Controller required for network management applications.
  • Page 55: System Information

    3.1 System Information Select System Information from the left column and then the following screen shows up. Company Name: Enter a company name up to 55 alphanumeric characters for this Gateway Controller. System Object ID: View-only field that shows the predefined System OID. System Contact: Enter contact information up to 55 alphanumeric characters for this Gateway Controller.
  • Page 56: User Authentication

    System Location: Enter a brief description of the Gateway Controller location up to 55 alphanumeric characters. The location is for reference only. DHCP Vendor ID: Enter the user-defined vendor ID up to 55 alphanumeric characters. Please make sure you have an exact DHCP Vendor ID with the value specified in “vendor-classes” in your dhcp.conf file.
  • Page 57 Click New to add a new user account, then the following screen page appears. Click Edit to view and edit a registered user setting. Click Delete to remove a registered user setting. Current/Total/Max Users: View-only field. Current: This shows the number of current registered user. Total: This shows the total number of the registered users.
  • Page 58 Read & Write: Partial access right, unable to modify system information, user account, load factory settings and upgrade firmware. Read Only: Read only access right. NOTE: If you forget the login password, the only way to gain access to the Web Management is to set the Gateway Controller back to the factory default setting by pressing the Reset button for more than10 seconds Gateway Controller...
  • Page 59: Network Management

    RADIUS Server Address: IP address of the first RADIUS server. 2nd RADIUS Server Address: IP address of the second RADIUS server. 3.3 Network Management In order to enable network management of the Gateway Controller, proper network configuration is required. To do this, click the folder Network Management from the left column and then the following screen page appears.
  • Page 60: Network Configuration

    3.3.1 Network Configuration Click the option Network Configuration from the Network Management menu and then the following screen page appears. MAC Address: This view-only field shows the unique and permanent MAC address pre-assigned to the Gateway Controller. You cannot change the Gateway Controller’s MAC address. Configuration Type: There are two configuration types that users can select from the pull-down menu;...
  • Page 61 parameter is 0.0.0.0, which means no gateway exists and the network management station and Gateway Controller are on the same network. DNS Server 1 IP Address: Specify IP Address for Domain Name System (DNS) Server 1. DNS Server 2 IP Address: Specify IP Address for Domain Name System (DNS) Server 2. Smart Home Server: By default, DHCP server plays a role in gateway.
  • Page 62: System Service Configuration

    Source Binding state: Enable or disable IP source binding. State: Disable or enable IP/IPv6 Address: Specify the IP address for source binding. NOTE: This Gateway Controller also supports auto-provisioning function that enables DHCP clients to automatically download the latest Firmware and configuration image from the server. For information about how to set up a DHCP server, please refer to APPENDIX 3.3.2 System Service Configuration...
  • Page 63: Time Server Configuration

    Telnet Port: Specify the desired TCP port number for the Telnet console. The default TCP port number of the Telnet is 23. System Time Out: Specify the desired time that the Managed Switch will wait before disconnecting an inactive console/telnet. Specifying “0” means an inactive connection will never be disconnected. Click the “OK”...
  • Page 64: Device Community

    value is from 1 hours to 24 hours. Time Zone: Select the appropriate time zone from the pull-down menu. Daylight Saving Time: Disabled, recurring, date Click the “OK” button to apply the settings. 3.3.5 Device Community Click the option Device Community from the Network Management menu and then the following screen page appears.
  • Page 65: Trap Destination

    Current: This shows the number of current community agents. Total: This shows the total number of the community agents. Max: This shows the maximum number available for configuration. The maximum number is 3. Account State: Enable or disable the selected account. Community: Specify the community name, up to 20 alphanumeric characters.
  • Page 66: Trap Configuration

    Click the “OK” button to apply the settings. 3.3.7 Trap Configuration Click the option Trap Configuration from the Network Management menu and then the following screen page appears. Cold Start Trap: Select Disabled or Enabled for the SNMP trap. Warm Start Trap: Select Disabled or Enabled for the SNMP trap. Authentication Failure Trap: Select Disabled or Enabled for the SNMP trap.
  • Page 67: Switch Management

    Log server: Select Disabled or Enabled for the Log server. SNTP Status: View-only filed for the SNTP status. Log server IP: Set up the first Log server’s IP address. Log server IP2: Set up the second Log server’s IP address if needed Log server IP3: Set up the third Log server’s IP address if needed.
  • Page 68: Switch Configuration

    1. Switch Configuration: Set up address learning aging time and enable or disable Statistics Polling. 2. Broadcast Storm Control: Prevent the Gateway Controller from broadcast storms. 3. Port Configuration: Enable or disable port speed, flow control, etc.. 4. Rate Limit Configuration: Set up Port Rate Limit. 5.
  • Page 69: Broadcast Storm Control

    MAC Address Aging Time: Set up MAC Address aging time manually. Entries in the MAC address table containing source MAC addresses and their associated ports will be deleted if they are not accessed within the aging time. Statistics Polling: Enable or disable Statistics Polling. Click the “OK”...
  • Page 70: Port Configuration

    Storm Rate Bandwidth(bps): Display the current configured storm rate bandwidth. Click the “OK” button to apply the settings. 3.4.3 Port Configuration Click the option Port Configuration from the Switch Management menu and then the following screen page appears. Port Number: Click the pull-down menu to select the port number for configuration. Port State: Enable or disable the current port state.
  • Page 71: Rate Limit Configuration

    3.4.4 Rate Limit Configuration Click the folder Rate Limit Configuration from the left column and then the following screen page appears. Ingress Rate: Click the pull-down menu to set up Port Ingress Rate, on or off. Ingress Limiter: Enter ingress bandwidth for each port (the allowable bandwidth is between 32 and 1000000).
  • Page 72 QoS enables users to assign various grades of network service to different types of traffic, such as multi-media, video, protocol-specific, time critical, and file-backup traffic. Click the option QoS Priority Configuration from the Switch Management menu and then the following screen page appears.
  • Page 73 assigned weight. Queue Weight (Q0:Q1:Q2:Q3): Specify the weight of four queues. 802.1p Priority Map: Assign a tag priority to the specific queue. There are eight priority levels that you can choose to classify data packets. Choose one of the listed options from the pull-down menu for CoS (Class of Service) priority tag values.
  • Page 74 Remarking Remarking Mode: Three options are available, Disabled, 802.1p Remarking, and DSCP Remarking.  802.1p Remarking State: Disable or enable the mapping entry. Rx-802.1p: Specify the 802.1p value to be remarked. New-802.1p: Specify the remarking 802.1p value.
  • Page 75: Vlan Configuration

     DSCP Remarking: Enable or disable DSCP Remarking. State: Disable or enable the mapping entry. Rx-DSCP: Specify the DSCP value to be remarked. New-DSCP: Specify the remarking DSCP value. Click the “OK” button to apply the settings. Note: The VID remarking has higher priority than the other remarking modes. (VID remarking > 802.1p remarking >...
  • Page 76 Preamble Type/LEN PAYLOAD Original frame 802.1q Preamble Type/LEN PAYLOAD FCS TCI/P/C/VID frame PRE Preamble 62 bits Used to synchronize traffic SFD Start Frame Delimiter 2 bits Marks the beginning of the header DA Destination Address 6 bytes The MAC address of the destination SA Source Address 6 bytes The MAC address of the source...
  • Page 77: Port Based Vlan

    3.4.6.1 Port Based VLAN Port-based VLAN can effectively segment one network into several broadcast domains. Broadcast, multicast and unknown packets will be limited to within the VLAN. Port-Based VLAN is uncomplicated and fairly rigid in implementation and is useful for network administrators who wish to quickly and easily set up VLAN so as to isolate the effect of broadcast packets on their network.
  • Page 78 Click New or Edit to add, view and edit current Port Based VLAN setting, and then the following screen page appears. Click Delete to remove a VLAN entity. Name: View-only field that shows the name of the port based VLAN Current/Total/Max: View-only field that shows the name of the port based VLAN.
  • Page 79: Ieee 802.1Q Tag Vlan

    Check the box you want and click “OK” 3.4.6.2 IEEE 802.1q Tag VLAN Click the folder IEEE 802.1Q Tag VLAN from the VLAN Configuration menu and then the following screen page appears. Trunk VLAN table: To edit or apply 802.1Q Tag VLAN settings. VLAN Interface: To globally set up switch VLAN mode and per port VLAN mode.
  • Page 80: Vlan Interface

    Click Edit to view and edit current IEEE 802.1Q Tag VLAN setting and then the following screen page appears. Click OK to make the current VLAN settings effective. Current/Total/Max VLANs: View-only field. Current: This shows the number of currently registered VLAN. Total: This shows the number of total registered VLANs.
  • Page 81: Management Vlan

    802.1q Tag VLAN Mode: Four options are available, Port Based VLAN, IEEE 802.1q VLAN and Port isolation. Mode: To specify VLAN mode for each port. Three options are available, ACCESS, TRUNK, TRUNK NATIVE. Access-VLAN: To specify Access-VLAN ID(PVID) for each port. Trunk-VLAN: To specify Trunk-VLAN ID(802.1q tag) for each port.
  • Page 82: Mirroring Configuration

    CPU VLAN ID: To assign current VID for CPU (management) VLAN Mode: To specify VLAN mode for management VLAN. Three options are available, ACCESS, TRUNK, TRUNK NATIVE. Management Port: To specify port(s) for management. Click the “OK” button to apply the settings 3.4.7 Mirroring Configuration Click the option Mirroring Configuration from the Switch Management menu and then the following screen page appears.
  • Page 83: Filter Configuration

    Source Port: Specify the port(s) to which the traffic will be mirrored from as a source. Click the “OK” button to apply the settings. 3.4.8 Filter Configuration Click the option Filter Configuration from the Switch Management menu and then the following screen page appears.
  • Page 84: Switch Port Status

    1. Switch Port Status: View the current port media type, port state, etc.. 2. Port Counters Rates: This folder includes port traffic statistics (rates), port packet error statistics (rates), and port packet analysis statistics (rates). 3. Port Counters Events: This folder includes port traffic statistics (events), port packet error statistics (events), and port packet analysis statistics (events).
  • Page 85: Port Counters Rates

    Port: The number of the port. Media Type: The media type of the port, either Copper (TX) or Fiber (FX). Port State: This shows each port’s state which can be D (Disabled) or E (Enabled). Disabled: A port in this state cannot receive and forward packets. Enabled: Packets can be forwarded.
  • Page 86: Port Packet Error Statistics (Rates)

    Bytes Received: Total bytes received from each port. Frames Received: Total frames received from each port. Received Utilization: The ratio of each port’s receiving traffic to current port’s total bandwidth. Bytes Sent: The total bytes sent from current port. Frames Sent: The total frames sent from current port. Sent Utilization: The ratio of each port’s sending traffic to current port’s total bandwidth.
  • Page 87: Port Packet Analysis Statistics (Rates)

    Total Errors: The number of total errors occurred. 3.5.2.3 Port Packet Analysis Statistics (Rates) The following screen page appears if you choose Port Counters Rates and then select Port Packet Analysis Statistics (Rates). RX Frames 64 Bytes: 64 bytes frames received. RX Frames 65-127 Bytes: 65-127 bytes frames received.
  • Page 88: Port Traffic Statistics (Events)

    frames sent, and total bytes and clear each row’s statistics. 2. Port Packet Error Statistics (Events): View the number of CRC errors, undersize frames, oversize frames, etc and clear each row’s statistics. 3. Port Packet Analysis Statistics (Events): View each port’s analysis history and clear each row’s statistics.
  • Page 89: Port Packet Analysis Statistics (Events)

    RX CRC Error: The number of packets received with a bad FCS with an integral number of bytes. RX Align Error: The number of packets received without a valid integral number of bytes and an invalid FCS. RX Undersize: Undersize frames received. RX Fragments: Fragment frames received.
  • Page 90: Ieee 802.1Q Tag Vlan Table

    RX Multicast Frames: Good multicast frames received. TX Multicast Frames: Good multicast packets sent. RX Broadcast Frames: Good broadcast frames received. TX Broadcast Frames: Good broadcast packets sent. Clear All: Click “Clear All” button to clear all ports’ statistics. 3.5.4 IEEE 802.1q Tag VLAN Table Select IEEE 802.1q Tag VLAN Table from the Switch Monitor menu and then the following screen page appears.
  • Page 91: Battery Rom Status

    3.5.6 Battery ROM Status This is to show the information regarding the battery connected. Click the Battery ROM Status in Switch Monitor folder and then the following screen page appears. Vendor Name: The manufacturer who make the battery. Serial Number: An identification number for the battery. Date Code: The date of manufacture.
  • Page 92: Mqtt Configuration

    3.7 MQTT Configuration 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.
  • Page 93 Total: This shows the number of total registered accounts. Max: This shows the number of maximum number available for registration. The default maximum number is 5. Enable: Check to enable MQTT function or vice versa. The default setting is disable. Clean Session: The clean session flag indicates the broker, whether the client wants to establish a persistent session or not.
  • Page 94: Z-Wave

    TLS-PSK Enable: 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. Identity: Specify a name to the Identity, up to 127 alphanumeric characters. PSK Key: Enter the desired user password, up to 127 alphanumeric characters.
  • Page 95 Add Node: Click to turn the controller into Inclusion Mode. Under Inclusion mode, the Gateway Controller is allowed to bring a device into a network. The Inclusion Mode will time out after 120 seconds. It also can be manually stopped using “Abort” button. Once a new device is successfully included, the Inclusion Mode stops.
  • Page 96: Adding And Removing The Controller In An Existing Network

    Note: The Z-Wave LED turns blinking green when clicking Add Node, Remove Node, Remove Failed Node or Replace Failed Node. The Z-Wave LED turns off when clicking Initiate or Reset. If this controller is the primary controller for your network, resetting it will result in the nodes in your network being orphaned and it will be necessary after the reset to exclude and re-include all of the nodes in the network.
  • Page 97: Assigning The Controller As An Sis

    3. After the other controller is successfully included, click “Add Node” again. 4. Turn the other controller into “Learn Mode” again. 5. The controller begins to exchange protocol data with the other controller in the same network. 3.8.1.3 Assigning The Controller as an SIS The controller is included as a Secondary controller by a Primary Controller.
  • Page 98 Secure: Shows security status for each node. The status showing “secured” indicates that the node is a security enabled Z-Wave Plus product and successfully secured. The status showing “unsecured” indicates that the node is not a security enabled Z-Wave Plus product. The status showing “secure- failed”...
  • Page 99: Notification Settings

    Firmware Version List Target 1: SDK middleware version. Target 2: The firmware version. For example, The Version field shows 100 (stand for 1.00) and the Sub Version shows 0. The value of two fields shown can be converted into this format --- 1.00.00. Target 3: Reserved field for future application Version:The major version shown.
  • Page 100 V1 Alarm Type: Specify which alarm is being requested. V1 Alarm Level: Shows the alarm level that is application specific. Notification Type: Specify the type of the current report. Notification Status: Click drop-down arrow to determine unsolicited messages must be disabled or enabled for the specified Notification Type.
  • Page 101 Notification Type: Shows the type of the current report. Event: Shows the event of the current report. The details of notification type & event are shown as below Notification Type Event Event Parameter(s) Smoke 0x01 Event /Cleared 0x00 - Event identifier for the event Alarm which is no more active.
  • Page 102 Heat 0x04 Event /Cleared 0x00 - Event identifier for the event Alarm which is no more active. - If no Event Parameter is provided, there are no active events for the specified Notification Type. Overheat detected 0x01 Node Location Report (Node Naming and Location Command Class) Overheat detected,...
  • Page 103 Command Class V1) Manual Not Fully Locked 0x07 Operation RF Not Fully Locked 0x08 Operation Auto Lock Locked Operation 0x09 Auto Lock Not Fully 0x0A Operation Lock Jammed 0x0B All user codes deleted 0x0C Single user code deleted 0x0D New user code added 0x0E New user code not added due 0x0F...
  • Page 104 Access 0x06 Barrier Sensor Not Detected/ 0x49 (1 byte) Control Supervisory Error 0x00 = Sensor not defined 0x01-0xFE = Sensor ID Barrier Sensor Low Battery 0x4A (1 byte) Warning 0x00 = Sensor not defined 0x01-0xFE = Sensor ID Barrier detected short in Wall 0x4B Station wires Barrier associated with non-Z-...
  • Page 105 Load error 0x09 Replace battery soon 0x0A Replace battery now 0x0B Battery is charging 0x0C Battery is fully charged 0x0D Charge battery soon 0x0E Charge battery now! 0x0F Unknown Event 0xFE Notification Type Event Parameter(s) System 0x09 Event /Cleared 0x00 - Event identifier for the event which is no more active.
  • Page 106 Notification Type Event Event Parameter(s) Appliance 0x0C Event /Cleared 0x00 - Event identifier for the event which is no more active. - If no Event Parameter is provided, there are no active events for the specified Notification Type. Program Started 0x01 Program in progress 0x02...
  • Page 107 provided, there are no active events for the specified Notification Type. Siren Active 0x01 Unknown Event 0xFE Notification Type Event Parameter(s) Water Valve 0x0F Event /Cleared 0x00 - Event identifier for the event which is no more active. - If no Event Parameter is provided, there are no active events for the specified Notification Type.
  • Page 108: Power Level Settings

    Gas Alarm 0x12 Event /Cleared 0x00 - Event identifier for the event which is no more active. - If no Event Parameter is provided, there are no active events for the specified Notification Type. Combustible Gas Detected 0x01 Node Location Report (Node Naming and Location Command Class) Combustible Gas Detected,...
  • Page 109: Association Settings

    Timeout: The time in seconds the node should keep the Power level before resetting to NormalPower level. Valid values are 1-255 resulting in timeouts from 1 second to 255 seconds. The test section is used to instruct the destination node to transmit a number of test frames to the specified node ID with the RF power level specified.
  • Page 110 Group: The name of the group given. Maximum Group Members: The devices that can be added to the group at most. Group Members: The current members that are added to the group. Current Active Group: The available is from 1~255. Dynamic Group Information: Shows if the Z-Wave Gateway device performs periodic cache refresh for this node.
  • Page 111: Battery Status

    Member(s): To remove members in a group, choose any node under Member(s) and click “Remove” Endpoint(s): To add members in a group, choose any node under Endpoint(s) and click “Add” 3.8.2.4 Battery Status This is used to show the battery status of a battery operated device. Battery Level: The percentage scale ranging from 0 to 100%.
  • Page 112 Outside Door Handles Mode: The status of each individual outside door handle. Inside Door Handles Mode: The status of each individual inside door handle. Door Condition: The status of the door lock components. Lock Timeout Minutes: The remaining time in minute before the door lock will automatically be locked again.
  • Page 113: User Code Settings

    Lock Timeout Minutes: Set up the time in minute that a door lock must wait before automatically being locked again. The range is 0~255 in minute. Lock Timeout Seconds: Set up the time in second that a door lock must wait before automatically being locked again.
  • Page 114: Sensor Multilevel Settings

    Interval Seconds: Set up the wake up interval in second of a device. Valid value is 0~16777215 in second. Note: If a newly-added node is a sleeping node, the initial status of a node would be sleeping once included. The controller makes attempts to set the wake up interval of the node as 2 minutes. However, the node will remain its original wake up interval if the controller fails to change its wake up interval.
  • Page 115 Sensor Type: Specify what type of sensor this command originates from. Click the drop-down arrow and pick designated one. Sensor Scale: To indicate what unit the sensor uses. Click the drop-down arrow and pick designated one. The details of sensor type and scale are shown below: Sensor Type Sensor Scale Celsius (C)
  • Page 116 Carbon Dioxide CO -level Ppm (Parts/million) m3/h (cubic meter/hour) Air Flow cfm (cubic feet/minute) l (liter) Tank capacity (cubic meter) gallons m (meter) Distance feet Percentage Value Degrees relative to north pole of standing eye Angle Position view Degrees relative to south pole of standing eye view rpm (revolutions per minute) Rotation...
  • Page 117: Basic Settings

    Soil Reactivity pH(acidity) Soil Salinity mol/m (mole per cubic meter) Heart Rate Bpm(beats/minute) Systolic mmHg(Upper #) Blood Pressure Diastolic(lower#) Muscle Mass Fat Mass Bone Mass Total Body Water, TBW Basic Metabolic Rate, BMR J(joule) Body Mass Index, BMI BMI Index Acceleration, X-axis Acceleration, Y-axis Acceleration, Z-axis...
  • Page 118: Switch Multilevel Settings

    Click On(Enable) or Off(Disable) for a device. Current State: Shows the current state is set “On” or “Off”. 3.8.2.11 Switch Multilevel Settings This is used to control devices with multilevel capability. Primary Switch Type: It shows the primary device functionality. Secondary Switch Type: It shows the secondary device functionality.
  • Page 119: Meter Settings

    0x03 Close Open 0x04 Counter-Clockwise Clockwise 0x05 Left Right 0x06 Reverse Forward 0x07 Pull Push 0x08-0x1F Reserved Level: This is used to set a value in a supporting device. The details of value are shown as below: Value Level State 0 (0x00) 1..99 (0x01..0x63) Lowest non-zero level ..
  • Page 120 Supported Meter Type: Shows what type of metering device originates from. Supported Units: The unit available for the Meter Type used. The supported meters and units are shown as below: Meter Type Unit KVAh Electric Meter Pulse Count Power Factor Cubic Meters Gas Meter Cubic Feet...
  • Page 121: Thermostat Setpoint Settings

    Meter Type: Shows the current meter type. Current State: Shows the current status of the energy measured. Rate Type: Shows if it is import or export values to be read. The Rate Type shown “Import” is an indication that the Meter Value is a consumed measurement. In contrary when the Rate Type is shown “Export”...
  • Page 122: Thermostat Mode Settings

    Scale: Click drop-down box to choose the unit used for temperature. Celsius and Fahrenheit are available. Value: Specify the actual setpoint value. The example of value is shown as below: Raw value Signed 8 bit Raw value Signed 16 bit Raw value Signed 32 bit (hex)
  • Page 123: Configuration Settings

    the FURNACE set point. Dehumidification - The system will cycle cooling in relation to the room and the DRY set point temperature in order to remove moisture from ambient. Humidification - Moist Air, heating or cooling will be activated according to MOIST the MOIST set point.
  • Page 124: Z-Wave Utility

    box is checked, the Parameter Number and the Value fields must be ignored. Uncheck to have the specified Parameter Number must assume the value specified by the Value field. Click “SET” to apply settings. 3.9 Z-Wave Utility This is used to upgrade, backup or save Z-Wave configuration. Select Z-Wave Utility folder and the following screen page appears.
  • Page 125: Z-Wave Upgrade

    Start-up-config: Back up the data same as last saved data. Device Configuration to Local File: Click Backup and define the route where you intend to save data. Restore: Click Browse, select the designated data and then click Restore. 3.9.2 Z-Wave Upgrade The Gateway Controller has both built-in TFTP and FTP clients.
  • Page 126: Z-Wave Save Configuration

    File Location: Enter the specific path and filename within the File Server. Update Network: Click to update Z-Wave network. Restart Network: Click to restart Z-Wave network. Wake Up Interval: Specify the interval in second to wake up sleeping devices. The default value is 0. Click Put to start the upload process and transmit files to the server.
  • Page 127: Ping

    1. Ping: Ping can help you test the network connectivity between the Gateway Controller and the host. You can also specify count s, timeout and size of the Ping packets. 2. Event Log: Event log can keep a record of system’s log events such as system warm start, cold start, link up/down, user login/logout, etc.
  • Page 128: Event Log

    You can also specify count s, timeout and size of the Ping packets. Click Start to start the Ping process. 3.10.2 Event Log Event log keeps a record of user login and logout timestamp information. Select Event Log from the System Utility menu and then the following screen page appears.
  • Page 129: Ftp/Tftp Upgrade

    To backup or restore data, click HTTP Upgrade Config Type There are three types of Config Type: Running-config, Default-config and Start-up-config Running-config: Back up the data you’re processing Default-config: Back up the data same as factory setting. Start-up-config: Back up the data same as last saved data. Device Configuration to Local File: Click Backup and define the route where you intend to save data.
  • Page 130 Protocol: Select the preferred protocol, either FTP or TFTP. File Type: Select the file to process, either Firmware or Configuration. Config Type: Choose “Running-config”, “Default-config” or “Start-up-config” which the config file will be saved or restored to Server Address: Enter the specific address of the File Server. User Name: Enter the specific username to access the File Server.
  • Page 131: Load Factory Settings

    3.10.5 Load Factory Settings Load Factory Settings will set all configurations of the Gateway Controller back to the factory default settings, including the IP and Gateway address. This function is useful when network administrators would like to re-configure the system. A system reset is required to make all changes effective after Load Factory Setting.
  • Page 132: Load Factory Settings Except Network Configuration

    3.10.6 Load Factory Settings Except Network Configuration Load Factory Settings Except Network Configuration will set all configurations of the Gateway Controller back to the factory default settings. However, IP and Gateway addresses will not restore to the factory default. Load Factory Settings Except Network Configuration is very useful when network administrators need to re-configure the system “REMOTELY”...
  • Page 133: Reset System

    Click the “OK” button to save changes or running configurations to Flash. 3.12 Reset System After any configuration changes, Reset System can make changes effective. Select Reset System from the Main menu and then the following screen page appears. Click the “Reboot” button to restart the Gateway Controller. 3.13 Logout Select Logout from the Main menu and then the following screen page appears.
  • Page 134: Appendix A: Dhcp Auto-Provisioning Setup

    Click “OK” to log out. APPENDIX A: DHCP Auto-Provisioning Setup Networking devices, such as switches or gateways, with DHCP Auto-provisioning function allow you to automatically upgrade firmware and configuration at startup process. Before setting up DHCP Server for auto-upgrade of firmware and configuration, please make sure the device that you purchased supports DHCP Auto-provisioning.
  • Page 135 Step 2. Set Up Auto Provision Server  Update DHCP client Linux Fedora 12 supports “yum” function by default. First of all, update DHCP client function by issuing “yum install dhclient” command.  Install DHCP server Issue “yum install dhcp” command to install DHCP server.
  • Page 136  Copy dhcpd.conf to /etc/dhcp/ directory Copy dhcpd.conf file provided by the vendor to /etc/dhcp/ directory. Please note that each vendor has its own way to define auto-provisioning. Make sure to use the file provided by the vendor.  Enable and run DHCP service 1.
  • Page 137 Step 3. Modify dhcpd.conf File  Open dhcpd.conf file in /etc/dhcp/ directory Double-click dhcpd.conf placed in /etc/dhcp/ directory to open it.
  • Page 138  Modify dhcpd.conf file The following marked areas in dhcpd.conf file can be modified with values that work with your networking environment. 1. Define DHCP default and maximum lease time in seconds. Default lease time: If a client does not request a specific IP lease time, the server will assign a default lease time value.
  • Page 139 5. This value is configurable and can be defined by users. 6. Specify the protocol used (Protocol 1: FTP; Protocol 0: TFTP). 7. Specify the FTP or TFTP IP address. 8. Login TFTP server anonymously (TFTP does not require a login name and password). 9.
  • Page 140  Restart DHCP service...
  • Page 141 Every time you modify dhcpd.conf file, DHCP service must be restarted. Issue “killall dhcpd” command to disable DHCP service and then issue “dhcpd” command to enable DHCP service. Step 4. Backup a Configuration File Before preparing a configuration file in TFTP/FTP Server, make sure the device generating the configuration file is set to “Get IP address from DHCP”...
  • Page 142 B. Auto-Provisioning Process This switching device is setting-free (through auto-upgrade and configuration) and its upgrade procedures are as follows: 1. ISC DHCP server will recognize the device when it receives an IP address request sent by the device, and it will tell the device how to get a new firmware or configuration. 2.
  • Page 143: Appendix B: Free Radius Readme

    APPENDIX B: Free RADIUS readme The advanced RADIUS Server Set up for RADIUS Authentication is described as below. When free RADIUS client is enabled on the device, On the server side, it needs to put this file "dictionary.sample" under the directory /raddb, and modify these three files - "users", "clients.conf"...
  • Page 144: Appendix C: Z-Wave Terminology

    APPENDIX C: Z-Wave Terminology Z-Wave Functionality Documentation Description Terminology The process of adding a node to the Z-Wave Inclusion network The process of removing a node from the Z- Exclusion Remove Wave network The process of copying network information Replication Copy from one to another A Z-Wave device capable of managing the...
  • Page 145: Appendix D: Control Command Class Table

    APPENDIX D: Control Command Class Table This section is to demonstrate which commands are used in Section 3.8.4 Node Controller. Section Title Command Class 3.8.4.1 Notification Settings Notification Command Class V.7 3.8.4.2 Power Level Settings Power Level Command Class V.1 3.8.4.3 Association Settings Association Command Class V.2...

Table of Contents