ntpsnmpd.1ntpsnmpdmdoc revision 330141
198184Sgordon.Dd February 27 2018 298184Sgordon.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands 398184Sgordon.Os 498184Sgordon.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 598184Sgordon.\" 698184Sgordon.\" It has been AutoGen-ed February 27, 2018 at 05:15:39 PM by AutoGen 5.18.5 798184Sgordon.\" From the definitions ntpsnmpd-opts.def 8136224Smtm.\" and the template file agmdoc-cmd.tpl 998184Sgordon.Sh NAME 1098184Sgordon.Nm ntpsnmpd 1198184Sgordon.Nd NTP SNMP MIB agent 1298184Sgordon.Sh SYNOPSIS 1398184Sgordon.Nm 1498184Sgordon.\" Mixture of short (flag) options and long options 1598184Sgordon.Op Fl flags 16222993Srmacklem.Op Fl flag Op Ar value 1798184Sgordon.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 1898184Sgordon.Pp 1998184SgordonAll arguments must be options. 2098184Sgordon.Pp 2198184Sgordon.Sh DESCRIPTION 2298184Sgordon.Nm 2398184Sgordonis an SNMP MIB agent designed to interface with 2498184Sgordon.Xr ntpd 1ntpdmdoc . 25197947Sdougb.Sh "OPTIONS" 26197947Sdougb.Bl -tag 27180294Smtm.It Fl n , Fl \-nofork 28180294SmtmDo not fork. 29180294Smtm.sp 3098184Sgordon.It Fl p , Fl \-syslog 3198184SgordonLog to syslog(). 32180294Smtm.sp 33180294Smtm.It Fl \-agentxsocket Ns = Ns Ar string 34180294SmtmThe socket address ntpsnmpd uses to connect to net\-snmpd. 3598184SgordonThe default 3698184Sgordon.Ar string 3798184Sgordonfor this option is: 3898184Sgordon.ti +4 3998184Sgordon unix:/var/agentx/master 4098184Sgordon.sp 4198184Sgordon[<transport\-specifier>:]<transport\-address> 4298184SgordonThe default "agent X socket" is the Unix Domain socket 4398184Sgordon\fIunix:/var/agentx/master\fP. 4498184SgordonAnother common alternative is \fItcp:localhost:705\fP. 4598184Sgordon.It Fl \&? , Fl \-help 4698184SgordonDisplay usage information and exit. 4798184Sgordon.It Fl \&! , Fl \-more\-help 4898184SgordonPass the extended usage information through a pager. 4998184Sgordon.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 5098184SgordonSave 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