Industriefunkuhren. Technical Manual. NTP Time Server Module with LAN Interface. Model 8029NTS/M. ENGLISH Version:

Transcription

1 Industriefunkuhren Technical Manual NTP Time Server Module with LAN Interface Model 8029NTS/M ENGLISH Version: SET IMAGE (8029) FIRMWARE (8029) Valid for Version: 03.xx Version: 03.xx Version: 01.xx

2 2 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

3 INPORTANT NOTES Version Numbers (Firmware / Description) THE TERM SET DEFINES THE FIXED RELATIONSHIP BETWEEN THE IMAGE VERSION AND THE ASSOCIATED H8 FIRMWARE VERSION. THE FIRST TWO DIGITS OF THE TECHNICAL DESCRIPTION VERSION NUMBER, THE SET VERSION AND THE IMAGE VERSION MUST BE THE SAME! THEY DESIGNATE THE SHARED FUNCTIONAL IDENTITY BETWEEN DEVICE, SOFTWARE AND TECHNICAL DESCRIPTION. THE VERSION NUMBER OF THE IMAGE AND THE H8 SOFTWARE CAN BE READ IN THE WEBGUI OF TIME SERVER 8029NTS/M (SEE CHAPTER DEVICE INFORMATION AND CHAPTER HARDWARE INFORMATION). THE TWO DIGITS AFTER THE DOT IN THE VERSION NUMBER DESIGNATES CORRECTIONS TO THE FIRMWARE AND/OR DESCRIPTION WHICH HAVE NO EFFECT ON FUNCTIONALITY. Downloading Technical Manuals All current manuals of our products are available free of charge via our homepage on the Internet. Homepage: info@hopf.com Symbols and Characters Operational Reliability Disregard may cause damages to persons or material. Functionality Disregard may impact function of system/device. Information Notes and Information. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

4 SERVICE RELIABILITY Safety regulations The safety regulations and observance of the technical data serve to ensure trouble-free operation of the device and protection of persons and material. It is therefore of utmost importance to observe and compliance with these regulations. If these are not complied with, then no claims may be made under the terms of the warranty. No liability will be assumed for any ensuing damage. Safety of the device This device has been manufactured in accordance with the latest technological standards and approved safety regulations The device should only be put into operation by trained and qualified staff. Care must be taken that all cable connections are laid and fixed in position correctly. The device should only be operated with the voltage supply indicated on the identification label. The device should only be operated by qualified staff or employees who have received specific instruction. If a device must be opened for repair, this should only be carried out by employees with appropriate qualifications or by. Before a device is opened or a fuse is changed all power supplies must be disconnected. If there are reasons to believe that the operational safety can no longer be guaranteed the device must be taken out of service and labelled accordingly. The safety may be impaired when the device does not operate properly or if it is obviously damaged. CE-Conformity This device fulfils the requirements of the EU directive 2004/108/EC "Electromagnetic Compatibility" and 2006/95/EC "Low Voltage Equipment". Therefore the device bears the CE identification marking (CE = Communautés Européennes = European communities) The CE indicates to the controlling bodies that the product complies with the requirements of the EU directive - especially with regard to protection of health and safety for the operator and the user - and may be released for sale within the common markets. 4 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

5 TABLE OF CONTENTS Contents Page 1 NTP Time Server Module 8029NTS/M Module Description Installation Variants (Examples) Installation and Removal of the Module Functional Overview of the Front Panel Elements Reset-(Default) Button NTP Status LEDs (NTP/Stratum/Accuracy) USB-Port LAN Interface ETH MAC-Address for ETH Function Principle Module Behaviour Boot Phase NTP Adjustment Process (NTP/Stratum/Accuracy) Reset-(Default) Button Firmware Update Activation of Functions by Activation Keys Connection LAN Interface ETH Commissioning General Procedure Switching on the Operating Voltage Establish the Network Connection via Web Browser Network Configuration for ETH0 via LAN through hmc HTTP/HTTPS WebGUI Web Browser Configuration Interface Quick Configuration Requirements Configuration Steps General Introduction LOGIN and LOGOUT as User Navigation via the Web Interface Enter or Changing Data Plausibility Check during Input Description of the Tabs GENERAL Tab NETWORK Tab Host/Nameservice Hostname Default Gateway NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

6 TABLE OF CONTENTS DNS Server 1 & Network Interface ETH Default Hardware Address (MAC) Customer Hardware Address (MAC) DHCP IP Address Network Mask Operation Mode Routing (Activation Key necessary) Management (Management-Protocols HTTP, SNMP etc.) Time Synchronization Protocols (Time Protocols NTP, SNTP etc.) SINEC H1 time datagram (Activation Key necessary) NTP Tab System Info Kernel Info Peers Server Configuration Synchronization Source (General / Synchronization source) NTP Syslog Messages (General / Log NTP Messages to Syslog) Crystal Operation Broadcast / Broadcast Address Broadcast / Authentication / Key ID Additional NTP SERVERS Extended NTP Configuration Suppression of unspecified NTP Outputs Restart NTP Configuring the NTP Access Restrictions NAT or Firewall Blocking Unauthorised Access Allowing Client Requests Internal Client Protection / Local Network Threat Level Addition of Exceptions to Standard Restrictions Access Control Options Symmetric Key Why Authentication? How is Authentication used in the NTP Service? How is a key created? How does authentication work? Autokey ALARM Tab (Activation Key necessary) Syslog Configuration Configuration SNMP Configuration / TRAP Configuration Alarm Messages DEVICE Tab Device Information Hardware Information Restoring the Factory Defaults Settings Restoring saved Customer Settings (Custom Defaults) Restarting the Module (Reboot Device) Image Update & H8 Firmware Update Upload of User SSL-Server-Certificate (Upload Certificate) Customized Security Banner Product Activation by means of Activation Keys Diagnostics Function Passwords (Master/Device) Downloading Configuration Files / SNMP MIB SYNC SOURCE Tab Time and Status Select Sync Source Time Difference Time (Time Zone Offset to UTC) SyncON / SyncOFF Timer / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

7 TABLE OF CONTENTS Reset Time Evaluation Sync Source Errors Sync Protocol error Sync Channel error SSH and Telnet Basic Configuration Support from the hopf Company Maintenance Technical Data Factory Defaults of Time Server 8029NTS/M Network NTP ALARM DEVICE Sync Source Glossary and Abbreviations NTP-specific Terminology Tally Codes (NTP-specific) Time-specific expressions Abbreviations Definitions DHCP (Dynamic Host Configuration Protocol) NTP (Network Time Protocol) SNMP (Simple Network Management Protocol) TCP/IP (Transmission Control Protocol / Internet Protocol) Accuracy & NTP Basic Principles List of RFCs List of Open Source Packages Used NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

8 TABLE OF CONTENTS 8 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

9 NTP TIME SERVER MODULE 8029NTS/M 1 NTP Time Server Module 8029NTS/M Module 8029NTS/M is a compact NTP Time Server for the integration in clock systems or rather in singal converters. Based on the fed time information the module turns into a highaccurate NTP Stratum 1 Time Server for the worldwide used time protocol NTP (Network Time Protocol). This Time Server Module is usded for the synchronization of computes and industrial networks. The NTP Time Server module supports the following network synchronization protocols: NTP (incl. SNTP) Daytime Time SINEC H1 time datagram (Activation Key necessary) Its operation is guaranteed by just supplying the Module 8029NTS/M with power and providing appropriate time information formthe internal synchronization. Both are usually carried out in the basis system the Module 8029NTS/M is integrated in. However the module can also be used in an independent signal converter. The Module 8029NTS/M requires approx. 2-3 minutes for a successful and module s internal time synchronization, depending on the fed synchronization signal. As the module has no internal back-up clock and in order to receive an internal time for the time generation, it is required to synchronize the module after a reset or a power failure again. The respective NTP status of the module is indicated via three LEDs in the front panel. This allows an easy identification of the current operation status or any fault. Due to its compact size, the Time Server 8029NTS/M is easy to integrateand characterized by its easy and simple operation, although it offers a broad range of functions. Some of the practice-oriented functionalities are: Complete parameterisation via protected WebGUI access All required settings for operation can be executed via a password proteded WebGUI also giving an overview of the status of the Time Server 8029NTS/M. Automatic handling of the leap second Insertion of a leap second in UTC time is automatically recognised and executed by the the Time Sever 8029NTS/M. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

10 NTP TIME SERVER MODULE 8029NTS/M A superior security is guaranteed via available coding procedures such as symmetric keys, autokey and access restrictions and deactivation of non-used protocols. Diffferent Managemenet and Monitoring Functions are availabe as options (e.g. SNMP, SNMP-Traps, notification, Syslog-messages including MIB II and private Enterprise MIB). Currently the Time Server 8029NTS/M offers following unlockable functions: Alarming After activation SNMP, Syslog and notification are available in order to monitor the system condition. Furthermore, a MIB II and private Enterprise MIB are provided allowing realization of management functions. Routing This function allows entering routes in the Time Server 8029NTS/M for spezial network requirements. SINEC H1 time datagram This function allows paramerization of the SINEC H1 time datagram and output via the LAN interface. A few other basic functions of the Time Server 8029NTS/M: The Time Server 8029NTS/M operates as NTP Server with Stratum 1 Easy operation via WebGUI NTP Status LEDs on the front panel Completely maintance-free system Software supplied: hmc Remote Software for the operating systems: o Microsoft Windows NT/2000/XP/VISTA/7 (32/64 Bit) o Microsoft Windows Server 2003/2008 (32/64 Bit) o Linux (32/64 Bit) o Oracle Solaris SPARC/x86 o IBM AIX (ab Version 5.2) o HP-UX 11i (RS232 support only for PA-RISC architecture) 10 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

11 NTP TIME SERVER MODULE 8029NTS/M Overview of the functions of the network Time Server 8029NTS/M: Ethernet Interface Auto negotiate 10 Mbps half-/full duplex 100 Mbps half-/full duplex Time Protocols NTPv4 Server NTP Broadcast Mode NTP Multicast Mode NTP Client for additional NTP Servers (redundancy) SNTP Server NTP Symmetric Key Encryption NTP Autokey Encryption NTP Access Restrictions PPS Time Source SINEC H1 time datagram (Activation Key necessary) RFC-867 DAYTIME Server RFC-868 TIME Server Network Protocols HTTP/ HTTPS DHCP Telnet SSH SNMPv2c, SNMP Traps (MIB II, Private Enterprise MIB) (Activation Key necessary) NTP (including SNTP) SINEC H1 time datagram (Activation Key necessary) Configuration Channel HTTP/HTTPS WebGUI (browser-based) Telnet SSH External LAN configuration tool (hmc Network-Configuration-Assistant) Additionally Freatures notification (Activation Key necessary) Syslog messages to external syslog server (Activation Key necessary) Routing (Activation Key necessary) Update via TCP/IP Failsafe Watchdog circuit System management Customized security banner NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

12 MODULE DESCRIPTION 2 Module Description The NTP Time Server Module 8029NTS/M is a complete multi-processor embedded-linux system. Usually the module is integrated as a NTP Time Server extension in hopf clock systems at the factory. The module is supplied with power, the necessary time information for its synchronisation with the system time and with the system reset, if any, via an internal plug-in connection. 2.1 Installation Variants (Examples) The module can be equipped with panels for the integration in different housings and system variants. Module 8029NTS/M for the integration in 19" systems with 3U/4HP panels Module 8029NTS/M with front panel for the integration in DIN Rail housings (example) 12 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

13 MODULE DESCRIPTION 2.2 Installation and Removal of the Module The module is supplied with power, the necessary time information for its synchronisation with the system time and with the system reset, if any, via an internal plug-in connection. For service and reapir purposes the module can be removed from the device. The module does not support HOT-PLUG In case an installation or removal of the module should be necessary the device in which the moule is integrated in must be disconnected from power. 2.3 Functional Overview of the Front Panel Elements This chapter describes the individual front panel elements and their functions Reset-(Default) Button The Reset-(Default) Button is accessible with a thin objective through the small drilling in the front panel next to the "Reset" inscription" (see chapter 4.3 Reset-(Default) Button) NTP Status LEDs (NTP/Stratum/Accuracy) NTP-LED (Green) On Off Stratum1-LED (Green) NTP sewrvice of the Time Server 8029NTS/M Standard, running Not running On Stratum 1 Flashes Stratum 2-15 Off Accuracy-LED (Green) On Flashes Off The NTP service of the Time Server 8029NTS/M works with: Stratum 16 (no synchronization of NTP Clients) The NTP service of the Time Server 8029NTS/M works with accuracy of: high medium low USB-Port On specific problems the USB connection can be used for a system recovery after consulting the hopf Support. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

14 MODULE DESCRIPTION LAN Interface ETH0 10/100-LED (Green) Off On lnk/act-led (Yellow) Off On Flashes Description 10 MBit Ethernet detected 100 MBit Ethernet detected Description No LAN connection to a network LAN connection available Network activity at ETH0 (transmission / reception) Pin No. Assignment 1 Tx+ 2 Tx 3 Rx+ 4 Not in use 5 Not in use 6 Rx 7 Not in use 8 Not in use MAC-Address for ETH0 Each LAN interface is clearly identifiable on the Ethermet via a unique MAC Address (hardware address). The MAC address given for the LAN interface ETH0 can be read in WebGUI of the appropriate board or be determined via the hmc Network Configuration Assisant. The MAC address is uniquely assigned for each LAN interface by the company hopf Elektronik GmbH. The factory set MAC address for the Time Server 8029NTS/M is stated on a sticker directly placed on the module. MAC addresses begin with 00:03:C7:xx:xx:xx. 14 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

15 FUNCTION PRINCIPLE 3 Function Principle This chapter describes the functional principle of the Time Server 8029NTS/M and the internal relations between the individual function groups. The Time Server Modul 8029NTS/M is a multi-processor system. The structrue allows the following mode of operation: The module receives evaluabe time information within the complete system (clock system). The time basis of the module is synchronized with high precision onto this time information. Based on this internal time information standardized time information is supplied to the NTP service enabling the module to operate as a high-precises Stratum 1 NTP Time Server. In this module Sync Source describes the time information provided to the module as well as the module- internal evaluation up to the successful snychornization of its internal time basis. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

16 FUNCTION PRINCIPLE External Synchronization Signal (Sync Source Input) Usually the status of the respective Sync Source is supplied in the synchronization signal as well. Synchronisation of the Module (Clock) Based on the system-internal provided synchronization signal and the status information contained therein the module is self-synchronized. This synchronization status is indicatedin in the Web-GUI (GENERAL - SYNC SOURCE STATUS). NTP Adjustment Based on the time information synchronized in the module the NTP service is supplied and controlled with standardized time information. The status of the NTP service (time, date, stratum and accuracy) is indicated in the WebGUI (GENERAL NTP TIME STATUS). Modul Status All information of the module required for an optimum operating state are recorded and evaluated centrally (GENERAL MODULE OVERVIEW). This concept allows the use of different synchronization signals to provide the module with time information. The format supplied to the module needs to be parameterized in the WebGUI of the module. Although the fed synchronization signal might fail the module can continuously and independently snychronize the NTP service based on the internal time information. A differential setting of this behaviour can be parameterized in the WebGUI. The module offers a variety of furhter settings in order to adopt the behaviour of the Time Server to the respective requirements. 16 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

17 MODULE BEHAVIOUR 4 Module Behaviour This chapter describes the behaviour of the module in special operational phases and conditions. 4.1 Boot Phase The boot process of the Time Server 8029NTS/M starts after turning on the system or a reset. During the boot process the Module 8029NTS/M boots its LINUX operation system and is therefore not available via LAN. The end of the boot process is reached when the green NTP LED is shining and thereby indicates that the NTP service on Module 8029NTS/M has been started and enabled. The boot process lasts approx minutes. 4.2 NTP Adjustment Process (NTP/Stratum/Accuracy) NTP is a regulation process. After start of the NTP services, automatically processed during booting, the Time Server 8029NTS/M requires approximately 5-10 minutes after synchronization of the Sync Source until NTP is set to the high accuracy of the Sync Source and reaches the optimized operation condition of STRATUM = 1 and ACCURACY = High. The decisive factors here are accuracy of the Sync Source (Accuracy) and the appropriate synchronization condition of the Sync Source. 4.3 Reset-(Default) Button The Time Server 8029NTS/M can be reset by the Reset-(Default) Button behind the front panel of the board. The Reset-(Default) Button is accessible with a thin objective through the small drilling in the front panel. The button triggers different functions depending on how long it is pressed: Duration Function < 1 sec. No action 1-9 sec. After releasing a hardware reset is triggered in the module sec. After releasing a CUSTOM DEFAULT followd by a REBOOT is triggered after approx. 10 seconds. >= 20 sec. After releasing a FACTORY DEFAULT followd by a REBOOT is triggered after approx. 10 seconds If the user saves no CUSTOM DEFAULT via the WebGUI, a FACTORY DEFAULT is triggered instead. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

18 MODULE BEHAVIOUR 4.4 Firmware Update The Time Server 8029NTS/M is a multi processor system. For this reason a firmware update always consists of a so called Software SET including up to two (2) program releases defined by the SET version needed to be loaded into the board. Module 8029NTS/M: 1x Image Update 1x H8 Update An update is a critical process. The device should not be turned off during the update and the network connection to the device not be interrupted. All programs of a SET needed to be uploaded to ensure a defined operation condition. The progam releases assigned to a SET version may be taken from the release notes of the software SETs of the Time Sever 8029NTS/M. The general process of a software update of Module 8029NTS/M is described below: H8 Update 1. Log in as Master in WebGUI of the board. 2. Select in the Device tab the menu item H8 Firmware Update. 3. Select the file with the file extension.mot for Module 8029NTS/M via the selection window. 4. The selected file is shown in the selection window. 5. The update process is started with the button Upload now. 6. In WebGUI the successful file transfer to the Module is indicated. 7. Now the update of the board automatically starts after a few seconds. 8. After successful update the board automatically reboots. 9. After approx. 2 minutes the H8 update process is finished and the board is again accessible via WebGUI. 18 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

19 MODULE BEHAVIOUR Image Update 10. Log in as Master in WebGUI of the board. 11. Select in Device tab the menu item Image Update. 12. Select the file with the file.img via the selection window. 13. The selected file is shown in the selection window. 14. The update process is started with the button Upload now. 15. In WebGUI the successful file transfer and writing to the Module is indicated. 16. In WebGUI the successful update is indicated after 2-3 minutes with the request to release a reboot of the board. 17. After activation and successful reboot of the board the image update process is finished. 4.5 Activation of Functions by Activation Keys Currently the Time Server 8029NTS/M offers three functions that require an "Activation Key". These functions are only available after entering a valid activation key related to the serial number of the Module 8029NTS/M (not the serial number of the overall system). The activation of such function(s) can be done by default and also later by the user if required. The input and display is done in the tab "Device" under the menu item "Product Activation". These functions are: Alarming After activation the functions SNMP, Syslog and notification are available in order to monitor the system condition. Furthermore a MIB II and private enterprise MIB are provided with which management functions can be realized. Routing This function allows entering routes in the the Time Server 8029NTS/M for spezial network requirements. SINEC H1 time datagram This function allows paramerization of the SINEC H1 datagram and output via the LAN interface. The settins for activation keys (e.g. an entered activation key) are neither modified nor influenced by the functions FACTORY DEFAULTS and CUSTOM DEFAULTS. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

20 CONNECTION LAN INTERFACE ETH0 5 Connection LAN Interface ETH0 10/100-LED (Green) Off On lnk/act-led (Yellow) Off On Flashes Description 10 MBit Ethernet detected 100 MBit Ethernet detected Description No LAN connection to a network LAN connection available Network activity at ETH0 (transmission / reception) Pin No. Assignment 1 Tx+ 2 Tx 3 Rx+ 4 Not in use 5 Not in use 6 Rx 7 Not in use 8 Not in use The network connection is made via a LAN cable and RJ45 plug (recommended cable type: CAT5 or better). 20 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

21 COMMISSIONING 6 Commissioning This chapter describes commissioning of the Time Server 8029NTS/M. 6.1 General Procedure Overview of the general commissioning procedure: Finish the installation process completely Switch on the device Wait until the booting phase is finsihed (Duration approx. 2 min. finished when the green NTP LED is lit on) Using the SEARCH Function of the hmc - Network Configuration Assistant in order to access the Time Server 8029NTS/M and set the basis LAN parameters (e.g. DHCP). Afterwards connect to the WebGUI of the Time Server 8029NTS/M via Web browser OR connect directly with the factory default IP-address ( ) to the WebGUI of the Time Server 8029NTS/M via Web browser Log in as "master" Change default passwords for "master" and "device" In the DEVICE tab Set all required LAN parameters (e.g. entry of DNS server) in NETWORK tab if necessary Check current settings in NTP tab and modify according to individual needs as necessary Verify respectively Parametrize following values of the Sync Source in SYNC SOURCE tab: o Used Sync Source o Set the local difference time to UTC For modules, integrated in clock systems in the factory, these settings were already performed by thehopf company. Check for Sync Source Error in tab SYNC SOURCE Parametrize optional functions e.g. SNMP or SINEC H1 time datagram If all base settings are carried out correctly and the set Sync Source supplies the time information with the appropriate accuracy, the GENERAL tab should look like this after approx. 30 min. (usually considerably faster): NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

22 COMMISSIONING 6.2 Switching on the Operating Voltage The Time Server 8029NTS/M has no own switch for the power supply. The Time Server 8029NTS/M is activated by switching on the device in which it is integrated in. 6.3 Establish the Network Connection via Web Browser Ensure that the network parameters of the Time Server 8029NTS/M are configured in accordance with the local network before connecting the device to the network. Connecting a network to an incorrectly configured Time Server 8029NTS/M (e.g. duplicate IP address) may cause interference on the network. The Time Server 8029NTS/M is supplied with a static IP-address (equivalent to the factory default setting). IP-address: Network mask: Gateway: not set In case it is not known whether the Time Server 8029NTS/M with a Factory Default setting causes problems in the network, the basis network parameterization should be executed via a "Peer to Peer" network connection. Request the required network parameters from your network administrator if those are unknown. The network connection is made via a LAN cable and RJ45 plug (recommended cable type: CAT5 or better). 6.4 Network Configuration for ETH0 via LAN through hmc After connecting the system to the power supply and creating the physical network connection to LAN interface of the Time Server 8029NTS/M, the device can be searched for on the network via the hmc (hopf Management Console). Then the base LAN parameters (IP address, netmask and gateway or DHCP) may be adjusted in order to allow accessibility of the Time Server 8029NTS/M for other systems on the network. The SEACH Function of the hmc - Network Configuration Assistant requires for location and recognition of the wished Time Server 8029NTS/M the hmc-computer in the same SUB Net. 22 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

23 COMMISSIONING The base LAN parameters can be set via the hmc integrated Network Configuration Assistant. After a successful start of the hmc Network Configuration Assistant and completed search of the hopf LAN devices, the configuration of the base LAN parameters can be done. The Time Server 8029NTS/M is stated as 8029NTS/M in the Device List. The determination of different Time Server 8029NTS/M (or other products variants) is made via Hardware Address (MAC Address). The factory set MAC address for the Time Server 8029NTS/M is stated on a sticker laterally positioned on the exterior of the housing of the device. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

24 COMMISSIONING For an extended configuration of the Time Server 8029NTS/M through a browser via WebGUI the following base parameters are required: Host Name e.g. hopf8029nts-m Network Configuration Type e.g. Static IP Address or DHCP IP Address e.g Netmask e.g Gateway e.g The hostname must meet the following conditions: The hostname may only contain the characters 'A'-'Z', '0'-'9', '-' and '.'. There should be no distinction between upper-and lower-case letters. The character '.' may only appear as a separator between labels in domain names. The sign '-' must not appear as first or last character of a label. The network parameters being assigned should be pre-determined with the network administrator in order to avoid problems on the network (e.g. duplicate IP address). IP Address (IPv4) An IP address is a 32 bit value divided into four 8 bit numbers. The standard presentation is 4 decimal numbers (in the range ) separated from each other by dots (dotted quad notation). Example: The IP address consists of a leading network ID followed by the host ID. Four common network classes were defined in order to cover different requirements. Depending on the network class, the last one, two or three bytes define the host while the rest define the network (network ID) in each case. In the following text the "x" stands for the host part of the IP address. Class A Networks IP addresses 001.xxx.xxx.xxx to 127.xxx.xxx.xxx There is a maximum of 127 different networks in this class. This allows the possibility to connect a very high number of devices (max ) Example: , (Network 100, Host ) Class B Networks IP addresses xxx.xxx to xxx.xxx Each of these networks can consist of up to devices. Example: (Network , Host ) 24 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

25 COMMISSIONING Class C Networks IP addresses xx to xxx These network addresses are the most commonly used. Up to 254 devices can be connected. Class D Networks The addresses from 224.xxx.xxx.xxx xxx.xxx.xxx are used as multicast addresses. Class E Networks The addresses from 240.xxx.xxx.xxx xxx.xxx.xxx are designated as "Class E" and are reserved. Gateway Address The gateway or router address is required in order to be able to communicate with other network segments. The standard gateway must be set to the router address which connects these segments. This address must be within the local network. After entering the above mentioned LAN parameters, they needed to be transferred to the Time Server 8029NTS/M via the Apply button. Afterwards the entry of the Device Password is requested: The Time Server 8029NTS/M is supplied with the default device password <device> on delivery. After entry click on the OK button to confirm. The LAN parameters thus set are directly adopted (without reboot) by the Time Server 8029NTS/M and are immediately active. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

26 7 HTTP/HTTPS WebGUI Web Browser Configuration Interface For the correct display and function of the WebGUI, JavaScript and Cookies must be enabled in the browser. The correct function & display of the WebGUI were verified on Windows XP and Windows7 using the browsers MS InternetExplorer 8 and Mozilla Firefox, version and Quick Configuration This chapter gives a brief description of the basic operation of the WebGUI installed on the module Requirements Ready-for-operation hopf NTP Time Server 8029NTS/M PC with installed web browser (e.g. Internet Explorer) in the sub-network of Time Server 8029NTS/M Configuration Steps Create the connection to the Time Server with a web browser Login as a 'master' user (default password <master> is set by delivery) Switch to "Network" tab if available and enter the DNS Server (required for NTP and the alarm messages depending of network) Save the configuration Switch to "Device" tab and restart Network Time Server via "Reboot Device" NTP Service is now available with the standard settings NTP specified settings can be done in the "NTP" tab Alarm messages via Syslog/SNMP/ can be configured in "Alarm" tab only if this function is enabled by an activation key The following detailed explanatory information should be read if anything is unclear while executing the configuration steps. 26 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

27 7.2 General Introduction The Time Server 8029NTS/M should be accessible to a web browser if it has been set up correctly. Enter the IP address - as set up in the Time Server 8029NTS/M earlier - or the DNS name on the address line < and the following screen should appear. The complete configuration can only be completed via the modules WebGUI! The WebGUI was developed for multi-user read access but not for multiuser write access. It is the responsibility of the user to pay attention to this issue. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

28 7.2.1 LOGIN and LOGOUT as User All of the modules data can be read without being logged on as a special user. However, the configuration and modification of settings and data can only be carried out by an authorised user! Two types of user are defined: "master" user (default password on delivery: <master> ) "device" user (default password on delivery: <device> ) Differentiation is made between upper and lower case characters in the password. Alphanumeric characters and the following symbols can be used: [ ] ( ) * - _! $ % & / =? The password should be changed after the first login for security reasons. The following screen should be visible after logging in as a "master" user: Click on the Logout button to log out. The WebGUI is equipped with a session management. If the user does not conduct a logout, the logout is automatically made after 10 minutes of inactivity (idle time). 28 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

29 After successful login, depending on the access level (device or master user), changes can be made to the configuration and saved. Users logged in as master have all access rights to the Time Server 8029NTS/M. Users logged in as device do not have access to: Trigger reboot Trigger factory defaults Carry out image update Carry out H8 firmware update Upload certificate Change master password Download configuration files Navigation via the Web Interface The WebGUI is divided into functional tabs. Click on one of these tabs to navigate through the board. The selected tab is identified by a darker background colour, see the following image (General in this case). User login is not required in order to navigate through the board configuration options. JavaScript and Cookies should be enabled in the browser in order to guarantee the correct operation of the web interface. All the links within the tabs on the left hand side lead to corresponding detailed display or setting options. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

30 7.2.3 Enter or Changing Data It is necessary to be logged on as one of the users described above in order to enter or change data. All changeable data, are saved in Module 8029NTS/M. For these data the value saving is divided into two steps. For a permanent saving the modified value MUST first be accepted with Apply from the module and then be stored with Save. Otherwise the modifications get lost after a reboot of the module or switching the system off. Only in the tab Sync Source the values are failsafe stored or rather adopted with Apply. After an entry with Apply is made, the configured field is marked with a star ' * '. This means that a value has been entered or changed but not yet been stored in the flash memory. Meaning of the symbols from left to right: No. Symbol Description 1 Apply Acceptance of changes and entered data 2 Reload Restoring the saved data 3 Save Fail-save storage of the data in the flash configuration 30 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

31 If the data should only be tested it is sufficient to accept the changes with Apply. Changing Network Parameters Modifications of the network parameters (e.g. IP address) are immediately effective clicking on Apply to confirm. However, the modifications are not permanently saved yet. This requires to access the WebGUI with the new network paramters again and to save the data with Save permanently. For adopting changes and entering values only the respective buttons in the WebGUI can be used Plausibility Check during Input A plausibility check is generally carried out during input. As illustrated in the above image, an invalid value (e.g. text where a number should be entered, IP address not within the range etc.) is identified by a red border when an attempt is made to accept these settings. It should be noted here that this is only a semantic check and not to test whether an entered IP address can be used on the own network or in the configuration! As long as an error message is displayed it is not possible to save the configuration in the flash memory. The error check only verifies semantics and the validity of ranges. It is NOT a logic or network check for entered data. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

32 7.3 Description of the Tabs The WebGUI is divided into the following tabs: General Network NTP Alarm Device Sync Source GENERAL Tab This is the first tab displayed when using the web interface. NTP Time Status This area shows basic information about the current time and date of the Time Server 8029NTS/M. The time always corresponds to UTC. The reason for this is that NTP always works with UTC and not with local time. Stratum displays the actual NTP stratum value of the Time Server 8029NTS/M with the value range from The ACCURACY field (accuracy of NTP) can contain the values LOW - MEDIUM - HIGH. The meaning of these values is explained in Chapter 13.5 Accuracy & NTP Basic Principles. 32 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

33 Sync Source Status Display of the actual internal synchronization status of the module s internal time basis achieved by the adjusted and fed Sync Source: SYNC SYOF SYSI QUON QUEX QUSE INVA Time synchronized + Quartz regulation started/running Time synchronized + SyncOFF running Time synchronized as simulation mode (without actual GPS reception) Quartz/Crystal time + SyncON running Quartz/Crystal time (in freewheel after synchronization failure Board was already synchronized) Quartz/Crystal time after reset or manual setting Invalid time Login The login box is described in Chapter LOGIN and LOGOUT as User. Module Overview This table gives a direct overview of the Time Server s 8028NTS/M current operating states. WebGUI Sync Source OK Announcement leap second inactive Announcement STD DST inactive NTP is running NTP has stratum 1 NTP Accuracy is High Description When active (RED) there is a failure in the field of the Sync Souce or its evaluation. For details please go to SYNC SOURCE tab Sync Source Errors. When active (ORANGE) there is an announcement for a leap-second. When active (ORANGE) there is an announcement for a summer / winter time change-over. The NTP process on Module 8029NTS/M is running Shows the appropriate stratum the NTP process works with. Shows the appropriate accuracy the NTP process works with. The display fields LEAP SECOND and STD DST announce a corrosponding event to the next hour (insertion of a leap-second or rather switchover of summer/winter time). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

34 7.3.2 NETWORK Tab All the links within the tab on the left hand side lead to corresponding detailed setting options. Changing Network Paramaters Modifications of the network parameters (e.g. IP address) are immediately effective clicking on Apply to confirm. However, the modifications are not permanently saved yet. This requires to access the WebGUI with the new network paramters again and to save the data with Save permanently Host/Nameservice Setting for the clear network detection Hostname The standard setting for the Hostname is "hopf8029nts-m". This name should also be adapted to the respective network infrastructure. If in doubt, simply leave the standard value in place or ask your network administrator. The hostname must meet the following conditions: The hostname may only contain the characters 'A'-'Z', '0'-'9', '-' and '.'. There should be no distinction between upper-and lower-case letters. The character '.' may only appear as a separator between labels in domain names. The sign '-' must not appear as first or last character of a label. For a correct operation a hostname is required. The field for the hostname must not be left blank. 34 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

35 Default Gateway Contact your network administrator for details of the standard gateway if not known. If no standard gateway is available (special case), enter in the input field or leave the field blank DNS Server 1 & 2 The IP address of the DNS server should be entered if you wish to use complete hostnames (hostname.domainname) or work with reverse lookup. Contact your network administrator for details of the DNS server if not known. If no DNS server is available (special case), enter in the input field or leave the field blank Network Interface ETH0 Configuration of the Ethernet interface ETH0 of the Time Server 8029NTS/M Default Hardware Address (MAC) The factory default MAC address can only be read and cannot be changed by the user. It is assigned once only by for each Ethernet interface. For further information about the MAC address refer to chapter MAC-Address for ETH0 for the Time Server 8029NTS/M. MAC addresses begin with 00:03:C7:xx:xx:xx. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

36 Customer Hardware Address (MAC) The MAC address assigned from hopf can be changed to any user-defined MAC address. The board identifies itself with the user-defined MAC address to the network. The default hardware address shown in WebGUI remains unchanged. Double assignment of MAC addresses on the Ethernet referring to customers MAC addresses should be avoided. If the MAC address is not known, please contact your network administrator. The use of customers MAC address needs to be activated by the function Use Custom Hardware Address (MAC) with enable. The customers MAC address has to be entered in hexadecimal form with a colon to separateas described in the below example, e.g. 00:03:c7:55:55:02 The MAC address assigned by hopf can be activated at any time by disabling this function. There are no MAC multicast addresses allowed! DHCP If DHCP is to be used, activate this with enabled IP Address If DHCP is not used, the IP address needed to be entered here. Contact your network administrator for details of the used IP address if not known Network Mask If DHCP is not used, the network mask needed to be entered here. Contact your network administrator for details of the used network mask if not known Operation Mode The network device usually adjusts the data stream and duplex mode to the device to which it is connected (e.g. HUB, SWITCH) automatically. If the network device requires a certain speed or duplex mode, this can be configured via the web interface. The value should only be changed in special cases. The automatic setting is normally used. In individual cases an enabled "Auto negotiate" might lead to problems between the network components and the adjustment process fails. In such cases it is recommended to set the network speed of the Time Server 8029NTS/M and the connected network components manually to the same value. 36 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

37 Routing (Activation Key necessary) A route must be configured if the module is not only be used in the local sub-network. The gateway / gateway host need to be in the local sub-network range of the module in order to use the routes. The parameterization of this feature is a critical process as an incorrect configuartion may lead to considerable problems on the network! WebGUI with Routing activated The image above shows every configured route of the base system routing table as well as the user s defined routes. The module cannot be used as a router! NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

38 Management (Management-Protocols HTTP, SNMP etc.) Protocols that are not required should be disabled for security reasons. A correctly configured module is always accessible via the web interface. Changes to the availability of a protocol (enable/disable) take effect immediately. For SNMP functionality an activation key is necessary. If by mistake all protocol channels become "disabled", the SSH channel is automatically "enabled" after the attempt to save. After a Factory Default the HTTP and SSH channels are "enabled". These service settings are valid globally! Services with disabled status are not externally accessible and are not made externally available by the module! 38 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

39 WebGUI with Alarming activated Time Using SNMP and SNMP- traps the protocol SNMP should be enabled. All fields must be filled in for a correct operation of SNMP. Contact your network administrator for details of data not known. Activation and configuration of different synchronization protocols All protocols can be enabled at the same time Synchronization Protocols (Time Protocols NTP, SNTP etc.) Needed time protocols can be enabeld here. NTP (incl. SNTP) DAYTIME TIME SINEC H1 time datagram (Activation key necessary) NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

40 SINEC H1 time datagram (Activation Key necessary) Configuration of the SINEC H1 time datagram Broadcast transmission intervals of the SINEC H1 time datagram (Send Interval): every second every 10 second every 60 second Timebase see also Chapter Time-specific expressions: Local time UTC Standard time Standard time with daylight / standard time status Destination MAC Address: 09:00:06:03:FF:EF 09:00:06:01:FF:EF FF:FF:FF:FF:FF:FF Synchronization Status based on Starting Transmission (Minimum Accuracy) This setting defines at which internal accuracy status the SINEC H1 time datagram should be transmitted (see Chapter 13.5 Accuracy & NTP Basic Principles and Chapter 11 Technical Data): LOW MEDIUM HIGH The setting Minimum Accuracy = LOW may lead to the output of nonsynchronised (thus possibly wrong) time information. 40 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

41 7.3.3 NTP Tab This tab shows information and adjustment possiblities of the NTP services of the Time Server 8029NTS/M. The NTP service is the significant main service of the Time Server 8029NTS/M. If you are not familiar with the subject of NTP you can find a short description in the Glossary. More details are also available at NTP functionality is provided by an NTP-Demon running on the embedded Linux of the Time Server 8029NTS/M. Depending on the receiving conditions and under unfavourable circumstances it may take several hours until long-term accuracy is obtained (normally 5-10 minutes). During this time the NTP algorithm adjusts the internal accuracy parameters. The NTP time protocol must be enabled in order to use NTP (see Chapter Time) After all changes relating to NTP a restart of the NTP service must be performed (see Chapter (Restart NTP)). Via the NTP protocol SNTP Clients can also be synchronized. In contrast to NTP in SNTP Clients delay times are not evaluated on the network. For this reason the accuracy reached in SNTP Clients is lower than in NTP Clients System Info In the window "System Info" the current NTP values of the NTP service running on the embedded Linux of the Time Server 8029NTS/M are indicated. In addition to the NTP calculated values for root delay, root dispersion, jitter, and stability the stratum value of the Time Server 8029NTS/M, the status to the leap second, and the current system peer are also found here. The NTP version used adjusts the leap second correctly. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

42 The Time Server 8029NTS/M works as NTP Server with stratum 1 and belongs to the best available class of NTP server, as it has a reference clock with direct access Kernel Info The "Kernel Info" overview shows the current error values of the internal embedded Linux clock. Both values are internally updated every second. This screenshot shows a maximum kernel clock error of msec (milliseconds). The estimated error value is 7 μs (microseconds). The values indicated here are based on the calculation of the NTP service and have no significance for the accuracy of the adjusted and fed Sync. 42 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

43 Peers The "Peers summary" is used to track the performance of the configured NTP server/driver and the NTP algorithm itself. The information displayed is identical with the information available via NTPQ or NTPDC programes. Each NTP server/driver that has been set up in the NTP server configuration is displayed in the peer information. The connection status is displayed in the reachability column (not reachable, bad, medium, and reachable). Three lines can be seen in the above image. The first line displays the hopf - refclock ntp driver that gets the time information directly from the Sync Source. The second and third line display external NTP server that can be additionally added to the internal hopf refclock ntp driver in the menu server configuration. A short explanation and definition of the displayed values can be found in Chapter 13.5 Accuracy & NTP Basic Principles. The character in the first column on the left presents the current status of the NTP association in the NTP selection algorithm. A list and description of possible characters can be found in the Glossary (see Chapter 13.2 Tally Codes (NTP-specific)). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

44 Server Configuration The basic settings for NTP base functionality are displayed selecting the "Server Configuration" link. The NTP-hopf-refclock driver is already configured as standard ( in the "Peers Summary") and is not explicitly displayed here Synchronization Source (General / Synchronization source) As "Synchronization source" either GPS or DCF77, depending on the appropriate Sync Source, has to be selected. This is reuiqred in order to align the NTP algorithm for the calculation of the accuracy with the synchronization source. Based on the selection of GPS, even though GPS is not the source of the Sync Source (different product option) the value HIGH for Accuracy may never be reached NTP Syslog Messages (General / Log NTP Messages to Syslog) This option enables or disables Syslog messages which are generated from the NTP service. This value has no effect if Syslog is not configured in the ALARM tab (see Chapter Syslog Configuration). 44 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

45 Crystal Operation Crystal Operation / Switch to Specific Stratum If the Sync Source connected to the module supplies an inadequate or no time information required for the time synchronization of the Module the NTP service of the Time Server 8029NTS/M usually behaves in the way that the receipt of time information is stopped from the Sync Source and the stratum value reset to 16 (defined as invalid in NTP). NTP Clients do not accept time information from a NTP Time Server with stratum 16 (invalid). Briefly, as long as the Time Server 8029NTS/M indicates the stratum value 16, NTP Clients are not synchronized. This behaviour of NTP during crystal operation of the Sync Source can be changed. Therefore the function "Switch to specific stratum" should be enabled by setting the value to "enabled" and the so-called downgrading stratum (= stratum value of the Time Server 8029NTS/M during crystal operation of the Sync Source). For the sychronization of NTP Clients during crystal operation of the Sync Source or for testing the system without connected synchronization source, in the setting "enabled" any stratum value between 1 and 15 can be set. Crystal Operation / Stratum in Crystal Operation The value defined here (range 1-15) designates the transmitted fallback NTP stratum level of the module in "Quartz" synchronization status. Stratum 1 should be configured if downgrading is not desired in status "Quartz". The NTP service MUST also be restarted (see Chapter Restart NTP. Using the option "Switch to specific stratum" the NTP Clients are synchronized with time information indicated in the general menu of the WebGUI of the Sync Source during crystal operating. Whether this time information (e.g. through drift) is imprecise or the time is manually set (wrong) cannot be detected by the NTP Client! In case the value 1 is used for "Stratum in crystal operation", the NTP Client cannot not verify whether the Time Server 8029NTS/M is synchronised or runs in crystal operation. Should a differentiation be wished between synchronized and crystal operation the downgrading stratum needs to be set to a value between 2 and 15. The value is only adjustable if the "Switch to specific stratum" function is enabled. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

46 Broadcast / Broadcast Address This section is used to configure the Time Server 8029NTS/M as a broadcast or multicast server. The broadcast mode in NTPv3 and NTPv4 is limited to clients on the same sub-network and Ethernets which support broadcast technology. This technology does not generally extend beyond the first hop (network node - such as router or gateway). The broadcast mode is provided for configurations which are designed to facilitate one or more servers and as many clients as possible in a sub-network. The server continuously generates broadcast messages at defined intervals, corresponding to 16 seconds (minpoll 4) for Time Server 8029NTS/M. Care should be taken to ensure that the correct broadcast address is used for the sub-network, usually xxx.xxx.xxx.255 (e.g ). If the broadcast address is not known, this can be requested from the network administrator. This section can also be used to configure the Time Server 8029NTS/M as a multicast server. The configuration of a multicast server is similar to that of a broadcast server. However, a multicast group address (class D) is used instead of the broadcast address. An explanation of multicast technology goes beyond the scope of this document. In principle, a host or router sends a message to an IPv4 multicast group address and expects all hosts and routers to receive this message. In doing so, there is no limit to the number of senders and receivers and a sender may also be a receiver and vice-versa. The IANA has assigned the multicast group address IPv to the NTP, however this should only be used if the multicast range can be safely limited in order to protect neighbouring networks. As a basic principle, administratively manageable IPv4 group addresses should be used as described in RFC-2365 or GLOP group addresses as described in RFC Broadcast / Authentication / Key ID Broadcast packets can be protected by authentication for security reasons. If a security method is selected here, this must be configured additionally in the security settings of the NTP tab. A key must be defined if the Symmetric Key is selected Additional NTP SERVERS Adding further NTP servers provides the opportunity to implement a security system for the time service. However, this affects the accuracy and stability of the Time Server 8029NTS/M. Detailed information on this subject can be found in the NTP documentation ( 46 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

47 Extended NTP Configuration NTP is a standard for synchronising clocks in computer systems via packet-based communication networks. For special applications a NON standard setting can be configured. For activation of this special NTP setting, the customer's approval shown in the WebGUI needed to be declared by checking the field "I agree" Suppression of unspecified NTP Outputs Unspecified NTP outputs that e.g. are generated by NTP at a restart are suppressed when this function is enabled Restart NTP The following screen appears after clicking on the Restart NTP option: Restarting NTP services is the only possibility of making NTP changes effective without having to restart the entire Time Server 8029NTS/M. As can be seen from the warning message, the currently reachable stability and accuracy get lost caused by this restart. After a restart of the NTP service it takes up to 10 minutes until the NTP service on the Time Server 8029NTS/M is completely adjusted. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

48 Configuring the NTP Access Restrictions One of the extended configuration options for NTP is the "Access Restrictions" (NTP access restictions). Restrictions are used in order to control access to the System s NTP service and these are regrettably the most misunderstood options of the NTP configuration. If you are not familiar with these options, a detailed explanation can be found at IP addresses should be used when configuring the restrictions no Hostnames! The following steps show how restrictions can be configured - should these not be required it is sufficient to retain the standard settings. The standard restrictions tell the NTP service how to handle packets of hosts (including remote time servers) and sub-network which otherwise have no special restrictions. The NTP configuration can simplify the selection of the correct standard restrictions while making the required security available. Before beginning the configuration the points to must be checked by the user: NAT or Firewall Are incoming connections to the NTP Service blocked by NAT or a Stateful Inspection Firewall? No Yes Proceed to Chapter Blocking Unauthorised Access No restrictions are required in this case. Proceed further to Chapter Internal Client Protection / Local Network Threat Level 48 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

49 Blocking Unauthorised Access Is it really necessary to block all connections from unauthorised hosts if the NTP Service is openly accessible? No Yes Proceed to Chapter Allowing Client Requests In this case the following restrictions are to be used: ignore in the default restrictions If a standard restriction is selected in this area, exceptions can be declared in separate lines for each authorised server, client or sub-network. See Chapter Addition of Exceptions to Standard Allowing Client Requests Are clients to be allowed to see the server status information when they receive the time information from the NTP service (even if this is information about the module, operating system and NTPD version)? No Yes In this case select from the following standard restrictions: See Chapter Access Control Options kod notrap nopeer noquery. In this case select from the following standard restrictions: See Chapter Access Control Options: kod notrap nopeer If a standard restriction is selected in this area, exceptions can be declared in separate lines for each authorised server, client or sub-network. See Chapter Addition of Exceptions to Standard Internal Client Protection / Local Network Threat Level How much protection from internal network clients is required? Yes The following restrictions can be enabled if greater security settings than the installed authentication are required in order to protect the NTP service from the clients see Chapter Access Control Options. kod notrap nopeer NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

50 Addition of Exceptions to Standard Restrictions After the standard restrictions have been set once, certain exceptions may be necessary for special hosts/sub-networks in order to allow remote time servers and client hosts/subnetworks to contact the NTP service. These standard restrictions are to be added in the form of restriction lines. An unrestricted access of the Time Server 8029NTS/M to its own NTP service is always allowed, irrespective of whether standard restrictions are ignored or not. This is necessary in order to be able to display NTP data on the web interface. Add restriction exception: (for each remote time server) Restrictions: Press ADD Enter the IP address of the remote time server. Enable restrictions: e.g. notrap / nopeer / noquery Allow unrestricted access to a special host (e.g. System administrator s workstation): Restrictions: Press ADD IP address Do not enable any restrictions Allow a sub-network to receive time server and query server statistics: Restrictions: Press ADD IP address Network mask notrap / nopeer 50 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

51 Access Control Options The official documentation concerning the current implementation of the restriction instructions can be found on the Access Control Options page at Numerous access control options are used. The most important of these are described in detail here. nomodify "Do not allow this host/sub-network to modify the NTPD settings unless it has the correct key. Default Settings: Always active. Can't be modified by the user. As standard, NTP requires authentication with a symmetric key in order to carry out modifications with NTPDC. If a symmetric key is not configured for the NTP service, or if this is kept in a safe place, it is not necessary to use the nomodify option unless the authentication procedure appears to be unsafe. noserver "Do not transmit time to this host/sub-network." This option is used if a host/sub-network is only allowed access to the NTP service in order to monitor or remotely configure the service. notrust "Ignore all NTP packets which are not encrypted. This option tells the NTP service that all NTP packets which are not encrypted should be ignored (it should be noted that this is a change from ntp-4.1.x). The notrust option MUST NOT be used unless NTP Crypto (e.g. symmetric key or Autokey) has been correctly configured on both sides of the NTP connection (e.g. NTP service and remote time server, NTP service and client). noquery "Do not allow this host/sub-network to request the NTP service status." The ntpd status request function, provided by ntpd/ntpdc, declassifies certain information over the running ntpd Base System (e.g. operating system version, ntpd version) which under certain circumstances ought not to be made known to others. It must be decided whether it is more important to hide this information or to give clients the possibility of seeing synchronization information over ntpd. ignore "In this case ALL packets are refused, including ntpq and ntpdc requests". kod "A kiss-o'-death (KoD) packet is transmitted if this option is enabled in the case of an access error." KoD packets are limited. They cannot be transmitted more frequently than once per second. Any KoD packet which occurs within one second from the last packet is removed. notrap "Denies support for the mode 6 control message trap service in order to synchronise hosts." The trap service is a sub-system of the ntpq control message protocols. This service logs remote events in programmes. version "Denies packets which do not correspond to the current NTP version." Changes in data do not take effect immediately after clicking on the Apply symbol. The NTP service MUST also be restarted (see Chapter Restart NTP ). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

52 Symmetric Key Why Authentication? Most NTP users do not require authentication as the protocol contains several filters (for bad time). Despite this, however, the use of authentication is common. There are certain reasons for this: Time should only be used from safe sources An attacker broadcasts false time signals An attacker poses as another time server How is Authentication used in the NTP Service? Client and server can execute an authentication whereby a code word is used on the client side and a restriction on the server side. NTP uses keys to implement the authentication. These keys are used when data are exchanged between two machines. In principle both sides must know this key. The key can generally be found in the "*.*/etc/ntp.keys" directory. It is unencrypted and hidden from public view. This means that the key has to be distributed on a safe route to all communication partners. The key can be downloaded for distribution under "Downloads / Configuration Files" on the DEVICE tab. It is necessary to be logged in as "Master" in order to access this. The keyword key of a client s ntp.conf determines the key that is used to communicate with the designated server (e.g. the Time Server 8029NTS/M). The key must be reliable if time is to be synchronised. Authentication causes a delay. This delay is automatically taken into account and adjusted in the current versions. 52 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

53 How is a key created? A key is a sequence of up to 31 ASCII characters. Some characters with special significance cannot be used (alphanumeric characters and the following symbols can be used:[ ] ( ) * - _! $ % & / =?). A new line can be inserted by pressing the ADD key. The key which is stored in the key file is entered on this line. The key ID is used to identify the key and is in the range from This means that different keys can be defined. Duplicate key ID s are not allowed. Having now explained the principles of keys, it should be possible to use a key in practically the same way as a password. The value of the request key field is used as the password for the ntpdc tool while the value of the control key field is used as the password for the ntpq tool. More information is available at How does authentication work? The basic authentication is a digital signature and no data encryption (if there are any differences between the two). The data packet and the key are used to create a nonreversible number which is attached to the packet. The receiver (which has the same key) carries out the same calculation and compares the results. Authentication has been successful if the results agree Autokey NTPv4 offers a new Autokey scheme based on public key cryptography. As a basic principle, public key cryptography is safer than symmetric key cryptography as protection is based on a private value which is generated by each host and is never visible. In order to enable Autokey v2 authentication, the Autokey Enabled option must be set to "enabled" and a password specified (may not be blank). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

54 A new server key and certificate can be generated by pressing the "Generate now" button. Generate now This should be carried out regularly as these keys are only valid for one year. If the Time Server 8029NTS/M is to form part of an NTP trust group, a group key can be defined and uploaded with the "Upload now" button. Detailed information about the NTP Autokey scheme can be found in the NTP documentation ( Changes in data do not take effect immediately after clicking on the Apply symbol. The NTP service MUST also be restarted (see Chapter Restart NTP) ALARM Tab (Activation Key necessary) All the links within the tab on the left hand side lead to corresponding detailed setting options. 54 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

55 Syslog Configuration It is necessary to enter the name or IP address of a Syslog server in order to store every configured alarm situation which occurs on the module in a Linux/Unix Syslog. If everything is configured correctly and enabled (depending on the Syslog level), every message is transmitted to the Syslog server and stored in the Syslog file there. Syslog uses Port 514. Co-logging in the system itself is not possible as therefore the internal memory is not of sufficient size. It should be noted that the standard Linux/Unix Syslog mechanism is used for this functionality. This is not the same as the Windows System Event mechanism! The alarm level designates the priority level of the messages to be transmitted and the level from which transmission should take place (see Chapter Alarm Messages). Alarm Level none info warning error alarm Transmitted Messages no messages info / warning / error / alarm warning / error / alarm error / alarm alarm The NTP service implemented in the system can transmit its own Syslog messages (see Chapter NTP Syslog Messages (General / Log NTP Messages to Syslog)). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

56 Configuration notification is one of the important features of this device which offers technical personnel the opportunity to monitor and/or control the IT environment. It is possible to configure various, independing addresses which each have different alarm levels. Dependending on the configured level, an is sent after an error has occurred on the respective receiver. A valid server (SMTP server) must be entered for the purpose of correct configuration. Some servers only accept messages if the sender address entered is valid (spam protection). This can be inserted in the Sender Address field. The Alarm Level designates the priority level of the messages to be sent and determines from which level the message should be sent (see Chapter Alarm Messages). Alarm Level none info warning error alarm Transmitted Messages no messages info / warning / error / alarm warning / error / alarm error / alarm alarm 56 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

57 SNMP Configuration / TRAP Configuration It is possible to use an SNMP agent (with MIB) or to configure SNMP traps in order to monitor the module over SNMP. SNMP traps are sent to the configured hosts over the network. It should be noted that these are based on UDP and therefore it is not certain that they will reach the configured host! Several hosts can be configured. However, all have the same alarm level. The private hopf enterprise MIB is also available over the web (see Chapter Downloading Configuration Files / SNMP MIB). The Alarm Level designates the priority level of the messages to be sent and determines from which level the message should be sent (see Chapter Alarm Messages). Alarm Level none info warning error alarm Transmitted Messages no messages info / warning / error / alarm warning / error / alarm error / alarm alarm The SNMP protocol must be enabled in order to use SNMP (see Chapter Management (Management-Protocols HTTP, SNMP). NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

58 Alarm Messages Every message shown in the image can be configured with the displayed alarm levels. Selection of the level NONE means that this message is completely ignored. Depending on the messages, their configured levels and notifications levels of the s, a corresponding action is carried out if an event occurs. Modified settings are failsafe stored after Apply and Save only. 58 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

59 7.3.5 DEVICE Tab All the links within the tab on the left hand side lead to corresponding detailed setting options. This tab provides the basic information about the hardware of Module 8029NTS/M as well as software/firmware. Password administration and the update services for the module are also made accessible via this website. The complete download zone is also a component of this site Device Information All information is available exclusively in write-protected and read-only form. Details on the board type, serial number and current software versions are provided to the user for service and enquiry purposes. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

60 Hardware Information Read-only access is provided here in the same way as for device information. The user requires this information in the case of service requests, e.g. MACH version, hardware status etc. The display "Current DIP Switch Settings" is not applicable for this device Restoring the Factory Defaults Settings In some cases it may be necessary or wished to reset all settings of module 8029NTS/M to factory settings (factory defaults). This function serves to reset all values in the flash memory to their factory default values. This also includes passwords (see Chapter 12 Factory Defaults of Time Server 8029NTS/M). 60 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

61 Please log in as a Master user in accordance with the description in Chapter LOGIN and LOGOUT as User Pressing the "Reset now" button releases setting of the factory default values. Once this procedure has been triggered there is NO possibility of restoring the deleted configuration. A Factory Default requires a complete check and optionally a new configuration of the Module 8029NTS. In particulary the default MASTER and DEVICE passwords should be reset Restoring saved Customer Settings (Custom Defaults) This function allows to save a current configuration as CUSTOM DEFAULTS. The current configuration is saved. It is irrelevant whether the configuration has already been saved with "SAVE to FLASH" or just activated by "Apply". In order to activate a CUSTOM DEFAULTS a configuration has to be saved initially. Saving is only processed via the button "Save Custom Defaults now". A successful saving is confimred with a text message underneath the button. If the user saves no CUSTOM DEFAULT via the WebGUI, a FACTORY DEFAULT via dthe Reset-(Default) button is triggered instead. With this function the saved configuration is written back into the flash memory. The settings for activation keys (e.g. an entered activation key) are neither deleted nor restored by the CUSTOM DEFAULTS. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

62 Restarting the Module (Reboot Device) The restart concerns the Module 8029NTS/M only but not the Sync Source. All settings not saved with "Save" are lost on reboot (see Chapter Enter or Changing Data). Moreover the NTP service implemented in the system is restarted. This leads to a renewed alignment phase with the loss of the stability and accuracy reached up to this point. Log in is carried out as Master user in accordance with the description in Chapter LOGIN and LOGOUT as User. Press the "Reboot now" button and wait until the restart has been perfomed. 62 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

63 Image Update & H8 Firmware Update Patches and error recovery are provided for the individual modules by means of updates. Both the embedded image and the H8 firmware can only be downloaded to the Board via the web interface (login as "Master" user required). See also Chapter 4.4 Firmware Update. The following points should be noted regarding updates: Only experienced users or trained technical personnel should carry out an update after checking all necessary preconditions. Important: Faulty updates or update attempts may under certain circumstances require the Board to be returned to the factory for rectification at the owner s expense. Check that the update on hand is suitable for your Board. If in doubt please consult the support of the hopf company. In order to guarantee a correct update, the "New version of saved site" function must be set to "On each access to the site" in the Internet browser used. During the update procedure, the device must not be switched off and settings must not be saved to the flash memory! Updates are always executed as software set. I.e. H8 firmware update + image update. Unless specifically defined otherwise in the SET, it is absolutely essential to complete the H8 firmware update first, followed by the image update. For the Update please pay attention to the points in Chapter 4.4 Firmware Update. In order to carry out an update, enter the name and the folder in which the update / firmware image is located in the text field or open the file selection dialogue by pressing the "Browse" button. Correct firmware and image designations are (e.g.): H8-8029NTS-M_v0100_128.mot for the H8 firmware (update takes approx minutes) upgrade_8029gen_v0300.img for the embedded image (update takes approx. 2-3 minutes) The update process is started by pressing the "Update now" button. The update is installed if the transfer and checksum test are successful. A success page is displayed and shows the number of bytes that have been transferred and installed. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

64 A restart of the Board with the new Firmware is done automatically after the H8-Firmware update. The procedure for the Image update differs only in how the module is restarted. After the image-update the WebGUI displays a window to confirm the restart (reboot) of the board Upload of User SSL-Server-Certificate (Upload Certificate) This offers the possibility to encrypt the https connections to the module with a user-provided SSL server certificate. 64 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

65 Customized Security Banner Special security information displayed in the General tab can be entered here by the user. The security information can be written as 'unformatted' text as well as in HTML format. There are 2000 characters available to write failsafe into the Time Server 8029NTS/M. After a successful storage the "Customized Security Banner" with the saved security information is displayed in the General-Tab. To delete the "Customized Security Banner" the inserted text must be deleted and saved again Product Activation by means of Activation Keys For the activation of optional functions, e.g "alarming" or "SINEC H1 time datagram", a special activation key is required for which an order with the can be placed. Each activation key is related to a special board with an appropriate serial number and cannot be used for several boards. For a subsequent order of an activation key the serial number of the Module 8029NTS/M needs to be provided. The serial number can be found under the tab DEVICE Device info (serial number 8029 ). The settings for activation keys (e.g. an entered activation key) are neither deleted nor restored via the functions FACTORY DEFAULTS and CUSTOM DEFAULTS. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

66 Overview Full listening of all optional functions with the current activation status and stored activation key Activate Feature Input field to enter a new activation key. After entering the feature is activated by pressing the Apply button. If the activation was successful the new feature is listed in the overview with status Active and can be used immediately. Key Reset Clears all activation keys and sets all optional features to status Inactive. All other nonoptinal features are still available after peforming the key reset. If an optional feature is enabled again, the last stored configuration for this feature is restored. 66 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

67 Diagnostics Function It "status messages" is enabled the output is processed as SYSLOG message. This function should only be used/enabled in case a problem arises and after consulting the hopf support Passwords (Master/Device) Differentiation is made between upper and lower case characters in passwords. In principle, all alphanumeric characters and the following symbols are allowed in passwords: [ ] ( ) * - _! $ % & / =? (See also Chapter LOGIN and LOGOUT as User) NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

68 Downloading Configuration Files / SNMP MIB In order to be able to download certain configuration files via the web interface, it is necessary to be logged on as a "master" user. The loaded file System Configuration from the module is only used for support purposes and cannot be reloaded for adjusting the settings in the Time Server 8029NTS/M. For the download of the file System Configuration the following process is mandatory: 1. Pressing the button SAVE 2. Pressing the button Refresch System Configuration 3. Perform the download of the file The "private hopf enterprise MIB" is also available via the WebGUI in this area. 68 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

69 7.3.6 SYNC SOURCE Tab The complete display and parameterization of the synchronization of the module by the respectively fed Sync Source takes place in this tab. The modified values in the tab SYNC SOURCE are directly adopted by pressing the button 1 and failsafe stored. This behaviour is indicated on the modified display of the Apply button. The buttons 2 and 3 are without function in the tab SYNC SOURCE and are not required. After the data transfer it can take up to 30 seconds until the modified data are modul-internally reapplied for the WebGUI indication. Generally it is recommended to activate the function Reset Time Evaluation after peforming modifications of the Sync Source settings (e.g. using the module in a stand-alone converter). This ensures that the modul-internal time information is really provided by the reset Sync Source. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

70 Time and Status Current Sync Source Time This area indicates the curent time and date of the Sync Source. Both the local and UTC time are displayed. In theory, depending on the synchronization status of the Sync Source, the time displayed here can differ from the NTP time since two independent time systems are involved. Announcements The display fields LEAP SECOND and STD DST announce a corrosponding event to the next hour (insertion of a leap-second or rather switch-over of summer/winter time). Sync Source Status Display of the actual status of synchronization of the Sync Source with these possible values: SYNC SYOF SYSI QUON QUEX QUSE INVA Time synchronized + Quartz regulation started/running Time synchronized + SyncOFF running Time synchronized as simulation mode (without actual GPS reception) Quartz/Crystal time + SyncON running Quartz/Crystal time (in freewheel after synchronization failure Board was already synchronized) Quartz/Crystal time after reset or manual setting Invalid time 70 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

71 Select Sync Source Time The Module 8029NTS/M can be synchronized by different time information. Using these modules in hopf basis systems the necessary settings are performed by default. Using the module in converter units the settings may be required by the customer. This selection determines what kind of time information should be evaluated by the module. Currently hopf specific time formats as well as the DCF77 pulse (1Hz) with local time are available for the synchronization. 01: hopf Binary string with PPS (NTP configuration) 02: hopf System-BUS 6000 with PPS 03: hopf System-BUS 7001 with PPS 04: hopf Master/Slave-String Transmission cycle: Every minute 05: hopf Master/Slave-String Transmission cycle: Every second 06: hopf Master/Slave-String with PPS Transmission cycle: Every min. 07: hopf Master/Slave-String with PPS Transmission cycle: Every sec. 08: DCF77 Pulse (1Hz) Local time (MEZ) There is no synchronization of the Module and also no generation of the signal for the output in case of an incorrect setting. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

72 Difference Time (Time Zone Offset to UTC) The input of the difference time (Time Zone Offset to UTC) by the user is only necessary for Sync Source time information that donot include the current difference time. It is currently required for the synchronization by DCF77 pulse with local time. The difference time to be entered always relates to UTC to local time stadnard time (winter time) although commissioning ort he input of difference time takes place during summer time. If the respectively set Sync Source supplies the current difference time with its time information the user s entered values are automatically overwritten with the information of the Sync Source after a successful synchronization. Offset Hours Time Zone Offset input of the full hour (0-13) Offset Minutes Time Zone Offset input of minutes (0-59) Example: Time Offset for Germany East, 1 hour and 0 minutes (+ 01:00) Time Offset for Peru West, 5 hours and 0 minutes (- 05:00) Direction relating to Prime Meridian Direction of the Difference Ttime Entering the direction the local time deviates from world time: 'East' corresponds to east, 'West' corresponds to west of the Prime-Meridian (Greenwich) 72 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

73 SyncON / SyncOFF Timer SyncON Timer The SyncON timer is used to delay the sync-status SYNC by the set time although the module is already synchronous. This function is enabled when adjustment processes should be terminated as defined before the sync status is SYNC. This function is not required for this module and should always be set to 0. SyncOFF Timer This value is used to provide reception failure bypassing resulting from the Sync Source. This timer shall allow an error-message free operation even if there are temporary problems with the Sync Source. In the event of a reception failure of the Sync Soure, the re-synchronization of the Sync Source to quartz status is delayed by the set value. The module continues to run in synchronization status on the internally regulated, highly accurate quartz base during this period. This timer is of special significance when certain system outputs are linked to a specific system status. The Timer can be set from 2min. to 1440min. Current Timer values In case of an active Timer the appropriate value of the timer is displayed here. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95

74 Reset Time Evaluation This function "Reset Time Evaluation" allows a setting back of the total internal evaluation of the module fed time information including any announcements for the summer/winter time switchover or rather insertion of a lump second. The NTP service has its own and independent time. After processing this function, hence the NTP service receives time information unless the module-internal time basis has successfully been re-synchronized. 74 / 95 NTP Time Server Module with LAN Interface 8029NTS/M - V03.00

75 Sync Source Errors This tab indicates the current failure status of the Sync Source or rather the components involved in the evaluatoon of the signals of the Sync Source. Sync Source describes in this module the supplied time information to the module as well as the modul-intenral evaluation up to the successful synchronization of the modul-internal time basis. If collected error messages are displayed in the tab GENERAL (Sync Source Error) there is at least one error. This page is updated automatically every 5 seconds. NTP Time Server Module with LAN Interface 8029NTS/M - V / 95