HP NonStop Time Synchronization User s Guide

Transcription

1 HP NonStop Time Synchronization User s Guide Abstract HP NonStop Time Synchronization (TimeSync) synchronizes time between HP NonStop servers, Microsoft Windows systems, and Linux systems. It can act as both an NTP/SNTP client and server to receive time from external NTP time sources and to provide time to NTP clients. This document describes how to install, configure, and use NonStop Time Synchronization. Product Version V01 Supported Release Version Updates (RVUs) This manual supports G06.00 and all subsequent G-series RVUs, H06.03 and all subsequent H-series RVUs, J06.03 and subsequent J-series RVUs, and L15.02 and subsequent L-series RVUs until otherwise indicated in a new edition. Part Number Published January 2015 HP NonStop Time Synchronization User s Guide Page 1 of 86

2 Document History Part Number Product Version Published V July V June V March V August V January 2015 HP NonStop Time Synchronization User s Guide Page 2 of 86

3 Table of Contents HP NonStop Time Synchronization User s Guide... 1 Abstract... 1 Product Version... 1 Supported Release Version Updates (RVUs)... 1 Document History... 2 Table of Contents... 3 What s New in This Manual... 5 New and Changed Information... 5 About This Manual... 6 Audience... 6 Related Documents... 6 Manual Organization... 6 Notation Conventions... 6 Hypertext Links... 6 General Syntax Notation... 7 Notation for Messages Notation for Management Programming Interfaces Overview Introduction to NonStop TimeSync NonStop TimeSync Features Key Features and Benefits General Features Client Features Server Features TimeSync and Daylight Savings Time (DST) Transitions Safely Updating Local System Clocks NonStop TimeSync Architecture TimeSync Quick Start Installing NonStop TimeSync Installing TimeSync on a NonStop Server Installing TimeSync on a Linux Server Installing TimeSync on a Windows Server Configuring TimeSync Location of the Configuration File Structure of the Configuration File HP NonStop Time Synchronization User s Guide Page 3 of 86

4 4.3 Configuration Options Process Options Server Options Client Options Logging Options Tracing Options Running TimeSync Starting TimeSync on Guardian Starting TimeSync on OSS Starting TimeSync on Linux Starting TimeSync on Windows The TimeSync Command Interface ADD Command CONF Command FC Command INFO Command REMOVE Command SAVE Command SERVERCONF Command SET Command SHOW Command STATUS Command SYNCNOW Command SYSTEM Command Appendix A: TimeSync Event Messages General TimeSync Messages Windows-specific Messages Linux-specific Messages OSS-specific Messages Guardian-specific Messages HP NonStop Time Synchronization User s Guide Page 4 of 86

5 What s New in This Manual New and Changed Information TimeSync 1.4 Updated the TimeSync Quick Start on page 21. Updated the Installing NonStop TimeSync section on page 23. Added the ModifyClockRate option on page 38. HP NonStop Time Synchronization User s Guide Page 5 of 86

6 About This Manual Audience The intended audience for this document is system managers or administrators responsible for maintaining HP NonStop Servers, Windows workstations and/or Linux systems. Related Documents None Manual Organization Section Overview TimeSync Quick Start Installing NonStop TimeSync Configuring TimeSync Running TimeSync The TimeSync Command Interface Appendix A: TimeSync Event Messages Description Overview and architecture of the HP NonStop TimeSync product. Outline of key TimeSync installation and configuration steps. Procedures for installing the NonStop HP NonStop TimeSync product. Procedures for configuring and managing the NonStop TimeSync product. Procedures for running the NonStop TimeSync product. Procedures for using the TimeCom command interpreter. Detailed information about the system event/log messages generated by TimeSync. Notation Conventions Hypertext Links Blue underline is used to indicate a hypertext link within text. By clicking a passage of text HP NonStop Time Synchronization User s Guide Page 6 of 86

7 with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 25. General Syntax Notation This list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH lowercase italic letters Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required. For example: file-name computer type Computer type letters within text indicate C and Open System Services (OSS) keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. For example: myfile.c italic computer type Italic computer type letters within text indicate C and Open System Services (OSS) variable items that you supply. Items not enclosed in brackets are required. For example: pathname [ ] Brackets Brackets enclose optional syntax items. For example: TERM [\system-name.]$terminal-name INT[ERRUPTS] HP NonStop Time Synchronization User s Guide Page 7 of 86

8 A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: FC [ num ] [ -num ] [ text ] K [ X D ] address { } Braces A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON OFF } Vertical Line A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: INSPECT { OFF ON SAVEABEND } Ellipsis An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address [, new-value ] [ - ] { } An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char " HP NonStop Time Synchronization User s Guide Page 8 of 86

9 Punctuation Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown. For example: error := NEXTFILENAME ( file-name ) ; LISTOPENS SU $process-name.#su-name Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown. For example: "[" repetition-constant-list "]" Item Spacing Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. For example: CALL STEPMOM ( process-id ) ; If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items: $process-name.#su-name Line Spacing If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example: ALTER [ / OUT file-spec / ] LINE [, attribute-spec ]!i and!o In procedure calls, the!i notation follows an input parameter (one that passes data to the called procedure); the!o notation follows an output parameter (one that returns data to the calling program). For example: HP NonStop Time Synchronization User s Guide Page 9 of 86

10 CALL CHECKRESIZESEGMENT ( segment-id!i, error ) ;!o!i,o In procedure calls, the!i,o notation follows an input/output parameter (one that both passes data to the called procedure and returns data to the calling program). For example: error := COMPRESSEDIT ( filenum ) ;!i,o!i:i In procedure calls, the!i:i notation follows an input string parameter that has a corresponding parameter specifying the length of the string in bytes. For example: error := FILENAME_COMPARE_ ( filename1:length!i:i, filename2:length ) ;!i:i!o:i In procedure calls, the!o:i notation follows an output buffer parameter that has a corresponding input parameter specifying the maximum length of the output buffer in bytes. For example: error := FILE_GETINFO_ ( filenum!i, [ filename:maxlen ] ) ;!o:i Notation for Messages This list summarizes the notation conventions for the presentation of displayed messages in this manual. Bold Text Bold text in an example indicates user input typed at the terminal. For example: ENTER RUN CODE?123 CODE RECEIVED: The user must press the Return key after typing the input. HP NonStop Time Synchronization User s Guide Page 10 of 86

11 Nonitalic text Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown. For example: Backup Up. lowercase italic letters Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets Brackets enclose items that are sometimes, but not always, displayed. For example: Event number = number [ Subject = first-subject-value ] A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed. The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: proc-name trapped [ in SQL in SQL file system ] { } Braces A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: obj-type obj-name state changed to state, caused by { Object Operator Service } process-name State changed from old-objstate to objstate { Operator Request. } { Unknown. } HP NonStop Time Synchronization User s Guide Page 11 of 86

12 Vertical Line A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: Transfer status: { OK Failed } % Percent Sign A percent sign precedes a number that is not in decimal notation. The % notation precedes an octal number. The %B notation precedes a binary number. The %H notation precedes a hexadecimal number. For example: % %B %H2F P=%p-register E=%e-register Notation for Management Programming Interfaces This list summarizes the notation conventions used in the boxed descriptions of programmatic commands, event messages, and error lists in this manual. UPPERCASE LETTERS Uppercase letters indicate names from definition files. Type these names exactly as shown. For example: ZCOM-TKN-SUBJ-SERV lowercase letters Words in lowercase letters are words that are part of the notation, including Data Definition Language (DDL) keywords. For example: token-type!r The!r notation following a token or field name indicates that the token or field is required. For example: HP NonStop Time Synchronization User s Guide Page 12 of 86

13 ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING.!r!o The!o notation following a token or field name indicates that the token or field is optional. For example: ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32.!o HP NonStop Time Synchronization User s Guide Page 13 of 86

14 1. Overview 1.1. Introduction to NonStop TimeSync NonStop TimeSync synchronizes time across multiple NonStop, Linux, and Windows systems. It has the ability to act as a synchronization client, a synchronization server, or both simultaneously. In client mode, TimeSync obtains reference times from one or more configured time sources, and adjusts the local system time accordingly. Supported time sources include any system running TimeSync in server mode anywhere in your network, or any NTP/SNTP server. In server mode, TimeSync supplies reference times to requesting clients. These clients can be other systems running TimeSync in client mode, or any NTP/SNTP client. NonStop TimeSync supports multiple time sources, slow drift algorithms and other detailed settings to give users precise control over how time is maintained on their systems. It also ensures that updates occur safely on all platforms, and never allows time to move backwards unless configured to do so NonStop TimeSync Features NonStop TimeSync provides a wide range of features. In nearly all cases, these features are equivalent on all supported platforms. Key Features and Benefits Allows NonStop system clocks to be synchronized between all systems within a cluster or Expand network. Allows system clocks to be synchronized between NonStop, Linux, and Windows systems. Allows system clocks to be synchronized with an NTP source. Synchronizes clocks between systems automatically in a cluster or network; requires no user intervention to invoke synchronization. Helps ensure that time updates occur safely on all platforms, and prevents time from moving backward unless configured to do so. HP NonStop Time Synchronization User s Guide Page 14 of 86

15 General Features Allows any supported system to act as a Time Synchronization Server. Allows any supported system to operate as a Time Synchronization Client. Supports both Guardian and OSS environments on NonStop servers. Runs as a service on Microsoft Windows and as a daemon on Linux. Integrates with native event management services on each platform to enable logging of critical events (EMS on NonStop, syslog on Linux, and the Windows event log on Windows). Maintains a dedicated log file of time synchronization activities. No overhead or impact on performance. Provides the TimeCom command interpreter (CI), which can be used to dynamically alter TimeSync settings and obtain status information. Client Features Up to microsecond accuracy, depending on the system. Can be configured to safely update system clocks by preventing both backward time changes and drastic jumps in time. Includes Multisource mode, which permits clock averaging from among multiple sources to yield a more accurate reference time. Provides a configurable offset for system clocks not kept in GMT/UTC. Offers a report-only mode which can be used to report time differences between the local system and reference sources without updating the local system time. Permits changes to the clock rate on the local system in order to minimize clock drift. Server Features Provides the ability to act as time source for any system running TimeSync in client mode. Has the capability to act as the time source for any system running an NTP or SNTP client. HP NonStop Time Synchronization User s Guide Page 15 of 86

16 Allows systems that do not keep system time in GMT/UTC to act as time sources via a configurable offset. TimeSync and Daylight Savings Time (DST) Transitions TimeSync tracks all system times and calculates all time differences using Coordinated Universal Time (UTC)/Greenwich Mean Time (GMT). UTC/GMT time is the base time off of which all other times are calculated. In addition, UTC/GMT time is not affected by Daylight Savings Time transitions. When a DST transition occurs, UTC/GMT time does not change; instead everyone s difference from UTC/GMT times changes. To illustrate, if you are in California, the difference between the local time and UTC/GMT time is -8 hours when on Pacific Standard Time (November through March). When Daylight Savings Time goes into effect in early March and clocks are set ahead, the base UTC/GMT time does not change. Instead, clocks in California are moved ahead one hour, to Pacific Daylight Time (PDT), thereby altering the difference between local time and UTC/GMT time. Instead of the -8 hour difference for PST, the difference between PDT and UTC/GMT is only -7 hours. Thus the local time is changed, but the base UTC/GMT time from which the local time is derived does not change. This is an important point to understand, because it means that TimeSync is not affected by transitions to/from Daylight Savings Time. TimeSync always operates using UTC/GMT time, thus any local time changes for Daylight Savings Time are transparent to it. However, it also means that your system clocks must be kept in UTC/GMT time in order for TimeSync to accurately synchronize those clocks with other systems. If a given system clock is not stored in UTC/GMT time, TimeSync provides a configurable GMTOffset value that you can set so that TimeSync can make the necessary corrections when calculating time differences. See Process Options for more information on how to set this value. If you are unsure of how your system clock is currently configured, you can check it as follows: On NonStop Guardian, use the systimes command to show the current local time (LCT) and GMT time: TACL 1> systimes 30 Jun 2007, 10:05: LCT 30 Jun 2007, 17:05: GMT 29 Jun 2007, 16:38: Cold Load (LCT) 21 Jun 2006, 23:17: Sysgen (LCT) HP NonStop Time Synchronization User s Guide Page 16 of 86

17 On NonStop OSS, use the date command to display the current local time, and the date u command to show UTC/GMT time: /tmp > date Thu Jul 12 11:06:42 PDT 2007 /tmp > date -u Thu Jul 12 18:06:52 UTC 2007 On Linux, you can also use the date and date u commands as described above: /tmp > date Thu Jul 12 12:08:48 CDT 2007 /tmp > date -u Thu Jul 12 17:08:50 UTC 2007 On Windows, double-click the clock in the system tray to check time settings. Once you have determined how your local clock is set up, you can configure TimeSync accordingly. Again, see Process Options for more information on setting up the GMTOffset value for your system if necessary. Safely Updating Local System Clocks A common problem in attempting to synchronize clocks is that some time changes can adversely impact applications that are running on the system. This is particularly true in two different cases: 1. A drastic time change that causes the clock to jump by a large amount, for example setting the system clock ahead by an hour. This is problematic because many applications have some notion of real time and rely on it for scheduling tasks, tracking progress, and measuring throughput. A sudden large jump in time can wreak havoc with those activities. For example, an application might have a list of tasks that are to be initiated at certain times of day. A sudden change in the system clock may cause some of these tasks to be skipped, or to be invoked in a burst of activity while the application tries to catch up for the time that was missed. 2. Setting the system clock back by any amount of time. This is a particularly troublesome thing to do because many applications assume that time will never move backward, and are not designed to handle cases of a given time repeating itself. For example, an application might rely on the system clock for generating a unique ID for a transaction, or for generating a unique key for a database record. If the system clock is set back as part of an effort to synchronize time, there exists a very real possibility that those same unique IDs or keys could be generated again, which in HP NonStop Time Synchronization User s Guide Page 17 of 86

18 turn could result in data loss or corruption. TimeSync addresses both of these issues and lets you tailor its behavior through various configuration options. To prevent sudden drastic changes in time, TimeSync can be configured to drift clock changes in slowly over a longer period, thereby eliminating jumps in time that can be problematic for applications. To eliminate potential issues with the system clock being set backward, TimeSync can instead be configured to drift backward changes in slowly as well. In this case, TimeSync never alters the system clock to an earlier time. Instead, it works by slowing down how quickly time moves forward on the system, essentially waiting for the reference source to catch up before resuming normal timekeeping. This does not, however, mean that time stops on the local system. Instead, it moves forward slightly more slowly than real time until the clocks are synchronized. Options to control how TimeSync updates the local system time can be set in the TimeSync configuration file, or via the TimeCom CI. See Configuring TimeSync for more information on how to set TimeSync up for your particular environment NonStop TimeSync Architecture NonStop TimeSync consists of three components: the TimeSync process itself adjusts the local system time if client mode is enabled and/or provides reference times to other sources if server mode is enabled; the TimeSync configuration file contains settings to control the TimeSync process; and the TimeCom command interpreter provides a user interface to dynamically query and update TimeSync process settings. There are four versions of NonStop TimeSync: TimeSync for NonStop (T0811) provides time synchronization for HP NonStop servers running G06.00 or later, HP Integrity NonStop servers running H06.00 or later, HP Integrity NonStop BladeSystem servers running J06.00 or later, and HP NonStop X servers running L15.02 or later. It consists of two versions of TimeSync, one that executes in the Guardian environment and one that executes in the Open System Services (OSS) environment. You can use either version, depending on your preferences for your particular system. TimeSync for Linux (T0812) provides time synchronization for Linux servers running RedHat Enterprise Linux 3.0 or later, or Suse Linux 9.0 or later. HP NonStop Time Synchronization User s Guide Page 18 of 86

19 TimeSync for Windows (T0813) provides time synchronization for Windows systems running Windows XP or Windows 2003 Server or later. TimeSync capabilities are largely equivalent between platforms. In all cases it has the ability to run both as a client (wherein it adjusts local system time based on reference times received from other sources) and as a server (in which case it supplies reference times to other clients). The product components are also the same on each platform, and consist of the TimeSync process itself, the TimeCom command interpreter, and the TimeSync configuration file. Unless otherwise stated, any reference to a TimeSync capability, feature, option, or command in this document applies to all platforms. Because almost all TimeSync features are available on all supported platforms, you have a great deal of flexibility in how you choose to configure TimeSync within your network. Any platform/system can act as a server, and any platform/system can act as a client. Thus it s really up to you to decide which configuration makes the most sense for your particular environment. For example, Figure 1-1 shows one way that TimeSync can be configured to manage time across systems: HP NonStop Time Synchronization User s Guide Page 19 of 86

20 Figure 1-1. TimeSync Example Architecture In this example, TimeSync running on a Linux server (Linux3), with both client mode and server mode enabled, obtains time from the time.nist.gov and clock.redhat.com Internet time sources. It then supplies time to several HP NonStop servers, Windows systems, and other Linux systems running TimeSync in client mode. The result is that all system clocks are kept in sync. HP NonStop Time Synchronization User s Guide Page 20 of 86

21 2. TimeSync Quick Start This section is intended to provide a brief overview of the steps required to install and run TimeSync on your system(s). It does not replace the other material contained in this manual. Please read the other sections thoroughly before deploying TimeSync in your environment. In general, you will need to follow the steps below in order to get TimeSync up and running: 1. Install TimeSync on your system(s). For TimeSync version 1.3 or earlier on NonStop systems, and for all versions of TimeSync on Windows and Linux systems, this requires loading the correct version of the TimeSync CD, copying files to the system in question, and running any installation-related scripts. For TimeSync version 1.4 or later on NonStop systems, TimeSync is included on the SUT and installed automatically. See Installing NonStop TimeSync for installation details for the particular platforms you are interested in. 2. Obtain a license key if necessary. On HP Integrity NonStop X systems (x86 based), TimeSync is included in the OS bundle and hence it does not need a separate license key. On HP Integrity NonStop systems (Itanium based) TimeSync does not need a license key on NB56000c and NB56000C2 NonStop Poulson blade systems (Itanium Poulson based) as it is a mandatory add-on with these systems. For NB54000 or earlier systems (Guardian or OSS), or TimeSync version 1.3 or earlier, TimeSync continues to be an optional product and hence you must obtain a license key by sending a request to [email protected]. Your license request should include the product name (NonStop TimeSync), the system serial number, system type, node name, number of processors, and OS version for each system on which TimeSync will run. Please note that TimeSync will not start on a given system until a valid license key has been installed. A license key is not required for Windows or Linux systems. 3. Configure TimeSync by editing the timesync.conf file (OSS, Windows, and Linux) or TSCONF file (Guardian) using any text editor. 4. If you will be running TimeSync with client mode enabled (in other words, you will be using TimeSync to set the local system time), add at least one TimeSource to the [Client] section of the configuration file. 5. If you will be running TimeSync with client mode enabled, HP recommends that you initially enable ReportOnly mode by setting the ReportOnly value in the [Client] section of the configuration file to True. TimeSync will then determine the difference between the local system time and the reference time, and report that difference to you. At that HP NonStop Time Synchronization User s Guide Page 21 of 86

22 point you can decide how to alter any other configuration settings, and then enable time synchronization by setting ReportOnly to False via the TimeCom CI. 6. If you will be running the Guardian version of TimeSync, set the Transport name in the [Process] section of the configuration file to the name of the TCP/IP process that TimeSync should use for communication. It is not necessary to set this value for any other platform. 7. If you will be running TimeSync on a system in which another application utilizes port 123, shut down that application or change the LocalPort value in the [Process] section of the TimeSync configuration file to an unused port number. 8. Make any other configuration changes necessary; see Configuring TimeSync for details on all configuration options. 9. Save all configuration changes and exit the text editor. 10. If you will be running TimeSync with client mode enabled, disable the time synchronization capabilities of any other software running on the system (e.g. ASAP or NSX on NonStop, NTP client on Linux, NTP client on Windows). 11. Start TimeSync as described in Running TimeSync. 12. Monitor TimeSync activity using a system log viewer (e.g. EMSA or WebViewpoint on NonStop, Windows Event Viewer on Windows, or Syslog Viewer on Linux). 13. Check TimeSync status using the TimeCom CI. HP NonStop Time Synchronization User s Guide Page 22 of 86

23 3. Installing NonStop TimeSync This section covers the procedures for installing TimeSync on NonStop, Linux and Windows systems. 3.1 Installing TimeSync on a NonStop Server TimeSync 1.4 is delivered on the SUT. TimeSync 1.3 and prior versions are packaged on a CD as an independent product. To install TimeSync on a NonStop server, proceed as follows: 1. For TimeSync 1.4, the TimeSync files will be placed on the system from the SUT. For TimeSync 1.3 and earlier, run the IPSetup program on the product CD to begin installation, and follow the on-screen prompts to copy the TimeSync files to the NonStop system. 2. Files will be placed into the product subvolume, installation subvolume and/or SOFTDOC subvolume, as described below: File Name Placed Description OSSPAX A OSS pax archive file containing TimeSync for OSS files README A The product README file (TimeSync 1.3 and earlier) SOFTDOC A,C The product SOFTDOC file TIMECOM A.B TimeCom object file TIMESYNC A,B TimeSync process object file TSCONF A,B TimeSync configuration file ZTIMGP D TimeSync persistent process configuration file A The product subvolume; for example $DSMSCM.ZTIMES. B The installation subvolume; normally $SYSTEM.SYSTEM (optional). C The SOFTDOC subvolume; for example, $SYSTEM.ZSOFTDOC (optional). D The configuration subvolume; normally $SYSTEM.ZCNFDEFS (optional). 3. If you plan to run the Guardian version of TimeSync, use DSM/SCM to accept and install the new software onto the system if you wish to do so. DSM/SCM will HP NonStop Time Synchronization User s Guide Page 23 of 86

24 automatically configure TimeSync to run as a persistent process with name $TIME. Otherwise, you can now run TimeSync directly from either the installation subvolume or product subvolume. You can also manually configure TimeSync to run under the control of the persistence manager using SCF. For example: -> assume process $ZZKRN -> add process $ZZKRN.#TimeSync, & cpu 1, & name $TIME, & program $SYSTEM.SYSTEM.TIMESYNC, & hometerm $ZHOME, & autorestart 5, & startmode APPLICATION 4. If you plan to run the OSS version of TimeSync, copy the OSSPAX file from the product subvolume to an OSS directory, adding a.pax extension, and use the pax utility to extract the file contents. For example, from an OSS shell prompt, do the following (assuming you used IPSetup to place the TimeSync files in $DSMSCM.ZTIMES): [root tmp]# cp p /G/dsmscm/ztimes/osspax /var/tmp/osspax.pax [root tmp]# pax rf /var/tmp/osspax.pax The pax file contents will be extracted to the product installation directory /usr/tandem/timesync. You can then configure and run TimeSync from that location. 5. If you are running TimeSync 1.3 or earlier, or are running on an NB54000 system or earlier, obtain and install a license key for the product by sending an request to [email protected]. In the request, include the system number, system type, node name, number of processors, and OS version for each system on which TimeSync will run. In return you will receive a license file for each system containing the license key for that system. This file must be placed in $SYSTEM.SYSTEM, and must be named TIMESLIC regardless of whether you are running the Guardian or OSS version of TimeSync. Once a valid license key has been installed, TimeSync will be able to run on that system. TimeSync 1.4 does not require a license key on NonStop Poulson systems (NB56000) as it is a mandatory add-on with these systems, nor is a license key required for NonStop X systems. 6. Edit the TimeSync configuration file (TSCONF in Guardian or timesync.conf in OSS) and create a custom configuration for the system as described in Configuring TimeSync. HP NonStop Time Synchronization User s Guide Page 24 of 86

25 7. If you will be running TimeSync with client mode enabled (i.e. TimeSync will be updating the local system time), you should disable time synchronization in products such as NSX and ASAP to avoid potential erratic changes to system time. 8. In order for the TimeCom CI to communicate with TimeSync, a loop-back route (address ) must be configured for the TCP/IP process that TimeSync will use for communication. 3.2 Installing TimeSync on a Linux Server TimeSync is packaged on a CD as an independent product. For Linux, two different installation methods are available: RPM (RedHat Package Manager) and tar archive file. The advantage of using the RPM-based installer is that RPM tracks and manages all packages installed on your system, which makes it easy to check what has been installed, upgrade to newer versions, and uninstall products. However, RPM also gives you less flexibility in terms of how the product is installed. For customers who prefer to more closely control the installation process, the TimeSync for Linux CD also contains a tar archive of the product files. You can extract the contents of this and then install the product as you wish. To install TimeSync using the RPM-based installer, proceed as follows: 1. Place the CD into the CD drive on the Linux system. 2. Mount the CD if your system is not configured to do so automatically, for example: [root tmp]# mount /mnt/cdrom 3. Change to the WS_SW directory on the CD, for example: [root tmp]# cd /mnt/cdrom/ws_sw 4. Use rpm to install TimeSync on your system, for example: [root WS_SW]# rpm --install TimeSync i386.rpm The following files will be installed into the /usr/bin/timesync directory: File Name ReadMe.txt timecom timesync timesync.conf Description The product README file TimeCom object file TimeSync process object file TimeSync configuration file HP NonStop Time Synchronization User s Guide Page 25 of 86

26 TimeSync User s Guide.pdf TimeSync manual (this document) in PDF format In addition, the TimeSync initialization script file, named timesync, will be installed to the /etc/init.d directory, and TimeSync will be added to the list of services/daemons to be started when the system boots. 5. Dismount the CD if your system is not configured to do so automatically, for example: [root WS_SW]# cd /tmp [root tmp]# eject /mnt/cdrom 6. Edit the TimeSync configuration file, timesync.conf, and create a custom configuration for the system as described in Configuring TimeSync. 7. If you will be running TimeSync with client mode enabled (i.e. TimeSync will be updating the local system time), you should disable the built-in Linux NTP client to avoid potential erratic changes to system time. 8. In order for the TimeCom CI to communicate with TimeSync, loop-back support (address ) must be enabled on the system. To install TimeSync using the tar archive file, proceed as follows: 1. Place the CD into the CD drive on the Linux system. 2. Mount the CD if your system is not configured to do so automatically, for example: [root tmp]# mount /mnt/cdrom 3. Create an installation directory on your system and change to it, for example: [root tmp]# mkdir /usr/local/timesync [root tmp]# cd /usr/local/timesync 4. Copy the archive file from the WS_SW directory on the CD to the directory created above, for example: [root timesync]# cp /mnt/cdrom/ws_sw/timesync tar.gz./ 5. Use the tar utility to extract the archive contents, for example: [root timesync]# tar xzvpf TimeSync tar.gz The following files will be extracted to the current directory: File Name ReadMe.txt Description The product README file HP NonStop Time Synchronization User s Guide Page 26 of 86

27 timecom timesync timesync.conf timesync.init TimeSync User s Guide.pdf TimeCom object file TimeSync process object file TimeSync configuration file TimeSync init script TimeSync manual (this document) in PDF format 6. Move/copy files to any other location on your system if you wish to do so. 7. If you would like TimeSync to start automatically when the system boots, you will need to copy the initialization script to the /etc/init.d directory, and also add TimeSync to the system startup scripts. For example: [root timesync]# cp p timesync.init /etc/init.d/timesync [root timesync]# /sbin/chkconfig -add timesync Note that in the above, the name of the file in the /etc/init.d folder must match the name supplied following the /sbin/chkconfig -add command (in this case, both are timesync ). In addition, if you choose to start TimeSync at system boot time, be sure that the RunAsService flag in the timesync.conf file is set to True. See Process Options below for more information. 8. Dismount the CD if your system is not configured to do so automatically, for example: [root WS_SW]# cd /tmp [root tmp]# eject /mnt/cdrom 9. Edit the TimeSync configuration file, timesync.conf, and create a custom configuration for the system as described in Configuring TimeSync. 10. If you will be running TimeSync with client mode enabled (i.e. TimeSync will be updating the local system time), you should disable the built-in Linux NTP client to avoid potential erratic changes to system time. 11. In order for the TimeCom CI to communicate with TimeSync, loop-back support (address ) must be enabled on the system. HP NonStop Time Synchronization User s Guide Page 27 of 86

28 3.3 Installing TimeSync on a Windows Server TimeSync is packaged on a CD as an independent product. To install TimeSync on a Windows system, proceed as follows using the product CD: 1. Place the CD into the CD drive on the Windows system. The TimeSync installer should start automatically. If it does not, locate TimeSyncSetup.exe in the WS_SW folder on the CD and double-click it to begin installation. 2. Follow the on-screen instructions to install TimeSync. It is recommended that the default installation options be chosen. The following files will be installed into the default program files folder (e.g. C:\Program Files\HP\TimeSync for Windows): File Name License.txt ReadMe.txt TimeCom.exe TimeSync.conf TimeSync.exe TimeSync User s Guide.pdf Description The product license file The product README file TimeCom object file TimeSync configuration file TimeSync process object file TimeSync manual (this document) in PDF format 3. Edit the TimeSync configuration file, TimeSync.conf, and create a custom configuration for the system as described in Configuring TimeSync. 4. If you will be running TimeSync with client mode enabled (i.e. TimeSync will be updating the local system time), you should disable the built-in Windows NTP client to avoid potential erratic changes to system time. 5. In order for the TimeCom CI to communicate with TimeSync, loop-back support (address ) must be enabled on the system. HP NonStop Time Synchronization User s Guide Page 28 of 86

29 4. Configuring TimeSync TimeSync configuration settings are stored by default in the timesync.conf file (Windows, Linux, and OSS) or the TSCONF file (Guardian) located in the TimeSync program directory. TimeSync loads this configuration information immediately at startup. To control TimeSync behavior, you can either alter the settings in this file before starting the process, or else change settings dynamically using the TimeCom CI. 4.1 Location of the Configuration File HP recommends that the default location be used for the TimeSync configuration file, however this location can be changed if you wish to do so. If it is changed, it must then be referenced using the conf command line option when running the TimeSync process. The conf option overrides the default behavior and causes configuration data to be loaded from the location you specify. The syntax for the option is: -conf=<configuration file name> where <configuration file name> is the fully qualified name of the configuration file that the process should load. For example, if the configuration file is located at /etc/timesync/myconf.conf on a Linux system, the command to start the TimeSync process would be:./timesync conf=/etc/timesync/myconf.conf Note that when a configuration file is specified via the conf option, the configuration file located in the TimeSync program directory is not loaded. The process loads only the file defined via the conf option; it does not load both the default configuration file and the specified file. If the default location of the TimeSync configuration is changed, the TimeCom command interpreter is affected as well because it also loads the configuration file when it runs. As a result, in this case TimeCom must be started using the serverconf command-line option, or the SERVERCONF command must be the first command entered after starting TimeCom. For example, if the configuration file is located at /etc/timesync/myconf.conf on a Linux system, the command to start the TimeCom process would be:./timecom.exe serverconf=/etc/timesync/myconf.conf 4.2 Structure of the Configuration File The configuration file consists of several distinct sections, each with options pertaining to HP NonStop Time Synchronization User s Guide Page 29 of 86

30 a particular functional area. Sections are denoted by a section name contained in square brackets: for example, [Process]. The configuration file can contain any or all of these sections: [Process] The [Process] section contains settings related to general TimeSync process attributes. [Server] The [Server] section contains settings related to TimeSync running as a time source server (i.e. supplying time to remote systems). [Client] The [Client] section contains settings related to TimeSync running as a time source client (i.e. obtaining time information from one or more remote time sources). [Logging] The [Logging] section contains settings related to TimeSync s dedicated logging mechanism. These settings affect TimeSync s logging mechanism only and do not control what information is written to the system log on any platform. [Tracing] The [Tracing] section contains settings related to TimeSync s built-in trace facility. Each section of the configuration file can contain one or more option settings that relate to that section. These options are specified using keyword/value pairs, with one such pair given per line. The format for a keyword/value pair is: <option keyword> [=] <option value> The equal sign (=) is optional. Some examples of valid configuration option specifications would be: LocalPort = 123 ServerMode False Once the TimeSync process encounters a section in the configuration file, all subsequent option specifications are treated as part of that section until another section is encountered or until the end of the configuration file is reached. Comments can be added to the configuration file wherever desired. Any line beginning with a # character is treated as a comment line and is ignored, as are all lines containing HP NonStop Time Synchronization User s Guide Page 30 of 86

31 only white space characters. 4.3 Configuration Options The timesync.conf/tsconf file can contain any or all of the options described below. If the configuration file does not specify a given option, TimeSync uses the default value defined for that option. Descriptions for each option follow Process Options Process configuration options are contained in the Process section of the configuration file. These options specify general run-time parameters for TimeSync. AutoSave True False Controls whether the TimeSync process automatically saves configuration changes in the configuration file. If AutoSave is True, any changes you make to the TimeSync configuration using TimeCom are immediately written to the configuration file, and thus will be re-applied the next time TimeSync is run. If AutoSave is False, the changes you make using TimeCom alter the current run-time behavior of TimeSync only, and are not preserved in the configuration file. Therefore the next time TimeSync is run the settings will not be re-applied. Note that if AutoSave is True, it is not necessary to use the TimeCom SAVE command since all configuration changes are saved automatically. Value Range: True or False Default Value: True Example: AutoSave = False GMTOffset <value> The offset, in seconds, between the local system clock and GMT/UTC time. In most cases system clocks are kept in GMT/UTC time, and time values are then converted as needed to Local Civil Time (LCT). Note that this conversion to LCT is where any time zone offsets are applied as well. However, in some cases users may choose to run their system clock on something other than GMT/UTC time. If that is the case, TimeSync can be configured to allow for this offset by setting the GMTOffset value. For example, if your system clock is set to one hour later than GMT/UTC time, the GMTOffset value HP NonStop Time Synchronization User s Guide Page 31 of 86

32 would be Note that the GMTOffset value is not in any way related to time zone information for your system. Time zone data is not used by TimeSync and has no impact on its behavior because TimeSync performs all clock operations using GMT/UTC time. Instead, the GMTOffset value should only be used if you have explicitly set your system clock to something other than true GMT/UTC time. Value Range: to Default Value: 0 Example: GMTOffset = LocalAddress <value> The IP address/interface on the local system which the TimeSync process will use to communicate with remote systems. If this value is not set, TimeSync will use any local address. If this value is set, TimeSync will communicate using the specified address only. This option is particularly important in cases where the local system is configured with multiple IP addresses, and each address/interface is connected to a different network. In this situation, you will need to specify which local address TimeSync should utilize in order to ensure that all TimeSync traffic is routed to the correct network. Note that specifying a local address value also means that TimeSync will not operate over the loop-back interface, which is typically used for communication on the local system between the TimeCom CI and the TimeSync server. In this case, by default TimeCom will communicate with the TimeSync server using the configured local address instead. Value Range: A legal dotted-decimal IP address Default Value: Not set (any address can be used) Example: LocalAddress = LocalPort <value> The port number on the local system which the TimeSync process will use to communicate with remote systems. If this value is 0, TimeSync will pick a random, unused port. However, note that specifying a port number of 0 will make it impossible for the TimeCom CI to communicate with the TimeSync process unless you first HP NonStop Time Synchronization User s Guide Page 32 of 86

33 determine the port number being used by TimeSync and manually set that value using the TimeCom SYSTEM command. For that reason, it is recommended that you always supply a dedicated port number for the TimeSync process. It is important to distinguish the LocalPort value from the remote port used to access a time source. As stated above, LocalPort is literally the port on the local machine that TimeSync uses to communicate with other systems. TimeSync must use a port on the local system at all times in order to be able to send requests to time sources (if client mode is enabled), receive requests from clients (if server mode is enabled), and receive commands from the TimeCom CI. However, when TimeSync is running with client mode enabled, it also must know the IP address/host name and port number of each defined time source. These remote port values are specified using the TimeSource statement as discussed in the Client Options section below, and should not be confused with the LocalPort value. Also, TimeSync defaults to using TCP/IP port 123 for communication with other TimeSync-enabled systems and NTP/SNTP servers. If you have the Windows NTP client enabled on Windows, or are running the NTP daemon on Linux, you will either need to disable them or else configure TimeSync to use a port other than 123 by changing the LocalPort value. It is recommended that you disable the Windows NTP client on Windows systems, and the NTP daemon on Linux systems, if you plan to run TimeSync in Client mode on those systems. If you do not do so, both TimeSync and the NTP client or daemon will attempt to adjust the local system clock, which in turn could lead to erratic system times. It is also recommended that you turn off time synchronization in products like ASAP and NSX on HP NonStop servers. Value Range: 0 through Default Value: 123 (the standard NTP/SNTP port) Example: LocalPort = 123 RunAsService True False Flag specifying whether the TimeSync process should run as a service/daemon. If this value is True, TimeSync will run as a daemon on Linux systems and as a service on Windows systems. If False, TimeSync will run as a standard (user) process. This option is supported on NonStop systems, but does not affect run-time behavior. On Windows systems, this value must match the manner in which TimeSync was originally installed. If TimeSync was installed as a Windows service, this value must be True. If HP NonStop Time Synchronization User s Guide Page 33 of 86

34 TimeSync was not installed as a Windows service, this value must be False. The TimeSync installer for Windows will set this value correctly based on the install type, thus you should not need to change it under ordinary circumstances. On Linux systems, this value should be set to True if the TimeSync process will be started during the system boot/startup sequence (if you install TimeSync for Linux using the RPM-based installer, TimeSync will automatically be configured to start at system boot time and the RunAsService value will be set to True in the default configuration file). If the TimeSync process will be started manually from a command prompt, then this value can be set to either True or False. If set to True, TimeSync will close the terminal when it starts up, change its default directory, and take other actions to try to ensure that it keeps running even in if there are system problems. If this value is set to False, TimeSync will run as a standard user process. Value Range: True or False Default Value: True Example: RunAsService = True Transport <process name> The name of the transport layer which the TimeSync process should use for communication. This parameter applies to the Guardian NonStop environment only, and specifies the name of the TCP/IP process that TimeSync will utilize for accessing the network. If this value is not set on a Guardian system, then TimeSync will use the process name given by the =TCPIP^PROCESS^NAME define, or else $ZTC0 if that value is not specified. This parameter is ignored on platforms other than Guardian. Value Range: A legal Guardian process ID Default Value: =TCPIP^PROCESS^NAME define or $ZTC0 Example: Transport = $ZTC Server Options Server configuration options are contained in the Server section of the configuration file. These options control how TimeSync behaves when running as a time source server. HP NonStop Time Synchronization User s Guide Page 34 of 86

35 AlwaysSendRefTS True False Flag controlling whether the TimeSync process should include a current reference timestamp when responding to a time request from an NTP client, even if ClientMode is not enabled on the TimeSync system. If ClientMode is enabled on the TimeSync system (in other words, TimeSync is configured both as a client and server simultaneously), reference timestamps are always included in responses to NTP clients, and the AlwaysSendRefTS flag has no effect. In this case, the reference timestamp will be the time at which the TimeSync system last synced its clock to an external source. If no sync has been performed yet, then the reference timestamp value will be 0. However, if ClientMode is disabled on the TimeSync system, then there is no last sync time reference timestamp value to return to an NTP client. In this case, if the AlwaysSendRefTS value is True, then the TimeSync process will set the reference timestamp to the current time. If the AlwaysSendRefTS value is False, then the reference timestamp will be 0. Most current NTP clients ignore the reference timestamp field in NTP responses. But some older clients, such as ntpdate on Linux systems, check the reference timestamp field and will invalidate responses from time sources whose clocks have not been synced recently enough. This can be an issue in some TimeSync configurations because in many cases the TimeSync server is intended to be the primary time source and therefore is not synced with any external clock. Setting the AlwaysSendRefTS flag to True in this situation causes TimeSync to include a reference timestamp in the response and thereby allows the TimeSync server to act as a time source to systems running older NTP clients such as ntpdate. Value Range: True or False Default Value: True Example: AlwaysSendRefTS = False ServerMode True False Flag controlling whether the TimeSync process should behave as a time source server and respond to time requests from remote systems. If True, the TimeSync process will listen for and respond to time requests from remote systems. If False, TimeSync will not listen for nor respond to time requests from remote systems. Note that TimeSync can HP NonStop Time Synchronization User s Guide Page 35 of 86

36 run as both a time source client and a time source server simultaneously. Value Range: True or False Default Value: True Example: ServerMode = False Client Options Client configuration options are contained in the Client section of the configuration file. These options control how TimeSync behaves when running as a time source client. ClientMode True False Flag controlling whether the TimeSync process should behave as a time source client and obtain time information from remote systems. If True, the TimeSync process will run as a time source client, obtain time information from the defined time source, and set the local system time accordingly. If False, TimeSync will not run as a time source client. Note that TimeSync can run as both a time source client and a time source server simultaneously. Value Range: True or False Default Value: True Example: ClientMode = False DriftBackward True False Flag controlling whether operations involved in setting the system time backward (i.e. to an earlier time) take place immediately or are done incrementally in a fashion that prevents system time from actually moving backwards. If True, TimeSync drifts backwards time changes in over time by preventing time from moving forward rather than by actually setting the system clock back. If False, TimeSync simply sets the system time to the new time value. Value Range: True or False Default Value: True Example: DriftBackward = False HP NonStop Time Synchronization User s Guide Page 36 of 86

37 DriftBackwardThreshold <value> The threshold, in milliseconds, for which drift backward operations are allowed if the DriftBackward option is enabled. If the time change necessary is less than this value and DriftBackward is True, then backward time changes will be applied slowly (i.e. drifted). If the time change necessary is greater than this value, then the local system time will be set directly and time changes will not be drifted in. If the DriftBackwardThreshold is less than 0, then all backward time changes will be drifted in as long as DriftBackward is True. Value Range: -1 through Default Value: -1 (all backward changes should be drifted in) Example: DriftBackwardThreshold = 1000 DriftForward True False Flag controlling whether operations involved in setting the system time forward (i.e. to a later time) take place immediately or are done incrementally in a fashion that prevents abrupt time change on the system. If True, TimeSync drifts forward time changes in slowly. If False, TimeSync simply sets the system time to the new time value. Value Range: True or False Default Value: True Example: DriftForward = False DriftForwardThreshold <value> The threshold, in milliseconds, for which drift forward operations are allowed if the DriftForward option is enabled. If the time change necessary is less than this value and DriftForward is True, then forward time changes will be applied slowly (i.e. drifted). If the time change necessary is greater than this value, then the local system time will be set directly and time changes will not be drifted in. If the DriftForwardThreshold is less than 0, then all forward time changes will be drifted in as long as DriftForward is True. Value Range: -1 through Default Value: -1 (all forward changes should be drifted in) Example: DriftForwardThreshold = 1000 HP NonStop Time Synchronization User s Guide Page 37 of 86

38 MaxReplyDeviation <value> The threshold, in milliseconds, for determining whether a time response is acceptable or not. If the time specified in a response varies from the local system time by more than the MaxReplyDeviation amount, then the response is discarded by the TimeSync process. This is useful for preventing situations in which an incorrect, invalid, or corrupted response from a time source could cause the local system time to be set to an erroneous value. Value Range: 0 through Default Value: (5 minutes) Example: MaxReplyDeviation = MaxReplyWindow <value> The amount of time, in milliseconds, for which the TimeSync process will wait for a response from a time source. If a response is received outside of this window, it will be discarded by the TimeSync process. Value Range: 0 through Default Value: 5000 (5 seconds) Example: MaxReplyWindow = 3000 ModifyClockRate True False Specifies whether TimeSync should modify the rate of the clock on the local system in addition to adjusting the time. By modifying the clock rate, the amount of time drift between synchronizations is minimized. For example, if the hardware clock of the local system drifts by 10 microseconds per hour, and TimeSync is configured to sync once per hour, then the local system time will drift by 10 microseconds between synchronization operations. If ModifyClockRate is True, TimeSync will detect the amount of drift in the local clock and modify the local system clock rate accordingly, thereby reducing or eliminating the drift. TimeSync will continue to perform synchronizations at the configured interval/times, but in these cases the amount of adjustment necessary will be lessened. HP NonStop Time Synchronization User s Guide Page 38 of 86

39 Note that this option is only supported on NonStop systems (both Guardian and OSS); it is not supported on Windows or Linux. For NonStop systems, the minium required operating system versions are H06.25 for H-series systems, J06.14 for J-series systems, and all L-series versions. Value Range: True or False Default Value: False Example: ModifyClockRate = True MultiSource True False Controls whether the TimeSync process uses a single time source to obtain a reference time, or if it obtains reference times from all defined sources simultaneously. If this value is set to False, TimeSync only communicates with a single time source, beginning with the first TimeSource defined in the configuration file. If TimeSync cannot communicate with that server, or receives an invalid reply, it moves to the next time source in the list until it receives a valid response. If MultiSource is set to True, TimeSync sends a request to every defined TimeSource each update interval. It then averages the times from those servers to determine the correct system time. In general, MultiSource should be set to False if you are accessing a reliable time source such as an Internet-based NTP server or a local precision clock device. However, if instead you are utilizing two or more local systems as your time sources, running in MultiSource mode can yield a more accurate reference time than running in single-source mode. This is the case because averaging reference times across systems will have the effect of reducing the impact of any individual system clock inaccuracies. Value Range: True or False Default Value: False Example: MultiSource = True RetryInterval <value> The frequency, in seconds, at which TimeSync will retry sending time synchronization requests in cases where an error occurs. Note that the RetryInterval value takes precedence over the UpdateInterval or SyncAt list in situations where TimeSync encountered an error when attempting to send a sync request. Thus if the configured UpdateInterval value or next sync time in the SyncAt list would call for a sync request to HP NonStop Time Synchronization User s Guide Page 39 of 86

40 be sent sooner than the configured RetryInterval, TimeSync will still use the RetryInterval value if it is retrying a previous sync attempt. TimeSync will continue to retry at that interval until a successful sync occurs or until the RetryLimit is reached, at which point it will resume use of the UpdateInterval value or SyncAt list. Value Range: 1 through Default Value: 60 (1 minute) Example: RetryInterval = 10 RetryLimit <value> The maximum number of times TimeSync will retry sending a time synchronization request in cases where an error occurs. If TimeSync encounters an error sending a sync request, it will retry the request, at the configured RetryInterval, up to RetryLimit times. Once a successful sync occurs or the RetryLimit value is reached, TimeSync will return to normal processing. Value Range: -1 through Default Value: -1 (no limit) Example: RetryLimit = 5 ReportOnly True False Controls whether or not TimeSync actually updates the local system clock when client mode is enabled. If this value is False, TimeSync updates the local system clock at each configured update interval based on the reference time(s) received from the current time source(s). If ReportOnly is True, TimeSync obtains reference times and reports the difference between the local system clock and those times via the system log, TimeSync log (if enabled), and the TimeCom CI. However it does not actually update the local system clock. Setting ReportOnly to True is particularly useful when TimeSync is first deployed on a new system, since it allows you to determine the time difference between the system and the defined time source(s) without changing the local system clock. Once you have done so, you can decide how to best configure TimeSync to synchronize clocks with the least amount of potential disruption to the system. Value Range: True or False HP NonStop Time Synchronization User s Guide Page 40 of 86

41 Default Value: False Example: ReportOnly = True SyncAt <value>[, <value>, ] Specifies the list of times each day at which TimeSync sends synchronization requests to the defined time source(s) in order to update the local system time. The list of SyncAt times is only utilized if client mode is enabled; if client mode is disabled, the SyncAt list is ignored. In addition, if one or more times are specified in the SyncAt list, TimeSync does not initiate sync operations based on the UpdateInterval value discussed below. Sync operations are only initiated at the configured SyncAt times. Value Range: {<empty string> hh[:mm[:ss]] [UTC LCT] } [, hh[:mm[:ss]] [UTC LCT], ], where <empty string> is a null/empty string, hh:[mm[:ss]] specifies the hour, minute, and second (using a 24-hour clock) at which the sync should occur, and [ UTC LCT ] specifies whether the time is a universal (UTC/GMT) time or a local (LCT) time. If a null/empty string is given, the SyncAt list is cleared and the UpdateInterval value is used to determine when sync operations should be initiated. If a time is supplied, the hour value is required; minute and second values are optional and default to 0 if not provided. The UTC and LCT designator is also optional and defaults to UTC if not provided. Both UTC and LCT times can be mixed in the SyncAt list. Default Value: Null/empty string Example: SyncAt = 01:00 LCT, 12:30:00 UTC, 23:59:59 LCT, 20 LCT SyncAt = TimeSource <value> Defines a time source server which TimeSync should use to obtain time information. The Client section of the configuration file can contain any number of TimeSource specifications. The TimeSync process will attempt to access these in the order specified in the configuration file. If TimeSync cannot access the first time source in the list, it will try the second, etc. If MultiSource is set to True, TimeSync will send a request to each defined TimeSource at every update interval. If you run TimeSync with client mode enabled, you must define at least one TimeSource in the configuration file, otherwise TimeSync will not be able to synchronize the local HP NonStop Time Synchronization User s Guide Page 41 of 86

42 system time. Value Range: {<IP address> <host name>}[:<remote port number>], where <IP address> is a legal dotted-decimal IP address, <host name> is a legal TCP/IP host name, and <remote port number> is a valid TCP/IP port number. If <remote port number> is not given, the default NTP/SNTP port number of 123 is used. Default Value: None (TimeSource definitions must be added to the configuration file) Example: TimeSource = :5000 TimeSource = time.windows.com UpdateInterval <value> The frequency, in seconds, at which time synchronization requests are sent to the remote time source and the local time updated. Note that the actual interval between the initiation of sync operations will be slightly larger than this value because TimeSync does not schedule the subsequent update until the current sync initiation is completed. In most cases, this means the interval between sync attempts will be the UpdateInterval value plus the MaxReplyWindow value.if one or more synchronization times are specified in the SyncAt list described above, TimeSync does not utilize the UpdateInterval value. Instead, sync operations are only initiated at the scheduled SyncAt times. Important!!! On NonStop systems, HP recommends that you set the UpdateInterval to no less than 360 seconds (6 minutes) for normal usage. Setting the UpdateInterval to a value less than this for a long period of time can lead to timekeeping anomalies on the system. In addition, please note that on NonStop systems the minimum UpdateInterval is 13 seconds. If you supply an UpdateInterval less than this, TimeSync will still only process updates every 13 seconds. This is necessary because of other auditing and synchronization tasks that TimeSync performs between updates. Value Range: 1 through Default Value: 3600 (1 hour) Example: UpdateInterval = Logging Options Logging configuration options are contained in the Logging section of the configuration HP NonStop Time Synchronization User s Guide Page 42 of 86

43 file. These options control TimeSync s built-in logging mechanism. Note that these options affect TimeSync s logging facility only, and do not in any way relate to messages logged to the system log. The TimeSync log file itself can be either a basic text file or an HTML text file, depending upon the HTMLFormat option described below. You can use any text or HTML file viewer to examine the log. TimeSync logs all error messages, as well as clock update messages, to the local system s event log (EMS for Guardian and OSS, syslog for Linux, and the Windows event log for Windows). As a result, it is typically not necessary to activate the TimeSync built-in logging mechanism unless you prefer to have a dedicated log file containing only TimeSync activity. ClearOnOpen True False If True, the log file is cleared when the TimeSync process starts up or logging is enabled. Clearing the log file at startup helps prevent the log file from growing too large. At the same time, it also could remove valuable log history data. Therefore this option should only be set to True if you are certain that the log file contains no useful historical data. Value Range: True or False Default Value: False Example: ClearOnOpen = True DeleteOnClose True False If True, the log file is deleted when the TimeSync process shuts down. Deleting log files when the process shuts down is an effective means of keeping log files from growing too large. However, doing so also eliminates any logging history, and such history could be useful for debugging purposes. Therefore, set this value to True only if your environment typically generates a large amount of expected log activity. Value Range: True or False Default Value: False Example: DeleteOnClose = True HP NonStop Time Synchronization User s Guide Page 43 of 86

44 Enabled True False If True, logging is enabled for the TimeSync process. If False, logging is disabled, and no messages are generated. Note, however, that messages are still written to the system s event logging subsystem. Value Range: True or False Default Value: False Example: Enabled = True FileName <value> The name of the TimeSync log file. If logging is enabled, log records are written to this file, in either HTML or text format. If you change this value, be sure to fully qualify the file name if RunAsService is set to True. This is necessary because TimeSync changes its default directory when running as a service/daemon. As a result, specifying a file name only, without path information, could cause the log file to be created in an unexpected location (e.g. in the root directory on Linux systems). Value Range: A valid file name for the platform in question Default Value: timesynclog.txt (OSS, Windows and Linux) or TSLOG (Guardian), located in the TimeSync program directory Example: FileName = $DATA.LOGFILES.TIMELOG HTMLFormat True False If True, log records are written in HTML format for easy viewing in any web browser. A meta refresh tag is included as well, so that the log file display in the browser will update automatically at regular intervals. If False, log records are written in plain text format. Value Range: True or False Default Value: False Example: HTMLFormat = True Level <value> The logging detail level to use. Level = 4 causes all error, warning, and informational HP NonStop Time Synchronization User s Guide Page 44 of 86

45 messages to be logged. Level = 3 causes all error and warning messages to be logged. Level = 2 causes all error messages to be logged. Level = 1 causes only critical error messages to be logged. The default value of 3 should be used under normal circumstances. Value Range: 1 through 4 Default Value: 3 (All error and warning messages are logged.) Example: Level = 4 Suppress True False If True, duplicate messages logged in succession are suppressed and counted, and a summary message is written to the log file indicating how many times the message occurred. If False, no suppression is performed and all log messages are written directly to the log file. Value Range: True or False Default Value: True Example: Suppress = False Tracing Options Tracing configuration options are contained in the Tracing section of the configuration file. These options define what data is traced, where trace data is written, and how much data is captured and retained. Enabled True False True if tracing is enabled and False if tracing is disabled. Tracing is disabled by default and should remain disabled unless you are trying to diagnose a problem and are instructed to enable it by HP support personnel. Value Range: True or False Default Value: False Example: Enabled = True HP NonStop Time Synchronization User s Guide Page 45 of 86

46 FileName <value> The name of the TimeSync trace output file. If tracing is enabled, trace data is written to this file in either HTML or text format. All trace data is captured in memory in order to reduce the impact of tracing on the TimeSync process. Trace data is written to the trace output file only when tracing is stopped or when the TimeSync process shuts down. If you change this value, be sure to fully qualify the file name if RunAsService is set to True. This is necessary because TimeSync changes its default directory when running as a service/daemon. As a result, specifying a file name only, without path information, could cause the trace output file to be created in an unexpected location (e.g. in the root directory on Linux systems). Value Range: A valid file name for the platform in question Default Value: timesynctrace.txt (OSS, Windows and Linux) or TSTRACE (Guardian), located in the TimeSync program directory Example: FileName = C:\TraceData\MyTrace.txt HTMLFormat True False If True, trace records are written in HTML format for easy viewing in any web browser. If False, trace records are written in plain text format. Value Range: True or False Default Value: False Example: HTMLFormat = True Mask <value> Defines the trace mask to use. This mask is set by combining (adding together) values from the trace mask table below. To trace more than one type of data, add the mask values for the relevant types together. For example, to trace UDP data sent and UDP data received, the mask would be 0x x = 0x Possible mask values are: Trace Mask Description HP NonStop Time Synchronization User s Guide Page 46 of 86

47 Value 0x x x x x x x x x x x x x x x x x x x x x x Critical errors Noncritical errors Warnings Informational messages Data received via interprocess communication Data sent via interprocess communication Insertion of queue items Removal of queue items Creation of objects (Do not enable unless instructed to do so by HP support. It could significantly affect the performance of the TimeSync process.) Destruction of objects (Do not enable unless instructed to do so by HP support. It could significantly affect the performance of the TimeSync process.) Internal object interface calls External low-level object interface calls Calls from external clients to the low-level object interface External high-level object interface calls Calls from external clients to the high-level object interface Items added to cache Items removed from cache Audit checks Data received from management applications Data sent to management applications Thread creation Thread destruction HP NonStop Time Synchronization User s Guide Page 47 of 86

48 0x x x x x x x x Timer activity General socket operations Data received via UDP Data sent via UDP Data received via TCP Data sent via TCP Data received via NTP Data sent via NTP Value Range: 0x x0FFFFFFF Default Value: 0x (critical and noncritical errors) Example: Mask = 0x0F80003F RecordLimit <value> Defines the maximum number of trace records to capture, where 0 = no limit. Once this limit is reached, no further trace records are captured unless Wrap is True. Value Range: 0 through , where 0 = no limit Default Value: 1000 Example: RecordLimit = 2500 Wrap True False If True, the trace wraps when the record limit is reached. Whenever a new trace record is captured, the oldest trace record is deleted. Value Range: True or False Default Value: False Example: Wrap = True HP NonStop Time Synchronization User s Guide Page 48 of 86

49 5. Running TimeSync This section describes how to run TimeSync on all supported platforms Guardian, OSS, Linux, and Windows. Because there are generally multiple mechanisms for starting TimeSync on any given system, it is important to understand how each mechanism works - and how it impacts the TimeSync configuration - before you run TimeSync the first time. 5.1 Starting TimeSync on Guardian The steps for starting TimeSync on Guardian differ depending upon whether you have configured TimeSync to run under the control of the persistence manager or not. In either case, though, starting TimeSync is simple. In addition, there are no specific changes that need to be made to the configuration file based on the method used. If TimeSync is not configured to run under the control of the persistence manager, then you can start it as you would any other application process. Since the goal is for TimeSync to run continuously in the background, HP recommends that you start the process nowait and assign a dedicated home terminal (e.g. $ZHOME). If TimeSync will run with client mode enabled, it must be started with SUPER group authority in order to update the local system time. For example, if TimeSync was installed to $SYSTEM.ZTIMES, the commands would be: TACL> logon super.super TACL> run $system.ztimes.timesync/name $TIME, nowait, term $ZHOME/ If the TimeSync configuration file is not named TSCONF, or does not reside in the program subvolume, you can supply the file location and name using the conf command-line option. If TimeSync is configured to run under the control of the persistence manager, which is recommended by HP, then it can be started directly from SCF, and will also be started automatically at system startup. If TimeSync will run with client mode enabled, it must be started with SUPER group authority in order to update the local system time. For example, if TimeSync was configured as a persistent process with name #TimeSync, the commands would be: TACL> scf HP NonStop Time Synchronization User s Guide Page 49 of 86

50 1-> assume process $zzkrn 2-> start #TimeSync 5.2 Starting TimeSync on OSS You can start TimeSync on OSS simply by executing timesync from a shell prompt, or by using the run command. In neither case are changes or specific settings required in the configuration file. If you want to start TimeSync directly from a shell prompt, HP recommends you launch it as a background process. If TimeSync will run with client mode enabled, it must be started with SUPER group authority in order to update the local system time. For example, if TimeSync was installed to /usr/tandem/timesync, the commands would be: [root tmp]# cd /usr/tandem/timesync [root tmp]#./timesync & You can also start TimeSync using the run command, which is useful for assigning it a process name, a home terminal, etc. If TimeSync will run with client mode enabled, it must be started with SUPER group authority in order to update the local system time. For example, if TimeSync was installed to /usr/tandem/timesync, the commands would be: [root tmp]# cd /usr/tandem/timesync [root tmp]# run name=/g/time./timesync If the TimeSync configuration file is not named timesync.conf, or does not reside in the program directory, you can supply the file location and name using the conf commandline option. 5.3 Starting TimeSync on Linux The process for starting TimeSync on Linux is dependent upon how TimeSync is configured and how it was installed. If you installed TimeSync using the RPM-based installer, or manually added HP NonStop Time Synchronization User s Guide Page 50 of 86

51 TimeSync as a service to be started at boot time as described in Installing TimeSync on a Linux Server, then TimeSync will automatically be run the next time the system is restarted. However, if you want to manually start the TimeSync service without restarting the system, you can do so by directly invoking the service startup script. Note that if TimeSync will run with client mode enabled, it must be started with root authority in order to update the local system time. For example, to start the TimeSync service manually, the commands would be: [root tmp]# cd /etc/init.d [root tmp]#./timesync start If TimeSync will be run as a Linux service/daemon, you must set the RunAsService value in the TimeSync configuration file (timesync.conf) to True. If you installed TimeSync using the tar archive file, and did not manually add TimeSync as a service to be started at boot time, then you can simply run TimeSync as you would any other application on the system. Since TimeSync is intended to run continuously, HP recommends that you start it as a background process. Alternatively, you can still set the RunAsService value in the TimeSync configuration file to True. Doing so will cause TimeSync to act as a daemon, even though it was not started during system startup and is not configured as a true Linux service. Note that if TimeSync will run with client mode enabled, it must be started with root authority in order to update the local system time. For example, if TimeSync was installed to /usr/bin/timesync, the commands to start it would be: [root tmp]# cd /usr/bin/timesync [root tmp]#./timesync & If the TimeSync configuration file is not named timesync.conf, or does not reside in the program directory, you can supply the file location and name using the conf commandline option. 5.4 Starting TimeSync on Windows As was the case for Linux, the process for starting TimeSync on Windows is dependent upon how TimeSync is configured and how it was installed. If you elected to install TimeSync as a Windows service (the default), then TimeSync HP NonStop Time Synchronization User s Guide Page 51 of 86

52 will automatically be run the next time the system is restarted. However, if you want to manually start the TimeSync service without restarting the system, you can do so using the Windows Services manager. To manually start the TimeSync service: 1. Click on the Start button 2. Choose Administrative Tools 3. Choose Services 4. In the Services browser window that opens, right click on TimeSync for Windows and choose Start If TimeSync will be run as a Windows service, you must set the RunAsService value in the TimeSync configuration file (timesync.conf) to True. If you did not install TimeSync as a Windows service, then you can run it as you would any other Windows application. Note that if TimeSync will run with client mode enabled, it must be started with Administrator authority in order to update the local system time. For example, if TimeSync was installed to the C:\Program Files\HP\TimeSync for Windows folder, the commands to start it would be: C:\> cd \Program Files\HP\TimeSync for Windows C:\Program Files\HP\TimeSync for Windows> timesync If TimeSync will not be run as a Windows service, you must set the RunAsService value in the TimeSync configuration file (timesync.conf) to False. If the TimeSync configuration file is not named timesync.conf, or does not reside in the program directory, you can supply the file location and name using the conf command-line option. HP NonStop Time Synchronization User s Guide Page 52 of 86

53 6. The TimeSync Command Interface The TimeSync product provides a command interpreter (CI) that can communicate with the local version of TimeSync as well as remote versions of TimeSync. The TimeSync CI (TimeCom) provides both command-line and interactive interfaces to execute commands against the TimeSync server process. The commands supported by TimeCom can: retrieve information about configuration settings in the TimeSync server; alter configuration settings online without restarting the TimeSync server; and retrieve status about time settings on any of the systems controlled by TimeSync. TimeCom loads the local TimeSync configuration file (timesync.conf/tsconf) at startup in order to determine how to communicate with the TimeSync process. When commands are specified on the command-line, the TimeCom CI will execute them and then terminate. The only exception is when the SERVERCONF command is specified and is the only or last command given. In that case the CI will execute commands through the SERVERCONF command and then enter interactive mode using the new configuration information. When multiple commands are specified on the command line, each command must be separated by a semi-colon. All commands can be entered with or without a preceding dash, ADD Command The ADD command adds a new TimeSource to the TimeSync configuration. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. The ADD command can only be issued against the local TimeSync server. ADD TimeSources {<IP address> <host name>}[:<remote port number>], <ip address> - the ip address of the new time source. HP NonStop Time Synchronization User s Guide Page 53 of 86

54 <host name> - the DNS host name of the new time source. <remote port number> - the port number of the new time source. Examples timecom > add TimeSources :123 timecom add TimeSources : CONF Command The CONF command instructs the TimeSync server to load the specified configuration file. The CONF command can only be issued against the local TimeSync server. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. It is important to distinguish between the CONF command and the SERVERCONF command. The CONF command causes the TimeSync process to load the specified configuration file, while the SERVERCONF command causes TimeCom to load the specified configuration file. CONF [<filename>] <filename> - is the name of the configuration file to load. If <filename> is not provided, TimeSync will load the default configuration file from the default location. Examples timecom > conf /etc/timesync/myconf.conf timecom conf $USERS.DATA.TIMECNF 6.3 FC Command The FC command edits and re-executes the prior TimeCom command. When you enter the FC command, TimeCom displays the prior command executed, and on the HP NonStop Time Synchronization User s Guide Page 54 of 86

55 subsequent line displays a single. prompt; this is known as an editing template. You can then edit the prior command using subcommands, as described below. After you enter the subcommands you want, press the RETURN key. Your edited command and a new editing template then appear. If you want to make more corrections to the edited command, you can enter more subcommands in the editing template and then press RETURN. If the edited command is correct, you can re-execute it by pressing RETURN without entering any subcommands. FC The syntax of the editing template is <subcommand> [ //<subcommand> ] : <subcommand> is any of the following: { R r } <replacement-text> { I i } <insertion-text> { D d } { R r } <replacement-text> replaces characters in the previous command, starting with the character displayed immediately above the R or r. A <replacement-text> preceded by R or r can be any string of characters, including spaces, and can itself begin with R, I, or D (or r, i, or d). Characters in <replacement-text> replace characters in the previous command on a onefor-one basis. If // follows this subcommand, all characters in <replacement-text> up to //, including spaces, replace characters in the previous command. Otherwise, replacement ends with the RETURN. { I i } <insertion-text> inserts characters into the previous command in front of the character displayed above the I or i. If // follows this subcommand, all characters in <insertion-text> up to //, including spaces, are inserted into the previous command. If no // appears, all characters up to the RETURN are inserted. { D d } deletes characters in the previous command. Any original character displayed above a D or d that begins a subcommand in the editing template is deleted. <replacement-text> HP NonStop Time Synchronization User s Guide Page 55 of 86

56 is any text that does not begin with R, I, or D (or r, i, or d). Characters in <replacementtext> replace characters immediately above them on a one-for-one basis. For example, a D in <replacement-text> replaces the character displayed above it instead of deleting it. <insertion-text> is any text that does not begin with R, I, or D (or r, i, or d). Characters in <insertion-text> are inserted into the prior command immediately in front of the character displayed by the I or i. // is a separator, allowing multiple subcommands on a given line. A subcommand can immediately follow one or more uppercase or lowercase D s without being preceded by //. Examples timecom > add TimeSources > fc > add TimeSources dddiremove > remove TimeSources INFO Command The INFO command will retrieve information about TimeSync configuration settings from a system running TimeSync. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. INFO [SYSTEM <system>] [BRIEF] <system> - is the IP address or DNS name and optional port number of the server from which information is to be retrieved. For example, system , system :1234, system dns.host.name, or system dns.host.name:1234. If <system> is not supplied, the local system will be used. HP NonStop Time Synchronization User s Guide Page 56 of 86

57 BRIEF - shows a partial list of the configuration information. Examples timecom >info System Local system:123 ( ) -- TimeSync Settings -- Version : , 15 August 2014, 18:00 Program File Name : C:\Program Files\HP\TimeSync\TimeSync.exe Process ID : 1948 Configuration File : C:\Program Files\HP\TimeSync\timesync.conf ServerMode AlwaysSendRefTS : True : True ClientMode : True DriftBackward : True DriftBackwardThreshold : -1 DriftForward : True DriftForwardThreshold : -1 MaxReplyDeviation : MaxReplyWindow : 5000 ModifyClockRate : True MultiSource : False RetryInterval : 60 RetryLimit : -1 ReportOnly : False SyncAt : UpdateInterval : 3600 TimeSource : :123 AutoSave : True GMTOffset : 0 HP NonStop Time Synchronization User s Guide Page 57 of 86

58 LocalAddress : LocalPort : 123 Transport : RunAsService : True LogEnabled : False LogFileName : C:\Program Files\HP\TimeSync\timesynclog.txt LogLevel : 3 LogClearOnOpen : False LogDeleteOnClose : False LogHTMLFormat : False LogSuppress : True TraceEnabled : False TraceFileName : C:\Program Files\HP\TimeSync\timesynctrace.txt TraceHTMLFormat : False TraceMask : 0x TraceRecordLimit : 1000 TraceWrap : False 6.5 REMOVE Command The REMOVE command removes one or more TimeSources from the TimeSync configuration. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. The REMOVE command can only be issued against the local TimeSync server. REMOVE TimeSources {<IP address> <host name>}[:<remote port number>], <ip address> - the ip address of the time source to be removed. HP NonStop Time Synchronization User s Guide Page 58 of 86

59 <host name> - the DNS host name of the time source to be removed. <remote port number> - the port number for the time source to be removed Examples timecom > remove TimeSources :123 timecom remove TimeSources : SAVE Command The SAVE command saves current TimeSync option settings to the TimeSync configuration file on the specified system. SAVE is redundant if AutoSave is set to True in the TimeSync configuration file. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. The SAVE command can only be issued against the local TimeSync server. Note that issuing the SAVE command does not alter the default configuration file name that will be used the next time TimeSync is started. TimeSync always defaults to using timesync.conf/tsconf as the configuration file; you must use the conf command-line option to override this at startup time, even if you previously did a SAVE and specified a different configuration file name. SAVE [<filename>] <filename> - is the name of the configuration file to save. If <filename> is not provided, TimeSync will save configuration data to the default configuration file. Examples timecom > save timecom save /etc/timesync/mytimesync.conf 6.7 SERVERCONF Command The SERVERCONF command instructs the TimeCom CI to load the specified configuration file. HP NonStop Time Synchronization User s Guide Page 59 of 86

60 It is important to distinguish between the CONF command and the SERVERCONF command. The CONF command causes the TimeSync process to load the specified configuration file, while the SERVERCONF command causes TimeCom to load the specified configuration file. SERVERCONF [<filename>] <filename> - is the name of the configuration file to load. If <filename> is not provided, TimeCom will load the default configuration file from the default location. Examples timecom > serverconf /etc/timesync/myconf.conf timecom serverconf $USERS.DATA.TIMECNF timecom serverconf $USERS.DATA.TIMECNF; add TimeSources SET Command The SET command alters configuration settings online for the TimeSync process. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. The SET command can only be issued against the local TimeSync server. SET <option> <value> <option> <value> - is one of the following SET options and values. For details of each, see the description of the various configuration file options in Configuration Options. RunAsService LocalAddress True False <ipaddress> HP NonStop Time Synchronization User s Guide Page 60 of 86

61 LocalPort GMTOffset Transport AutoSave ServerMode AlwaysSendRefTS ClientMode DriftBackward DriftBackwardThreshold DriftForward DriftForwardThreshold MaxReplyDeviation MaxReplyWindow ModifyClockRate MultiSource RetryInterval RetryLimit ReportOnly SyncAt <port number> <seconds> <Guardian process name> True False True False True False True False True False <milliseconds> True False <milliseconds> <milliseconds> <milliseconds> True False True False <seconds> <count> True False <sync time> [, <sync time>, ] TimeSources <ipaddress> <DNS name>[:<port>] [, <ipaddress> <DNS name>, ] UpdateInterval LogClearOnOpen LogDeleteOnClose LogEnabled <seconds> True False True False True False LogLevel 1-4 HP NonStop Time Synchronization User s Guide Page 61 of 86

62 LogFileName LogHTMLFormat LogSuppress TraceEnabled TraceMask TraceFileName <filename> True False True False True False <trace mask> <filename> TraceRecordLimit TraceWrap TraceHTMLFormat True False True False Examples timecom > set LogEnabled False timecom set LogEnabled False 6.9 SHOW Command The SHOW command outputs current configuration settings from the TimeCom CI. SHOW Examples Timecom > show TimeCom Settings: Target System Local Address :123 (Local system) timecom show HP NonStop Time Synchronization User s Guide Page 62 of 86

63 TimeCom Settings: Target System :123 (Local system) Local Address Transport $ZTC STATUS Command The STATUS command returns information about TimeSync on the server identified in the command. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. STATUS [SYSTEM <system> ] <system> - is the IP address or DNS name and optional port number of the server from which information is to be retrieved. For example, system , system :1234, system dns.host.name, or system dns.host.name:1234. If <system> is not supplied, the local system will be used. Note that a negative clock difference value indicates that the local system clock is too fast and needs to slow down or move backward; a positive value indicates that the local system clock is too slow and needs to speed up or move forward. Examples timecom >status System Local system:123 ( ) -- TimeSync System Status -- Current Time (GMT/UTC) : :45: Configured TimeSync GMTOffset : 0 Last Update Attempt Time (GMT/UTC) : :44: Last Update Attempt Result : Successful HP NonStop Time Synchronization User s Guide Page 63 of 86

64 Last Successful Update Time (GMT/UTC) : :44: Clock Difference At Last Update : seconds Source For Last Update : Next Update Time (GMT/UTC) : :00: SYNCNOW Command The SYNCNOW command causes TimeSync to immediately initiate a time synchronization operation, regardless of when the next sync operation is scheduled to occur. ClientMode must be enabled in order to initiate a sync operation. If TimeSync is configured to sync at a specified interval via the UpdateInterval value, the next normally scheduled sync time will be adjusted to occur at UpdateInterval seconds after the SYNCNOW operation was completed. If TimeSync is configured to sync at specific times via the SYNCAT list, subsequent sync operations will continue to occur as scheduled; the SYNCNOW operation will not affect those scheduled sync times. SYNCNOW [SYSTEM <system> ] <system> - is the IP address or DNS name and optional port number of the server from which information is to be retrieved. For example, system , system :1234, system dns.host.name, or system dns.host.name:1234. If <system> is not supplied, the local system will be used. Examples timecom >syncnow System Local system:123 ( ) Clock synchronization initiated HP NonStop Time Synchronization User s Guide Page 64 of 86

65 6.12 SYSTEM Command The SYSTEM command sets the IP address or DNS name and optional port number of a TimeSync server in the TimeCom CI. TimeCom will then send all further INFO and STATUS commands to the specified TimeSync server. The command can be issued as a command-line parameter or can be entered interactively at a TimeCom prompt. SYSTEM [<IP address> <DNS name>[:<port>]] <IP address> - is the IP address of a remote TimeSync server. <DNS name> - is the DNS name of a remote TimeSync server. <port> - is the optional port number of the remote TimeSync server. If <port> is not specified the port number defined in the TimeSync configuration file will be used. Note: If SYSTEM is entered without specifying any parameters the TimeCom CI will resume communication with the local copy of the TimeSync server. Examples timecom > system timecom SYSTEM :1234; INFO; STATUS HP NonStop Time Synchronization User s Guide Page 65 of 86

66 7. Appendix A: TimeSync Event Messages This appendix provides details about the event messages generated by TimeSync and logged to the system event log. The same message numbers and descriptions apply to all supported platforms unless otherwise stated. 7.1 General TimeSync Messages : TimeSync encountered an error during command line processing; process will exit TimeSync encountered an error while processing command line arguments and will exit. This error only occurs during startup. Cause. An invalid command-line argument was supplied to TimeSync. Effect. TimeSync does not start. Recovery. Correct TimeSync startup to remove the invalid command-line argument : TimeSync could not initialize to run as a service; process will exit TimeSync encountered an error while attempting to initialize its service infrastructure. This error only occurs during startup. Cause. An internal or system error occurred during service initialization. This will only occur on Windows or Linux platforms. Effect. TimeSync does not start. Recovery. Validate that TimeSync is being started with correct permissions, and that the system service configuration is correct (Windows only). If no problem is found, contact HP support. HP NonStop Time Synchronization User s Guide Page 66 of 86

67 : TimeSync version started TimeSync started successfully. version is the version of TimeSync; for example, Cause. TimeSync was started on the system. Effect. TimeSync begins processing. Recovery. Not applicable : TimeSync could not initiate operations; shutting down TimeSync could not initiate operations with the communication layer, and is shutting down as a result. This error only occurs during startup. Cause. TimeSync could not obtain a network connection, therefore it could not start successfully. Effect. TimeSync does not start. Recovery. Check to be sure that all network infrastructure is up and running (network device drivers, TCP/IP processes/daemons, etc.), and ensure that TimeSync is not configured to use a LocalPort that is currently being used by a different application : TimeSync shutting down due to error TimeSync encountered an internal error during normal processing that it could not recover from, and is shutting down as a result. Cause. An internal processing or resource error occurred from which TimeSync could not recover. Effect. TimeSync shuts down. Recovery. Check the system log and/or TimeSync log for additional messages detailing the specific cause of the error. HP NonStop Time Synchronization User s Guide Page 67 of 86

68 : TimeSync shutting down TimeSync is shutting down normally. Cause. The operator or system initiated a shutdown of the TimeSync process. Effect. TimeSync shuts down. Recovery. Not applicable : Error initializing application socket: description TimeSync could not initialize an application socket. description is the description of the error condition encountered. Cause. TimeSync could not obtain a socket from the communication infrastructure. Effect. TimeSync shuts down. Recovery. Check the system log and/or TimeSync log for additional messages detailing the specific cause of the error. Check to be sure that all network infrastructure is up and running (network device drivers, TCP/IP processes/daemons, etc.), and ensure that TimeSync is not configured to use a LocalPort that is currently being used by a different application : Select error on application socket, error number errnum TimeSync could not perform a select operation on an application socket (OSS, Linux, and Windows only). errnum is the specific error number returned by the sockets interface layer. Cause. An internal error in the sockets infrastructure. HP NonStop Time Synchronization User s Guide Page 68 of 86

69 Effect. TimeSync delays and then retries the operation. Recovery. Check the system log and/or TimeSync log for additional messages. Check to be sure that all network infrastructure is up and running (network device drivers, TCP/IP processes/daemons, etc.). If the problem still persists, contact HP support : Could not send TimeSync request; no time sources defined TimeSync could not send a request to obtain a reference time because no time sources were defined. This error can only occur if Client mode is enabled. Cause. Client mode was enabled but no time sources were defined in the TimeSync configuration file. Effect. TimeSync cannot adjust the local system clock because it cannot obtain a reference time. Recovery. Define one or more time sources in the TimeSync configuration file and restart the TimeSync process, or else specify one or more time sources interactively via the TIMECOM ADD TIMESOURCES or SET TIMESOURCES command : Could not resolve time source name host TimeSync could not resolve the supplied time source host name. host is the name of the time source that could not be resolved. Cause. An invalid/unknown host name was supplied, or TimeSync was unable to contact a DNS server to perform the name lookup. Effect. If MultiSource is set to False, TimeSync tries to send a request to the next defined time source in the list. If MultiSource is set to True, no reference time is obtained from the given source and thus that source is not factored into the average reference time calculation. Recovery. Supply a valid time source host name if necessary, and/or ensure that TimeSync can contact a valid DNS server. HP NonStop Time Synchronization User s Guide Page 69 of 86

70 : Could not obtain time source data while processing TimeSync response; action could not be completed TimeSync received a response from a time source, but cannot locate that time source in the list of defined sources. Cause. The time source was removed from the TimeSync configuration after a request was sent to the time source, but before a response was received. Effect. The response is discarded and the update or report operation is canceled. Recovery. Not necessary; TimeSync will automatically retry the update using the next configured time source : Could not obtain time source data while processing multisource TimeSync response; reference time could be affected TimeSync, while running with MultiSource enabled, received a response from a time source, but cannot locate that time source in the list of defined sources. Cause. The time source was removed from the TimeSync configuration after a request was sent to the time source, but before a response was received. Effect. The response is discarded and is not factored into the computed average clock reference time used to update the local system clock. Recovery. Not necessary; since the time source has been removed from the configuration, subsequent updates will not utilize the time source in question : Time source information could not be obtained; action could not be completed TimeSync could not obtain local time source information while processing an update or report operation. Note that this message can occur even if the ReportOnly option is enabled, since TimeSync still needs to obtain a reference time in order to calculate the HP NonStop Time Synchronization User s Guide Page 70 of 86

71 clock difference between systems. Cause. The time source was removed from the TimeSync configuration after a response was received from the source, but before the operation was completed. Effect. The response is discarded and the update or report operation is canceled. Recovery. Not necessary; TimeSync will automatically retry the update using the next configured time source : Could not proceed with operation due to time source error; time source source, error info: description TimeSync could not adjust the local system clock or complete a report operation because the response received from the configured time source was invalid. Note that this message can occur even if the ReportOnly option is enabled, since TimeSync still needs to obtain a reference time in order to calculate the clock difference between systems. source is the name/address of the time source from which the response was received. description is the specific error that occurred; for example, the response was received outside the configured window, the time source time was invalid, etc. Cause. The time source did not respond quickly enough, or the supplied reference time was invalid. Effect. The response is discarded and the update or report operation is canceled. Recovery. Not necessary; TimeSync will automatically retry the update using the next configured time source : No time sources defined; action could not be completed TimeSync, while running with MultiSource enabled, could not adjust the local system time or complete a report operation because no time sources were defined. Note that HP NonStop Time Synchronization User s Guide Page 71 of 86

72 this message can occur even if the ReportOnly option is enabled, since TimeSync still needs to obtain a reference time in order to calculate the clock difference between systems. Cause. No time sources were defined when TimeSync attempted to initiate an update or report operation Effect. The update or report operation is canceled. Recovery. Define one or more time sources in the TimeSync configuration file and restart the TimeSync process, or else specify one or more time sources interactively via the TIMECOM ADD TIMESOURCES or SET TIMESOURCES command : No valid responses were received from any time source; action could not be completed TimeSync, while running with MultiSource enabled, could not adjust the local system time or complete a report operation because no valid responses were received from any of the configured time sources. Note that this message can occur even if the ReportOnly option is enabled, since TimeSync still needs to obtain a reference time in order to calculate the clock difference between systems. Cause. No time source supplied a valid reference time. Effect. The update or report operation is canceled. Recovery. Verify that there are no network/connectivity issues present and ensure that there is at least one valid TimeSync or NTP time source configured. Also, if network resources are potentially overloaded, consider increasing the MaxReplyWindow value to give time sources more time to respond to a request : Local clock differs from the time source clock source by secs seconds; the local clock will [be adjusted be set will not be changed because ReportOnly mode is enabled] Client mode is enabled, and TimeSync is processing a local clock update. If ReportOnly mode is enabled, the message will show the time difference but will state that the local clock will not be updated. If ReportOnly mode is disabled and the change will be drifted HP NonStop Time Synchronization User s Guide Page 72 of 86

73 in, the message will state that the clock will be adjusted. Otherwise, if the change will not be drifted in, the message will state that the clock will be set. source is the name/address of the time source from which the reference time was obtained; if MultiSource is enabled, this value will be <Multi>. secs is the amount by which the clock needs to be updated. A negative value indicates that the local system clock is too fast and needs to slow down or move backward; a positive value indicates that the local system clock is too slow and needs to speed up or move forward. Cause. A TimeSync update was performed. Effect. The local system clock is updated if ReportOnly mode is disabled, otherwise the time difference is logged but no action is taken. Recovery. Not applicable : Could not obtain TimeSync license information; error-detail No license for TimeSync was found on the local system. error-detail contains details on the specific check that failed. Cause. The TimeSync license file was missing or contained invalid data. Effect. TimeSync will not start. Recovery. Obtain an updated license from HP by ing [email protected] : TimeSync license expired -number days ago, please [email protected] to renew the license; TimeSync will now shut down HP NonStop Time Synchronization User s Guide Page 73 of 86

74 The TimeSync license for the local system has expired. number is the number of days ago that the license expired. Cause. The TimeSync license expired and is no longer valid. Effect. TimeSync will not start, or will shut down if it is already running. Recovery. Obtain an updated license from HP by ing : TimeSync license will expire in number days, please to renew the license The TimeSync license for the local system will expire in the number of days shown. number is the number of days remaining before the license expires. Cause. TimeSync is running with a license that will expire in 30 days or less. Effect. TimeSync starts and executes normally. Recovery. Obtain an updated license from HP by ing [email protected] prior to the expiration in order to ensure that TimeSync remains operative. HP NonStop Time Synchronization User s Guide Page 74 of 86

75 7.2 Windows-specific Messages This section describes messages that are logged on Windows systems only. These messages will not be logged on any other platform : TimeSync shutting down due to error TimeSync is shutting down due to an error encountered during Windows service initialization. Cause. TimeSync could not interact with some portion of the Windows services infrastructure. Effect. TimeSync does not start. Recovery. Check the system log and/or TimeSync log for additional messages detailing the specific cause of the error : Error starting service control dispatcher; error number was errnum TimeSync service not started TimeSync could not start the Windows service control dispatcher and therefore could not interact with the Windows service infrastructure. errnum is the Windows service error that occurred. Cause. There was an error starting or communicating with the service control dispatcher. Effect. TimeSync does not start. Recovery. Check the system log and/or TimeSync log for additional messages detailing the specific cause of the error, and ensure that TimeSync is running with Administrator permissions HP NonStop Time Synchronization User s Guide Page 75 of 86

76 2002: Error registering service control handler; error number was errnum TimeSync service not started TimeSync could not register its control handler with the Windows services infrastructure. errnum is the Windows service error that occurred. Cause. There was an error communicating with the Windows services infrastructure while trying to register the TimeSync service control handler. Effect. TimeSync does not start. Recovery. Check the system log and/or TimeSync log for additional messages detailing the specific cause of the error, and ensure that TimeSync is running with Administrator permissions : Error trying to convert system time value; error was errnum TimeSync could not obtain the local system time while preparing to set the time. errnum is the Windows system error that occurred. Cause. Windows encountered a problem trying to supply the local system time. Effect. TimeSync does not adjust the local system time. Recovery. TimeSync will automatically retry the update. If the problem persists, it may be necessary to reboot the system : Error trying to set system time; error number was errnum TimeSync could not set the local system time. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to set the local system time. In most HP NonStop Time Synchronization User s Guide Page 76 of 86

77 cases this is a security-related issue. Effect. TimeSync does not set the local system time. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to get system time adjustment parameters; error number was errnum TimeSync could not obtain Windows system clock adjustment information. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to get details on current Windows clock adjustment settings. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to get token info to adjust system time; error number was errnum TimeSync could not obtain Windows token information in preparation for updating the local system time. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to get its process token data while preparing to update the local system clock. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. HP NonStop Time Synchronization User s Guide Page 77 of 86

78 Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to get privilege info to adjust system time; error number was errnum TimeSync could not obtain Windows privilege information in preparation for updating the local system time. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to get privilege data while preparing to update the local system clock. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to set privileges in order to adjust system time; error number was errnum TimeSync could not set Windows privileges in preparation for updating the local system time. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to set its privileges while preparing to update the local system clock. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync HP NonStop Time Synchronization User s Guide Page 78 of 86

79 process : Error trying to set system time adjustment parameters; error number was errnum TimeSync could not adjust the local system time. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to adjust the local system time. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to reset privileges after adjusting system time; error number was errnum TimeSync could not reset Windows privileges after completing a time adjustment. errnum is the Windows system error that occurred. Cause. TimeSync encountered a problem trying to reset its privileges after updating the local system clock. In most cases, this is a security-related issue. Effect. None, though depending upon the error, the next update could be impacted. Recovery. Verify that TimeSync is running with Administrator permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process. HP NonStop Time Synchronization User s Guide Page 79 of 86

80 7.3 Linux-specific Messages This section describes messages that are logged on Linux systems only. These messages will not be logged on any other platform : Error trying to adjust system clock; error number was errnum TimeSync could not adjust the local system time. errnum is the Linux system error that occurred. Cause. TimeSync encountered a problem trying to adjust the local system time. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with root permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error obtaining system time; could not proceed with time update TimeSync could not obtain the local system time while preparing to set the time. Cause. TimeSync could not retrieve the current local system time while preparing to perform a clock update. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with root permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to set system time; error number was errnum HP NonStop Time Synchronization User s Guide Page 80 of 86

81 TimeSync could not set the local system time. errnum is the Linux system error that occurred. Cause. TimeSync could not set the local system time. In most cases, this is a securityrelated issue. Effect. TimeSync does not set the local system time. Recovery. Verify that TimeSync is running with root permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process : Error trying to get system clock parameters; error number was errnum TimeSync could not obtain Linux system clock parameter information. errnum is the Linux system error that occurred. Cause. TimeSync encountered a problem trying to get details on current Linux clock adjustment settings. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with root permissions and that security policy on the system is not set up to prevent time adjustments by the TimeSync process. HP NonStop Time Synchronization User s Guide Page 81 of 86

82 7.4 OSS-specific Messages This section describes messages that are logged only on NonStop systems running the OSS version of TimeSync. These messages will not be logged on any other platform : Error obtaining system time; could not proceed with time update TimeSync could not obtain the local system time while preparing to update the time. Cause. TimeSync could not retrieve the current local system time while preparing to perform a clock update. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with SUPER group permissions : Error updating system time; could not proceed with time update - ensure that TimeSync is running with SUPER group authority TimeSync could not set the local system time. Cause. TimeSync could not set the local system time. In most cases, this is a securityrelated issue. Effect. TimeSync does not set the local system time. Recovery. Verify that TimeSync is running with SUPER group permissions : Clock rate adjusted by microsecs microseconds/second TimeSync adjusted the clock rate of the local system by microsecs microseconds per second. Cause. TimeSync adjusted the local clock rate because the ModifyClockRate option HP NonStop Time Synchronization User s Guide Page 82 of 86

83 was set to True. Effect. TimeSync adjusts the clock rate on the local system. Recovery. Not applicable : Error setting system clock rate, error errnum TimeSync could not set the local system clock rate. errnum is the system error that occurred. Cause. TimeSync could not set the local system clock rate. In most cases, this is a security-related issue. Effect. TimeSync does not set the local system clock rate. Recovery. Verify that TimeSync is running with SUPER group permissions. HP NonStop Time Synchronization User s Guide Page 83 of 86

84 7.5 Guardian-specific Messages This section describes messages that are logged only on NonStop systems running the Guardian version of TimeSync. These messages will not be logged on any other platform : Error obtaining system time; could not proceed with time update TimeSync could not obtain the local system time while preparing to update the time. Cause. TimeSync could not retrieve the current local system time while preparing to perform a clock update. In most cases, this is a security-related issue. Effect. TimeSync does not adjust the local system time. Recovery. Verify that TimeSync is running with SUPER group permissions : Error updating system time; could not proceed with time update - ensure that TimeSync is running with SUPER group authority TimeSync could not set the local system time. Cause. TimeSync could not set the local system time. In most cases, this is a securityrelated issue. Effect. TimeSync does not set the local system time. Recovery. Verify that TimeSync is running with SUPER group permissions : Specified transport process process-name does not exist; TimeSync cannot communicate with the network TimeSync could not communicate with other systems on the network because the HP NonStop Time Synchronization User s Guide Page 84 of 86

85 supplied transport process name does not exist. process-name is the Guardian process name that was defined as the transport process. Cause. A transport process name was supplied in the TimeSync configuration file or via a SET TRANSPORT command, but that process does not exist on the local system. Effect. TimeSync cannot access the network, and therefore cannot operate in either client or server mode. Recovery. Supply a valid transport process name : Clock rate adjusted by microsecs microseconds/second TimeSync adjusted the clock rate of the local system by microsecs microseconds per second. Cause. TimeSync adjusted the local clock rate because the ModifyClockRate option was set to True. Effect. TimeSync adjusts the clock rate on the local system. Recovery. Not applicable : Error setting system clock rate, error errnum TimeSync could not set the local system clock rate. errnum is the system error that occurred. Cause. TimeSync could not set the local system clock rate. In most cases, this is a security-related issue. Effect. TimeSync does not set the local system clock rate. Recovery. Verify that TimeSync is running with SUPER group permissions. HP NonStop Time Synchronization User s Guide Page 85 of 86

86 HP NonStop Time Synchronization User s Guide Page 86 of 86