ntpsnmpd.1ntpsnmpdmdoc revision 298770
1189251Ssam.Dd April 26 2016 2209158Srpaulo.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands 3209158Srpaulo.Os 4189251Ssam.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 5189251Ssam.\" 6189251Ssam.\" It has been AutoGen-ed April 26, 2016 at 08:29:57 PM by AutoGen 5.18.5 7189251Ssam.\" From the definitions ntpsnmpd-opts.def 8189251Ssam.\" and the template file agmdoc-cmd.tpl 9189251Ssam.Sh NAME 10189251Ssam.Nm ntpsnmpd 11189251Ssam.Nd NTP SNMP MIB agent 12189251Ssam.Sh SYNOPSIS 13189251Ssam.Nm 14189251Ssam.\" Mixture of short (flag) options and long options 15189251Ssam.Op Fl flags 16189251Ssam.Op Fl flag Op Ar value 17189251Ssam.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18189251Ssam.Pp 19189251SsamAll arguments must be options. 20189251Ssam.Pp 21189251Ssam.Sh DESCRIPTION 22189251Ssam.Nm 23189251Ssamis an SNMP MIB agent designed to interface with 24189251Ssam.Xr ntpd 1ntpdmdoc . 25189251Ssam.Sh "OPTIONS" 26189251Ssam.Bl -tag 27189251Ssam.It Fl n , Fl \-nofork 28189251SsamDo not fork. 29189251Ssam.sp 30189251Ssam.It Fl p , Fl \-syslog 31189251SsamLog to syslog(). 32189251Ssam.sp 33189251Ssam.It Fl \-agentxsocket Ns = Ns Ar string 34189251SsamThe socket address ntpsnmpd uses to connect to net\-snmpd. 35189251SsamThe default 36189251Ssam.Ar string 37189251Ssamfor this option is: 38189251Ssam.ti +4 39189251Ssam unix:/var/agentx/master 40189251Ssam.sp 41189251Ssam[<transport\-specifier>:]<transport\-address> 42189251SsamThe default "agent X socket" is the Unix Domain socket 43189251Ssam\fIunix:/var/agentx/master\fP. 44189251SsamAnother common alternative is \fItcp:localhost:705\fP. 45189251Ssam.It Fl \&? , Fl \-help 46189251SsamDisplay usage information and exit. 47189251Ssam.It Fl \&! , Fl \-more\-help 48189251SsamPass the extended usage information through a pager. 49189251Ssam.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50189251SsamSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51189251Ssamconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 52189251SsamThe command will exit after updating the config file. 53189251Ssam.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54189251SsamLoad options from \fIcfgfile\fP. 55189251SsamThe \fIno\-load\-opts\fP form will disable the loading 56209158Srpauloof earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57189251Ssamout of order. 58189251Ssam.It Fl \-version Op Brq Ar v|c|n 59189251SsamOutput version of program and exit. The default mode is `v', a simple 60189251Ssamversion. The `c' mode will print copyright information and `n' will 61189251Ssamprint the full copyright notice. 62189251Ssam.El 63189251Ssam.Sh "OPTION PRESETS" 64189251SsamAny option that is not marked as \fInot presettable\fP may be preset 65189251Ssamby loading values from configuration ("RC" or ".INI") file(s) and values from 66189251Ssamenvironment variables named: 67189251Ssam.nf 68189251Ssam \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 69189251Ssam.fi 70189251Ssam.ad 71189251SsamThe environmental presets take precedence (are processed later than) 72189251Ssamthe configuration files. 73189251SsamThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 74189251SsamIf any of these are directories, then the file \fI.ntprc\fP 75189251Ssamis searched for within those directories. 76189251Ssam.Sh USAGE 77189251Ssam.Nm 78189251Ssamcurrently uses a private MIB OID, 79189251Ssam.Ql enterprises.5597 , 80189251Ssamwhich is the Meinberg top level OEM OID, and 81189251Ssam.Ql 99 82189251Ssamis the temporary working space for this project. 83189251SsamThe final OID has to be registered with IANA 84189251Ssamand this is done by the RFC Editor 85189251Ssamwhen the NTPv4 MIB RFC is standardized. 86189251Ssam.Pp 87189251SsamIf you have 88189251Ssam.Xr snmpwalk 1 89189251Ssaminstalled you can run 90189251Ssam.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 91189251Ssamto see a list of all currently supported NTP MIB objects 92189251Ssamand their current values. 93189251Ssam.Sh "ENVIRONMENT" 94189251SsamSee \fBOPTION PRESETS\fP for configuration environment variables. 95189251Ssam.Sh "FILES" 96189251SsamSee \fBOPTION PRESETS\fP for configuration files. 97189251Ssam.Sh "EXIT STATUS" 98189251SsamOne of the following exit values will be returned: 99189251Ssam.Bl -tag 100189251Ssam.It 0 " (EXIT_SUCCESS)" 101189251SsamSuccessful program execution. 102189251Ssam.It 1 " (EXIT_FAILURE)" 103189251SsamThe operation failed or the command syntax was not valid. 104189251Ssam.It 66 " (EX_NOINPUT)" 105189251SsamA specified configuration file could not be loaded. 106189251Ssam.It 70 " (EX_SOFTWARE)" 107189251Ssamlibopts had an internal operational error. Please report 108189251Ssamit to autogen\-users@lists.sourceforge.net. Thank you. 109189251Ssam.El 110189251Ssam.Sh AUTHORS 111189251Ssam.An "Heiko Gerstung" 112189251Ssam.Sh "COPYRIGHT" 113189251SsamCopyright (C) 1992\-2016 The University of Delaware and Network Time Foundation all rights reserved. 114189251SsamThis program is released under the terms of the NTP license, <http://ntp.org/license>. 115189251Ssam.Sh "BUGS" 116189251SsamPlease send bug reports to: http://bugs.ntp.org, bugs@ntp.org 117189251Ssam.Sh NOTES 118189251SsamThe following objects are currently supported: 119189251Ssam.Pp 120189251Ssam.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent 121189251Ssam.It Li ntpEntSoftwareName 122189251Ssamplease fill me in... 123189251Ssam.It Li ntpEntSoftwareVersion 124189251Ssamplease fill me in... 125189251Ssam.It Li ntpEntSoftwareVersionVal 126189251Ssamplease fill me in... 127189251Ssam.It Li ntpEntSoftwareVendor 128189251Ssamplease fill me in... 129189251Ssam.It Li ntpEntSystemType 130189251Ssamplease fill me in... 131189251Ssam.It Li ntpEntTimeResolution 132189251Ssamplease fill me in... 133189251Ssam.It Li ntpEntTimeResolutionVal 134189251Ssamplease fill me in... 135189251Ssam.It Li ntpEntTimePrecision 136189251Ssamplease fill me in... 137189251Ssam.It Li ntpEntTimePrecisionVal 138189251Ssamplease fill me in... 139189251Ssam.It Li ntpEntTimeDistance 140189251Ssamplease fill me in... 141189251Ssam.El 142189251Ssam.Pp 143189251SsamThis manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP 144189251Ssamoption definitions. 145189251Ssam