ntpsnmpd.1ntpsnmpdmdoc revision 338531
113675Sdyson.Dd August 14 2018 213675Sdyson.Dt NTPSNMPD 1ntpsnmpdmdoc User Commands 313675Sdyson.Os 413675Sdyson.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) 513675Sdyson.\" 613675Sdyson.\" It has been AutoGen-ed August 14, 2018 at 08:30:16 AM by AutoGen 5.18.5 713675Sdyson.\" From the definitions ntpsnmpd-opts.def 813675Sdyson.\" and the template file agmdoc-cmd.tpl 913675Sdyson.Sh NAME 1013675Sdyson.Nm ntpsnmpd 1113675Sdyson.Nd NTP SNMP MIB agent 1213675Sdyson.Sh SYNOPSIS 1313675Sdyson.Nm 1413675Sdyson.\" Mixture of short (flag) options and long options 1513675Sdyson.Op Fl flags 1614037Sdyson.Op Fl flag Op Ar value 1713675Sdyson.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 1813675Sdyson.Pp 1913675SdysonAll arguments must be options. 2013675Sdyson.Pp 2113675Sdyson.Sh DESCRIPTION 2213675Sdyson.Nm 2313675Sdysonis an SNMP MIB agent designed to interface with 2413675Sdyson.Xr ntpd 1ntpdmdoc . 2513675Sdyson.Sh "OPTIONS" 2613675Sdyson.Bl -tag 2713907Sdyson.It Fl n , Fl \-nofork 2813907SdysonDo not fork. 2913907Sdyson.sp 3013907Sdyson.It Fl p , Fl \-syslog 3113907SdysonLog to syslog(). 3213907Sdyson.sp 3313907Sdyson.It Fl \-agentxsocket Ns = Ns Ar string 3413907SdysonThe socket address ntpsnmpd uses to connect to net\-snmpd. 3513907SdysonThe default 3613907Sdyson.Ar string 3713913Sdysonfor this option is: 3813907Sdyson.ti +4 3913907Sdyson unix:/var/agentx/master 4013907Sdyson.sp 4113907Sdyson[<transport\-specifier>:]<transport\-address> 4213907SdysonThe default "agent X socket" is the Unix Domain socket 4313907Sdyson\fIunix:/var/agentx/master\fP. 4413907SdysonAnother common alternative is \fItcp:localhost:705\fP. 4513907Sdyson.It Fl \&? , Fl \-help 46118764SsilbyDisplay usage information and exit. 47117325Ssilby.It Fl \&! , Fl \-more\-help 48118764SsilbyPass the extended usage information through a pager. 49117325Ssilby.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc 50118764SsilbySave the option state to \fIcfgfile\fP. The default is the \fIlast\fP 51118764Ssilbyconfiguration file listed in the \fBOPTION PRESETS\fP section, below. 52118764SsilbyThe command will exit after updating the config file. 53118764Ssilby.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts 54118764SsilbyLoad options from \fIcfgfile\fP. 55117325SsilbyThe \fIno\-load\-opts\fP form will disable the loading 56117325Ssilbyof earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, 57117325Ssilbyout of order. 58117325Ssilby.It Fl \-version Op Brq Ar v|c|n 59117325SsilbyOutput version of program and exit. The default mode is `v', a simple 60117325Ssilbyversion. The `c' mode will print copyright information and `n' will 6113907Sdysonprint the full copyright notice. 6213907Sdyson.El 63116182Sobrien.Sh "OPTION PRESETS" 64116182SobrienAny option that is not marked as \fInot presettable\fP may be preset 65116182Sobrienby loading values from configuration ("RC" or ".INI") file(s) and values from 66101768Srwatsonenvironment variables named: 67101768Srwatson.nf 6813675Sdyson \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP 6913675Sdyson.fi 7024131Sbde.ad 7113675SdysonThe environmental presets take precedence (are processed later than) 7213675Sdysonthe configuration files. 7324206SbdeThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". 7491372SalfredIf any of these are directories, then the file \fI.ntprc\fP 7576166Smarkmis searched for within those directories. 76101768Srwatson.Sh USAGE 7776827Salfred.Nm 7824206Sbdecurrently uses a private MIB OID, 7913675Sdyson.Ql enterprises.5597 , 8091968Salfredwhich is the Meinberg top level OEM OID, and 8129356Speter.Ql 99 8270834Swollmanis the temporary working space for this project. 8313675SdysonThe final OID has to be registered with IANA 84117325Ssilbyand this is done by the RFC Editor 8513675Sdysonwhen the NTPv4 MIB RFC is standardized. 8613675Sdyson.Pp 8776166SmarkmIf you have 8855112Sbde.Xr snmpwalk 1 8934924Sbdeinstalled you can run 9059288Sjlemon.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 9113675Sdysonto see a list of all currently supported NTP MIB objects 9213675Sdysonand their current values. 9313675Sdyson.Sh "ENVIRONMENT" 9413675SdysonSee \fBOPTION PRESETS\fP for configuration environment variables. 9513675Sdyson.Sh "FILES" 9613675SdysonSee \fBOPTION PRESETS\fP for configuration files. 9713675Sdyson.Sh "EXIT STATUS" 9813675SdysonOne of the following exit values will be returned: 9913907Sdyson.Bl -tag 10092751Sjeff.It 0 " (EXIT_SUCCESS)" 10113675SdysonSuccessful program execution. 10214037Sdyson.It 1 " (EXIT_FAILURE)" 10314037SdysonThe operation failed or the command syntax was not valid. 10414037Sdyson.It 66 " (EX_NOINPUT)" 10514037SdysonA specified configuration file could not be loaded. 10614037Sdyson.It 70 " (EX_SOFTWARE)" 10714037Sdysonlibopts had an internal operational error. Please report 10814037Sdysonit to autogen\-users@lists.sourceforge.net. Thank you. 10914037Sdyson.El 11014037Sdyson.Sh AUTHORS 11114037Sdyson.An "Heiko Gerstung" 112108255Sphk.Sh "COPYRIGHT" 113108255SphkCopyright (C) 1992\-2017 The University of Delaware and Network Time Foundation all rights reserved. 114108255SphkThis program is released under the terms of the NTP license, <http://ntp.org/license>. 115108255Sphk.Sh "BUGS" 116108255SphkPlease send bug reports to: http://bugs.ntp.org, bugs@ntp.org 117108255Sphk.Sh NOTES 118108255SphkThe following objects are currently supported: 11913675Sdyson.Pp 12072521Sjlemon.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent 121116546Sphk.It Li ntpEntSoftwareName 122116546Sphkplease fill me in... 123116546Sphk.It Li ntpEntSoftwareVersion 124116546Sphkplease fill me in... 125116546Sphk.It Li ntpEntSoftwareVersionVal 126116546Sphkplease fill me in... 127116546Sphk.It Li ntpEntSoftwareVendor 128116546Sphkplease fill me in... 12972521Sjlemon.It Li ntpEntSystemType 13013675Sdysonplease fill me in... 13159288Sjlemon.It Li ntpEntTimeResolution 13259288Sjlemonplease fill me in... 13359288Sjlemon.It Li ntpEntTimeResolutionVal 13459288Sjlemonplease fill me in... 13572521Sjlemon.It Li ntpEntTimePrecision 13672521Sjlemonplease fill me in... 13772521Sjlemon.It Li ntpEntTimePrecisionVal 13872521Sjlemonplease fill me in... 13959288Sjlemon.It Li ntpEntTimeDistance 14013675Sdysonplease fill me in... 14113675Sdyson.El 14213675Sdyson.Pp 14313675SdysonThis manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP 14413675Sdysonoption definitions. 14513675Sdyson