2 .Dt NTPSNMPD 1ntpsnmpdmdoc User Commands
4 .\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc)
6 .\" It has been AutoGen-ed October 21, 2015 at 12:39:45 PM by AutoGen 5.18.5
7 .\" From the definitions ntpsnmpd-opts.def
8 .\" and the template file agmdoc-cmd.tpl
11 .Nd NTP SNMP MIB agent
14 .\" Mixture of short (flag) options and long options
16 .Op Fl flag Op Ar value
17 .Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
19 All arguments must be options.
23 is an SNMP MIB agent designed to interface with
27 .It Fl n , Fl \-nofork
30 .It Fl p , Fl \-syslog
33 .It Fl \-agentxsocket Ns = Ns Ar string
34 The socket address ntpsnmpd uses to connect to net\-snmpd.
39 unix:/var/agentx/master
41 [<transport\-specifier>:]<transport\-address>
42 The default "agent X socket" is the Unix Domain socket
43 \fIunix:/var/agentx/master\fP.
44 Another common alternative is \fItcp:localhost:705\fP.
45 .It Fl \&? , Fl \-help
46 Display usage information and exit.
47 .It Fl \&! , Fl \-more\-help
48 Pass the extended usage information through a pager.
49 .It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc
50 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
51 configuration file listed in the \fBOPTION PRESETS\fP section, below.
52 The command will exit after updating the config file.
53 .It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts
54 Load options from \fIcfgfile\fP.
55 The \fIno\-load\-opts\fP form will disable the loading
56 of earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early,
58 .It Fl \-version Op Brq Ar v|c|n
59 Output version of program and exit. The default mode is `v', a simple
60 version. The `c' mode will print copyright information and `n' will
61 print the full copyright notice.
64 Any option that is not marked as \fInot presettable\fP may be preset
65 by loading values from configuration ("RC" or ".INI") file(s) and values from
66 environment variables named:
68 \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP
71 The environmental presets take precedence (are processed later than)
72 the configuration files.
73 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
74 If any of these are directories, then the file \fI.ntprc\fP
75 is searched for within those directories.
78 currently uses a private MIB OID,
79 .Ql enterprises.5597 ,
80 which is the Meinberg top level OEM OID, and
82 is the temporary working space for this project.
83 The final OID has to be registered with IANA
84 and this is done by the RFC Editor
85 when the NTPv4 MIB RFC is standardized.
90 .Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99
91 to see a list of all currently supported NTP MIB objects
92 and their current values.
94 See \fBOPTION PRESETS\fP for configuration environment variables.
96 See \fBOPTION PRESETS\fP for configuration files.
98 One of the following exit values will be returned:
100 .It 0 " (EXIT_SUCCESS)"
101 Successful program execution.
102 .It 1 " (EXIT_FAILURE)"
103 The operation failed or the command syntax was not valid.
104 .It 66 " (EX_NOINPUT)"
105 A specified configuration file could not be loaded.
106 .It 70 " (EX_SOFTWARE)"
107 libopts had an internal operational error. Please report
108 it to autogen\-users@lists.sourceforge.net. Thank you.
113 Copyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved.
114 This program is released under the terms of the NTP license, <http://ntp.org/license>.
116 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
118 The following objects are currently supported:
120 .Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent
121 .It Li ntpEntSoftwareName
123 .It Li ntpEntSoftwareVersion
125 .It Li ntpEntSoftwareVersionVal
127 .It Li ntpEntSoftwareVendor
129 .It Li ntpEntSystemType
131 .It Li ntpEntTimeResolution
133 .It Li ntpEntTimeResolutionVal
135 .It Li ntpEntTimePrecision
137 .It Li ntpEntTimePrecisionVal
139 .It Li ntpEntTimeDistance
143 This manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP