1.Dd February 20 2019 2.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands 3.Os 4.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 5.\" 6.\" It has been AutoGen-ed February 20, 2019 at 09:57:05 AM by AutoGen 5.18.5 7.\" From the definitions ntpsnmpd-opts.def 8.\" and the template file agmdoc-cmd.tpl 9.Sh NAME 10.Nm ntpsnmpd 11.Nd NTP SNMP MIB agent 12.Sh SYNOPSIS 13.Nm 14.\" Mixture of short (flag) options and long options 15.Op Fl flags 16.Op Fl flag Op Ar value 17.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18.Pp 19All arguments must be options. 20.Pp 21.Sh DESCRIPTION 22.Nm 23is an SNMP MIB agent designed to interface with 24.Xr ntpd 1ntpdmdoc . 25.Sh "OPTIONS" 26.Bl -tag 27.It Fl n , Fl \-nofork 28Do not fork. 29.sp 30.It Fl p , Fl \-syslog 31Log to syslog(). 32.sp 33.It Fl \-agentxsocket Ns = Ns Ar string 34The socket address ntpsnmpd uses to connect to net\-snmpd. 35The default 36.Ar string 37for this option is: 38.ti +4 39 unix:/var/agentx/master 40.sp 41[<transport\-specifier>:]<transport\-address> 42The default "agent X socket" is the Unix Domain socket 43\fIunix:/var/agentx/master\fP. 44Another common alternative is \fItcp:localhost:705\fP. 45.It Fl \&? , Fl \-help 46Display usage information and exit. 47.It Fl \&! , Fl \-more\-help 48Pass the extended usage information through a pager. 49.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51configuration file listed in the \fBOPTION PRESETS\fP section, below. 52The command will exit after updating the config file. 53.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54Load options from \fIcfgfile\fP. 55The \fIno\-load\-opts\fP form will disable the loading 56of earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57out of order. 58.It Fl \-version Op Brq Ar v|c|n 59Output version of program and exit. The default mode is `v', a simple 60version. The `c' mode will print copyright information and `n' will 61print the full copyright notice. 62.El 63.Sh "OPTION PRESETS" 64Any option that is not marked as \fInot presettable\fP may be preset 65by loading values from configuration ("RC" or ".INI") file(s) and values from 66environment variables named: 67.nf 68 \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 69.fi 70.ad 71The environmental presets take precedence (are processed later than) 72the configuration files. 73The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 74If any of these are directories, then the file \fI.ntprc\fP 75is searched for within those directories. 76.Sh USAGE 77.Nm 78currently uses a private MIB OID, 79.Ql enterprises.5597 , 80which is the Meinberg top level OEM OID, and 81.Ql 99 82is the temporary working space for this project. 83The final OID has to be registered with IANA 84and this is done by the RFC Editor 85when the NTPv4 MIB RFC is standardized. 86.Pp 87If you have 88.Xr snmpwalk 1 89installed you can run 90.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 91to see a list of all currently supported NTP MIB objects 92and their current values. 93.Sh "ENVIRONMENT" 94See \fBOPTION PRESETS\fP for configuration environment variables. 95.Sh "FILES" 96See \fBOPTION PRESETS\fP for configuration files. 97.Sh "EXIT STATUS" 98One of the following exit values will be returned: 99.Bl -tag 100.It 0 " (EXIT_SUCCESS)" 101Successful program execution. 102.It 1 " (EXIT_FAILURE)" 103The operation failed or the command syntax was not valid. 104.It 66 " (EX_NOINPUT)" 105A specified configuration file could not be loaded. 106.It 70 " (EX_SOFTWARE)" 107libopts had an internal operational error. Please report 108it to autogen\-users@lists.sourceforge.net. Thank you. 109.El 110.Sh AUTHORS 111.An "Heiko Gerstung" 112.Sh "COPYRIGHT" 113Copyright (C) 1992\-2017 The University of Delaware and Network Time Foundation all rights reserved. 114This program is released under the terms of the NTP license, <http://ntp.org/license>. 115.Sh "BUGS" 116Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org 117.Sh NOTES 118The following objects are currently supported: 119.Pp 120.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent 121.It Li ntpEntSoftwareName 122please fill me in... 123.It Li ntpEntSoftwareVersion 124please fill me in... 125.It Li ntpEntSoftwareVersionVal 126please fill me in... 127.It Li ntpEntSoftwareVendor 128please fill me in... 129.It Li ntpEntSystemType 130please fill me in... 131.It Li ntpEntTimeResolution 132please fill me in... 133.It Li ntpEntTimeResolutionVal 134please fill me in... 135.It Li ntpEntTimePrecision 136please fill me in... 137.It Li ntpEntTimePrecisionVal 138please fill me in... 139.It Li ntpEntTimeDistance 140please fill me in... 141.El 142.Pp 143This manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP 144option definitions. 145