userapps/opensource/net-snmp/man/snmp.conf.5.def

   1 .TH SNMP.CONF 5 "11 Dec 2002" VVERSIONINFO "Net-SNMP"
   2 .UC 4
   3 .SH NAME
   4 SYSCONFDIR/snmp/snmp.conf - configuration file for the Net-SNMP applications.
   5 .br
   6 ~/.snmp/snmp.conf - personal configuration file.
   7 .SH DESCRIPTION
   8 .B snmp.conf
   9 is the configuration file which define how the Net-SNMP applications
  10 operate.  Tokens that can be put in them are described in the
  11 .B DIRECTIVES
  12 section below.
  13 .SH PLEASE READ FIRST
  14 Make sure you make these files readable only by the user if you are
  15 storing sensitive information in them like passphrases!
  16 .PP
  17 First, make sure you have read the
  18 .I snmp_config(5)
  19 manual page that describes how the Net-SNMP configuration files
  20 operate, where they are located and how they all work together.
  21 .SH DIRECTIVES
  22 .IP "mibdirs (mib-dirs|+mib-dirs)"
  23 Look for textual MIBs to parse in the list of ':' separated
  24 directories.  If the directive value starts with a '+' it prepends
  25 this list to the front of the default directory list compiled into the
  26 application.  Note that this value can be overridden by the
  27 .B MIBDIRS
  28 environment variable.
  29 .IP "mibs (mib-tokens|+mib-tokens)"
  30 Specifies a ':' separated list of MIB tokens that represent textual
  31 MIB files that should be found and parsed.  If the directive value
  32 starts with a '+' it prepends this list to the front of the default
  33 MIB token list compiled into the application.  The special keyword of
  34 "ALL" forces all MIBs files found to be read. Note that the value
  35 specified here can be overridden by the
  36 .B MIBS
  37 environment variable.
  38 .IP "mibfile file"
  39 Specifies a textual MIB file to read and parse, in addition to the
  40 list read from the MIBs token.  Note that the value specified here can
  41 be overridden by the
  42 .B MIBFILES
  43 environment variable.
  44 .IP "persistentDir directory"
  45 The directory where snmpd and snmptrapd stores their persistent data
  46 files.
  47 .IP "defaultPort port"
  48 The default port number that all SNMP applications and daemons should use.
  49 .IP "defVersion (1|2c|3)"
  50 The default SNMP version to use.
  51 .IP "defCommunity string"
  52 The default SNMPv1 and SNMPv2c community string to use.
  53 .IP "defSecurityName string"
  54 The default SNMPv3 USM security name you want to use for SNMPv3 requests.
  55 .IP "defContext string"
  56 The default SNMPv3 context name you want to use.
  57 .IP "defPassphrase string"
  58 .IP "defAuthPassphrase string"
  59 .IP "defPrivPassphrase string"
  60 The default SNMPv3 USM passphrase(s) to use.
  61 .B defPassphrase
  62 will be used for both authentication and privacy pass phrases if it is
  63 specified.
  64 .IP "defAuthType MD5|SHA"
  65 The SNMPv3 USM authentication type to use.
  66 .IP "defPrivType DES"
  67 The SNMPv3 USM privacy type to use.  Currently, DES is the only
  68 possible value.
  69 .IP "defSecurityLevel noAuthNoPriv|authNoPriv|authPriv"
  70 The SNMPv3 default security level to use.
  71 .IP "showMibErrors (1|yes|true|0|no|false)"
  72 Whether or not to display textual MIB parsing errors when commands are
  73 run.
  74 .IP "strictCommentTerm (1|yes|true|0|no|false)"
  75 Whether or not MIBs that are parsed should be strict about comment
  76 termination.  "--" terminates a comment if this is true.  Many
  77 MIBs have broken comments in them, hence this option.
  78 .IP "mibAllowUnderline (1|yes|true|0|no|false)"
  79 Allow underline characters in MIBs (illegal).
  80 .IP "mibWarningLevel integerValue"
  81 The minimum warning level of the warnings printed by the MIB parser.
  82 .IP "logTimestamp (1|yes|true|0|no|false)"
  83 Whether the commands should log timestamps with their error/message
  84 logging or not.  Note that output will not look as pretty with
  85 timestamps if the source code that is doing the logging does
  86 incremental logging of messages that are not line buffered before
  87 being passed to the logging routines.
  88 .IP "printNumericEnums (1|yes|true|0|no|false)"
  89 Equivalent to
  90 .BR -Oe .
  91 .IP "printNumericOids (1|yes|true|0|no|false)"
  92 Equivalent to
  93 .BR -On .
  94 .IP "dontBreakdownOids (1|yes|true|0|no|false)"
  95 Equivalent to
  96 .BR -Ob .
  97 .IP "escapeQuotes (1|yes|true|0|no|false)"
  98 Equivalent to
  99 .BR -OE .
 100 .IP "quickPrinting (1|yes|true|0|no|false)"
 101 Equivalent to
 102 .BR -Oq .
 103 .IP "dontPrintUnits (1|yes|true|0|no|false)"
 104 Equivalent to
 105 .BR -OU .
 106 .IP "printHexText (1|yes|true|0|no|false)"
 107 Equivalent to
 108 .BR -OT .
 109 .IP "suffixPrinting (0|1|2)"
 110 If the value is 1, its equivalent to
 111 .B -Os
 112 and if the value is 2 it's equivalent to
 113 .BR -OS .
 114 .IP "oidOutputFormat (1|2|3|4|5|6)
 115 Maps -O options as follow: -Os=1, -OS=2, -Of=3, -On=4, -Ou=5.
 116 The value 6 has no matching -O option. It suppresses output.
 117 .IP "extendedIndex (1|yes|true|0|no|false)"
 118 Equivalent to
 119 .BR -OX .
 120 .IP "noRangeCheck (1|yes|true|0|no|false)"
 121 Disables the validation of values that is done by
 122 .B snmpset
 123 before issuing the request to the agent.
 124 Equivalent to
 125 .BR -Ir .
 126 .IP "noDisplayHint (1|yes|true|0|no|false)"
 127 Disables the use of DISPLAY-HINT information when parsing indices and
 128 values to set. Equivalent to
 129 .BR -Ih .
 130 .IP "dumpPacket (1|yes|true|0|no|false)"
 131 Whether the commands should dump packets by default.
 132 .IP "doDebugging (1|0)"
 133 Turns on debugging for all applications run if set to 1.
 134 .IP "debugTokens TOKEN[,TOKEN...]"
 135 The debugging tokens that should be printed.  See the
 136 .I snmpcmd(1)
 137 manual page for debugging usage details.
 138 .SH "SEE ALSO"
 139 snmp_config(5), read_config(3), snmpcmd(1).
 140 .\" Local Variables:
 141 .\"  mode: nroff
 142 .\" End: