ntpsnmpd.mdoc.in revision 293650
1222748Srwatson.Dd January 7 2016 2222748Srwatson.Dt NTPSNMPD @NTPSNMPD_MS@ User Commands 3222748Srwatson.Os 4222748Srwatson.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 5222748Srwatson.\" 6222748Srwatson.\" It has been AutoGen-ed January 7, 2016 at 11:32:18 PM by AutoGen 5.18.5 7222748Srwatson.\" From the definitions ntpsnmpd-opts.def 8222748Srwatson.\" and the template file agmdoc-cmd.tpl 9222748Srwatson.Sh NAME 10222748Srwatson.Nm ntpsnmpd 11222748Srwatson.Nd NTP SNMP MIB agent 12222748Srwatson.Sh SYNOPSIS 13222748Srwatson.Nm 14222748Srwatson.\" Mixture of short (flag) options and long options 15222748Srwatson.Op Fl flags 16222748Srwatson.Op Fl flag Op Ar value 17222748Srwatson.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18222748Srwatson.Pp 19222748SrwatsonAll arguments must be options. 20222748Srwatson.Pp 21222748Srwatson.Sh DESCRIPTION 22222748Srwatson.Nm 23222748Srwatsonis an SNMP MIB agent designed to interface with 24222748Srwatson.Xr ntpd @NTPD_MS@ . 25222748Srwatson.Sh "OPTIONS" 26222748Srwatson.Bl -tag 27222748Srwatson.It Fl n , Fl \-nofork 28222748SrwatsonDo not fork. 29222748Srwatson.sp 30222748Srwatson.It Fl p , Fl \-syslog 31222748SrwatsonLog to syslog(). 32222748Srwatson.sp 33222748Srwatson.It Fl \-agentxsocket Ns = Ns Ar string 34222748SrwatsonThe socket address ntpsnmpd uses to connect to net\-snmpd. 35222748SrwatsonThe default 36222748Srwatson.Ar string 37222748Srwatsonfor this option is: 38222748Srwatson.ti +4 39222748Srwatson unix:/var/agentx/master 40222748Srwatson.sp 41222748Srwatson[<transport\-specifier>:]<transport\-address> 42222748SrwatsonThe default "agent X socket" is the Unix Domain socket 43222748Srwatson\fIunix:/var/agentx/master\fP. 44222748SrwatsonAnother common alternative is \fItcp:localhost:705\fP. 45222748Srwatson.It Fl \&? , Fl \-help 46222748SrwatsonDisplay usage information and exit. 47222748Srwatson.It Fl \&! , Fl \-more\-help 48222748SrwatsonPass the extended usage information through a pager. 49222748Srwatson.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50222748SrwatsonSave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51222748Srwatsonconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 52222748SrwatsonThe command will exit after updating the config file. 53222748Srwatson.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54222748SrwatsonLoad options from \fIcfgfile\fP. 55222748SrwatsonThe \fIno\-load\-opts\fP form will disable the loading 56222748Srwatsonof earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57222748Srwatsonout of order. 58222748Srwatson.It Fl \-version Op Brq Ar v|c|n 59222748SrwatsonOutput version of program and exit. The default mode is `v', a simple 60222748Srwatsonversion. The `c' mode will print copyright information and `n' will 61222748Srwatsonprint the full copyright notice. 62222748Srwatson.El 63222748Srwatson.Sh "OPTION PRESETS" 64222748SrwatsonAny option that is not marked as \fInot presettable\fP may be preset 65222748Srwatsonby loading values from configuration ("RC" or ".INI") file(s) and values from 66222748Srwatsonenvironment variables named: 67222748Srwatson.nf 68222748Srwatson \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 69222748Srwatson.fi 70222748Srwatson.ad 71222748SrwatsonThe environmental presets take precedence (are processed later than) 72222748Srwatsonthe configuration files. 73222748SrwatsonThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 74222748SrwatsonIf any of these are directories, then the file \fI.ntprc\fP 75222748Srwatsonis searched for within those directories. 76222748Srwatson.Sh USAGE 77222748Srwatson.Nm 78222748Srwatsoncurrently uses a private MIB OID, 79222748Srwatson.Ql enterprises.5597 , 80222748Srwatsonwhich is the Meinberg top level OEM OID, and 81222748Srwatson.Ql 99 82222748Srwatsonis the temporary working space for this project. 83222748SrwatsonThe final OID has to be registered with IANA 84222748Srwatsonand this is done by the RFC Editor 85222748Srwatsonwhen the NTPv4 MIB RFC is standardized. 86222748Srwatson.Pp 87222748SrwatsonIf you have 88222748Srwatson.Xr snmpwalk 1 89222748Srwatsoninstalled you can run 90222748Srwatson.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 91222748Srwatsonto see a list of all currently supported NTP MIB objects 92222748Srwatsonand their current values. 93222748Srwatson.Sh "ENVIRONMENT" 94222748SrwatsonSee \fBOPTION PRESETS\fP for configuration environment variables. 95222748Srwatson.Sh "FILES" 96222748SrwatsonSee \fBOPTION PRESETS\fP for configuration files. 97222748Srwatson.Sh "EXIT STATUS" 98222748SrwatsonOne of the following exit values will be returned: 99222748Srwatson.Bl -tag 100222748Srwatson.It 0 " (EXIT_SUCCESS)" 101222748SrwatsonSuccessful program execution. 102222748Srwatson.It 1 " (EXIT_FAILURE)" 103222748SrwatsonThe 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\-2015 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