ntpsnmpd.mdoc.in revision 293650
1251881Speter.Dd January 7 2016 2251881Speter.Dt NTPSNMPD @NTPSNMPD_MS@ User Commands 3251881Speter.Os 4251881Speter.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 5251881Speter.\" 6251881Speter.\" It has been AutoGen-ed January 7, 2016 at 11:32:18 PM by AutoGen 5.18.5 7251881Speter.\" From the definitions ntpsnmpd-opts.def 8251881Speter.\" and the template file agmdoc-cmd.tpl 9251881Speter.Sh NAME 10251881Speter.Nm ntpsnmpd 11251881Speter.Nd NTP SNMP MIB agent 12251881Speter.Sh SYNOPSIS 13251881Speter.Nm 14251881Speter.\" Mixture of short (flag) options and long options 15251881Speter.Op Fl flags 16251881Speter.Op Fl flag Op Ar value 17251881Speter.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18251881Speter.Pp 19251881SpeterAll arguments must be options. 20251881Speter.Pp 21251881Speter.Sh DESCRIPTION 22251881Speter.Nm 23251881Speteris an SNMP MIB agent designed to interface with 24251881Speter.Xr ntpd @NTPD_MS@ . 25251881Speter.Sh "OPTIONS" 26251881Speter.Bl -tag 27251881Speter.It Fl n , Fl \-nofork 28251881SpeterDo not fork. 29251881Speter.sp 30251881Speter.It Fl p , Fl \-syslog 31251881SpeterLog to syslog(). 32251881Speter.sp 33251881Speter.It Fl \-agentxsocket Ns = Ns Ar string 34251881SpeterThe socket address ntpsnmpd uses to connect to net\-snmpd. 35251881SpeterThe default 36251881Speter.Ar string 37251881Speterfor this option is: 38251881Speter.ti +4 39251881Speter unix:/var/agentx/master 40251881Speter.sp 41251881Speter[<transport\-specifier>:]<transport\-address> 42251881SpeterThe default "agent X socket" is the Unix Domain socket 43251881Speter\fIunix:/var/agentx/master\fP. 44251881SpeterAnother common alternative is \fItcp:localhost:705\fP. 45251881Speter.It Fl \&? , Fl \-help 46251881SpeterDisplay usage information and exit. 47251881Speter.It Fl \&! , Fl \-more\-help 48251881SpeterPass the extended usage information through a pager. 49251881Speter.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50251881SpeterSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51251881Speterconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 52251881SpeterThe command will exit after updating the config file. 53251881Speter.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54251881SpeterLoad options from \fIcfgfile\fP. 55251881SpeterThe \fIno\-load\-opts\fP form will disable the loading 56251881Speterof earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57251881Speterout of order. 58251881Speter.It Fl \-version Op Brq Ar v|c|n 59251881SpeterOutput version of program and exit. The default mode is `v', a simple 60251881Speterversion. The `c' mode will print copyright information and `n' will 61251881Speterprint the full copyright notice. 62251881Speter.El 63251881Speter.Sh "OPTION PRESETS" 64251881SpeterAny option that is not marked as \fInot presettable\fP may be preset 65251881Speterby loading values from configuration ("RC" or ".INI") file(s) and values from 66251881Speterenvironment variables named: 67251881Speter.nf 68251881Speter \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 69251881Speter.fi 70251881Speter.ad 71251881SpeterThe environmental presets take precedence (are processed later than) 72251881Speterthe configuration files. 73251881SpeterThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 74251881SpeterIf any of these are directories, then the file \fI.ntprc\fP 75251881Speteris searched for within those directories. 76251881Speter.Sh USAGE 77251881Speter.Nm 78251881Spetercurrently uses a private MIB OID, 79251881Speter.Ql enterprises.5597 , 80251881Speterwhich is the Meinberg top level OEM OID, and 81251881Speter.Ql 99 82251881Speteris the temporary working space for this project. 83251881SpeterThe final OID has to be registered with IANA 84251881Speterand this is done by the RFC Editor 85251881Speterwhen the NTPv4 MIB RFC is standardized. 86251881Speter.Pp 87251881SpeterIf you have 88251881Speter.Xr snmpwalk 1 89251881Speterinstalled you can run 90251881Speter.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 91251881Speterto see a list of all currently supported NTP MIB objects 92251881Speterand their current values. 93251881Speter.Sh "ENVIRONMENT" 94251881SpeterSee \fBOPTION PRESETS\fP for configuration environment variables. 95251881Speter.Sh "FILES" 96251881SpeterSee \fBOPTION PRESETS\fP for configuration files. 97251881Speter.Sh "EXIT STATUS" 98251881SpeterOne of the following exit values will be returned: 99251881Speter.Bl -tag 100251881Speter.It 0 " (EXIT_SUCCESS)" 101251881SpeterSuccessful program execution. 102251881Speter.It 1 " (EXIT_FAILURE)" 103251881SpeterThe operation failed or the command syntax was not valid. 104251881Speter.It 66 " (EX_NOINPUT)" 105251881SpeterA specified configuration file could not be loaded. 106251881Speter.It 70 " (EX_SOFTWARE)" 107251881Speterlibopts had an internal operational error. Please report 108251881Speterit to autogen\-users@lists.sourceforge.net. Thank you. 109251881Speter.El 110251881Speter.Sh AUTHORS 111251881Speter.An "Heiko Gerstung" 112251881Speter.Sh "COPYRIGHT" 113251881SpeterCopyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved. 114251881SpeterThis program is released under the terms of the NTP license, <http://ntp.org/license>. 115251881Speter.Sh "BUGS" 116251881SpeterPlease send bug reports to: http://bugs.ntp.org, bugs@ntp.org 117251881Speter.Sh NOTES 118251881SpeterThe following objects are currently supported: 119251881Speter.Pp 120251881Speter.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent 121251881Speter.It Li ntpEntSoftwareName 122251881Speterplease fill me in... 123251881Speter.It Li ntpEntSoftwareVersion 124251881Speterplease fill me in... 125251881Speter.It Li ntpEntSoftwareVersionVal 126251881Speterplease fill me in... 127251881Speter.It Li ntpEntSoftwareVendor 128251881Speterplease fill me in... 129251881Speter.It Li ntpEntSystemType 130251881Speterplease fill me in... 131251881Speter.It Li ntpEntTimeResolution 132251881Speterplease fill me in... 133251881Speter.It Li ntpEntTimeResolutionVal 134251881Speterplease fill me in... 135251881Speter.It Li ntpEntTimePrecision 136251881Speterplease fill me in... 137251881Speter.It Li ntpEntTimePrecisionVal 138251881Speterplease fill me in... 139251881Speter.It Li ntpEntTimeDistance 140251881Speterplease fill me in... 141251881Speter.El 142251881Speter.Pp 143251881SpeterThis manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP 144251881Speteroption definitions. 145251881Speter