ntpsnmpd.1ntpsnmpdmdoc revision 316722
1219019Sgabor.Dd March 21 2017 2219019Sgabor.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands 3219019Sgabor.Os 4219019Sgabor.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 5219019Sgabor.\" 6219019Sgabor.\" It has been AutoGen-ed March 21, 2017 at 10:45:40 AM by AutoGen 5.18.5 7219019Sgabor.\" From the definitions ntpsnmpd-opts.def 8219019Sgabor.\" and the template file agmdoc-cmd.tpl 9219019Sgabor.Sh NAME 10219019Sgabor.Nm ntpsnmpd 11219019Sgabor.Nd NTP SNMP MIB agent 12219019Sgabor.Sh SYNOPSIS 13219019Sgabor.Nm 14219019Sgabor.\" Mixture of short (flag) options and long options 15219019Sgabor.Op Fl flags 16219019Sgabor.Op Fl flag Op Ar value 17219019Sgabor.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18219019Sgabor.Pp 19219019SgaborAll arguments must be options. 20219019Sgabor.Pp 21219019Sgabor.Sh DESCRIPTION 22219019Sgabor.Nm 23219019Sgaboris an SNMP MIB agent designed to interface with 24219019Sgabor.Xr ntpd 1ntpdmdoc . 25219019Sgabor.Sh "OPTIONS" 26219019Sgabor.Bl -tag 27219019Sgabor.It Fl n , Fl \-nofork 28219019SgaborDo not fork. 29219019Sgabor.sp 30219019Sgabor.It Fl p , Fl \-syslog 31219019SgaborLog to syslog(). 32219019Sgabor.sp 33219019Sgabor.It Fl \-agentxsocket Ns = Ns Ar string 34219019SgaborThe socket address ntpsnmpd uses to connect to net\-snmpd. 35219019SgaborThe default 36219019Sgabor.Ar string 37219019Sgaborfor this option is: 38219019Sgabor.ti +4 39219019Sgabor unix:/var/agentx/master 40219019Sgabor.sp 41219019Sgabor[<transport\-specifier>:]<transport\-address> 42219019SgaborThe default "agent X socket" is the Unix Domain socket 43219019Sgabor\fIunix:/var/agentx/master\fP. 44219019SgaborAnother common alternative is \fItcp:localhost:705\fP. 45219019Sgabor.It Fl \&? , Fl \-help 46219019SgaborDisplay usage information and exit. 47219019Sgabor.It Fl \&! , Fl \-more\-help 48219019SgaborPass the extended usage information through a pager. 49219019Sgabor.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50219019SgaborSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51219019Sgaborconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 52219019SgaborThe command will exit after updating the config file. 53219019Sgabor.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54219019SgaborLoad options from \fIcfgfile\fP. 55219019SgaborThe \fIno\-load\-opts\fP form will disable the loading 56219019Sgaborof earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57219019Sgaborout of order. 58219019Sgabor.It Fl \-version Op Brq Ar v|c|n 59219019SgaborOutput version of program and exit. The default mode is `v', a simple 60219019Sgaborversion. The `c' mode will print copyright information and `n' will 61219019Sgaborprint the full copyright notice. 62219019Sgabor.El 63219019Sgabor.Sh "OPTION PRESETS" 64219019SgaborAny option that is not marked as \fInot presettable\fP may be preset 65219019Sgaborby loading values from configuration ("RC" or ".INI") file(s) and values from 66219019Sgaborenvironment variables named: 67219019Sgabor.nf 68219019Sgabor \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 69219019Sgabor.fi 70219019Sgabor.ad 71219019SgaborThe environmental presets take precedence (are processed later than) 72219019Sgaborthe configuration files. 73219019SgaborThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 74219019SgaborIf any of these are directories, then the file \fI.ntprc\fP 75219019Sgaboris searched for within those directories. 76219019Sgabor.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