1NTPSNMPD(8)                         NTPsec                         NTPSNMPD(8)
2
3
4

NAME

6       ntpsnmpd - NTP Simple Network Management Protocol sub-agent
7

SYNOPSIS

9       ntpsnmpd [-nxdDlhV] [ntp host]
10

DESCRIPTION

12       [experimental]
13
14       ntpsnmpd is an AgentX Simple Network Management Protocol sub-agent.
15
16       It functions as a bridge between the Mode 6 protocol used for Network
17       Time Protocol monitoring, and an SNMP master agent. The user must have
18       running NTP and SNMP daemons for ntpsnmpd to work.
19

OPTIONS

21       -c filename, --configfile=filename
22           Alternate path for the configuration file, /etc/ntpsnmpd.conf by
23           default
24
25       -n, --nofork
26           Do not fork
27
28       -x, --master-addr
29           Specify address for connecting to the master agent
30
31       -d, --debug
32           Increase debugging level by 1.
33
34       -D num, --set-debug-level=num
35           The debug level is set to the following integer argument.
36
37       -l filename, --logfile=filename
38           Log debugging output to the specified file.
39
40       -h, --help
41           Print a usage message summarizing options end exit.
42
43       -V, --version
44           Print the version string and exit.
45

CONFIGURATION FILES

47           Note that filenames in the options should be enclosed in quotes.
48           This is a temporary measure that will not be the case in future
49           versions.
50
51   /etc/ntpsnmpd.conf
52       master-addr addr
53           The address of the SNMP master agent to connect to. Can be either a
54           named socket or an IP address / hostname and port number.
55
56       ntp-addr addr
57           The address of the NTP daemon to monitor.
58
59       logfile filename
60           Log debugging output to the specified file.
61
62       loglevel level
63           Threshold for log messages. Equivalent to -D
64
65   /var/ntpsnmpd/notify.conf
66           This file is used to store the state of options that can be set
67           by writing to certain OIDs. Any comments will be overwritten by
68           ntpsnmpd upon write.
69
70       notify-mode-change [ True | False ]
71           Enable notifications on ntpd mode change.
72
73       notify-stratum-change [ True | False ]
74           Enable notifications on NTP stratum change.
75
76       notify-syspeer-change [ True | False ]
77           Enable notifications when ntpd selects a new system peer.
78
79       notify-add-association [ True | False ]
80           Enable notifications when ntpd adds a new peer.
81
82       notify-rm-association [ True | False ]
83           Enable notifications when ntpd removes a peer.
84
85       notify-leap-announced [ True | False ]
86           Enable notifications on leap second announcement.
87
88       notify-heartbeat [ True | False ]
89           Send heartbeat notification.
90
91       heartbeat-interval interval
92           Frequency of heartbeat notification in integer seconds.
93

KNOWN LIMITATIONS

95       This program is still experimental in nature. Parts of the AgentX
96       standard are not yet fully implemented, logging not fleshed out yet,
97       some options missing, etc.
98

KNOWN DEVIATIONS FROM RFC 5907

100       The ntpEntStatusEntityUptime OID specifies a bizarre time format. This
101       does not match what the SNMP tools expect to see from a TimeTicks
102       variable. Instead the daemon returns a normal TimeTicks value.
103
104       The ntpEntNotifConfigChanged trap is left unimplemented. This is
105       because there currently is no way to implement what it wants, and it
106       demands alerts regarding changes that are not part of NTP’s
107       jurisdiction.
108
109       The ntpEntTimeResolution OID currently uses data from the sys_fuzz
110       variable as the base for it’s calculations. It is by no means certain
111       that this is the correct choice, and the returned data should be taken
112       with scepticism.
113
114       The ntpEntStatPktModeTable is unimplemented due to not currently having
115       a data source.
116

EXIT STATUS

118       Always returns 0.
119
120
121
122NTPsec                            2021-02-01                       NTPSNMPD(8)
Impressum