| 1 |
.\"############################################################################# |
| 2 |
.\"$Id: ipmiseld.conf.5.pre.in,v 1.15 2010-02-08 22:02:30 chu11 Exp $ |
| 3 |
.\"############################################################################# |
| 4 |
.\" Copyright (C) 2012-2015 Lawrence Livermore National Security, LLC. |
| 5 |
.\" Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). |
| 6 |
.\" Written by Albert Chu <[email protected]> |
| 7 |
.\" LLNL-CODE-559172 |
| 8 |
.\" |
| 9 |
.\" This file is part of Ipmiseld, an IPMI SEL syslog logging daemon. |
| 10 |
.\" For details, see http://www.llnl.gov/linux/. |
| 11 |
.\" |
| 12 |
.\" Ipmiseld is free software; you can redistribute it and/or modify it under |
| 13 |
.\" the terms of the GNU General Public License as published by the Free |
| 14 |
.\" Software Foundation; either version 3 of the License, or (at your option) |
| 15 |
.\" any later version. |
| 16 |
.\" |
| 17 |
.\" Ipmiseld is distributed in the hope that it will be useful, but WITHOUT |
| 18 |
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 19 |
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 20 |
.\" for more details. |
| 21 |
.\" |
| 22 |
.\" You should have received a copy of the GNU General Public License along |
| 23 |
.\" with Ipmiseld. If not, see <http://www.gnu.org/licenses/>. |
| 24 |
.\"############################################################################# |
| 25 |
.TH ipmiseld.conf 5 "@ISODATE@" "ipmiseld.conf @VERSION@" "ipmiseld.conf" |
| 26 |
.SH "NAME" |
| 27 |
ipmiseld.conf \- ipmiseld configuration file |
| 28 |
.SH "DESCRIPTION" |
| 29 |
The |
| 30 |
.B ipmiseld |
| 31 |
configuration file configures the |
| 32 |
.B ipmiseld |
| 33 |
daemon. |
| 34 |
.LP |
| 35 |
The default configuration file loaded is @IPMISELD_CONFIG_FILE_DEFAULT@. |
| 36 |
.LP |
| 37 |
The configuration options that can be specified in the configuration |
| 38 |
file are listed below. Each configuration option must be listed on a |
| 39 |
separate line. Arguments for an option are separated by any amount of |
| 40 |
whitespace. Multiple arguments are also separated by whitespace. |
| 41 |
Comments can be marked by using the pound sign ("#") character, and |
| 42 |
lines can be continued on the next using backslash ("\\"). |
| 43 |
.LP |
| 44 |
Note that it is possible to list the username, password and other |
| 45 |
potentially sensitive information in the configuration file. If this |
| 46 |
data is stored in a configuration file, system administrators should |
| 47 |
limit access to this file. |
| 48 |
|
| 49 |
.SH "IPMISELD CONFIGURATION OPTIONS" |
| 50 |
.TP |
| 51 |
\fBdriver\-type\fR \fIIPMIDRIVER\fR |
| 52 |
Specify the driver type to use. |
| 53 |
.TP |
| 54 |
\fBdisable\-auto\-probe\fR \fIENABLE|DISABLE\fR |
| 55 |
Specify if IPMI devices should be probed for settings. |
| 56 |
.TP |
| 57 |
\fBdriver\-address\fR \fIDRIVER-ADDRESS\fR |
| 58 |
Specify the in-band driver address to use. |
| 59 |
.TP |
| 60 |
\fBdriver\-device\fR \fIDEVICE\fR |
| 61 |
Specify the in-band driver device path to use. |
| 62 |
.TP |
| 63 |
\fBregister\-spacing\fR \fIREGISTER\-SPACING\fR |
| 64 |
Specify the in-band driver register spacing to use. |
| 65 |
.TP |
| 66 |
\fBtarget\-channel\-number\fR \fICHANNEL\-NUMBER\FR |
| 67 |
Specify the in-band driver target channel number. |
| 68 |
.TP |
| 69 |
\fBtarget\-slave\-address\fR \fISLAVE\-ADDRESS\FR |
| 70 |
Specify the in-band driver target slave address. |
| 71 |
.TP |
| 72 |
\fBhostname\fR \fIIPMIHOST1,IPMIHOST2,...\fR |
| 73 |
Specify the remote host(s) to communicate with. Multiple hostnames may |
| 74 |
be separated by comma or may be specified in a range format. |
| 75 |
.TP |
| 76 |
\fBusername\fR \fIUSERNAME\fR |
| 77 |
Specify the username to use. |
| 78 |
.TP |
| 79 |
\fBpassword\fR \fIPASSWORD\fR |
| 80 |
Specify the password to use. |
| 81 |
.TP |
| 82 |
\fBk_g\fR \fIstr\fR |
| 83 |
Specify the BMC key (K_g) to use. Prefix with '0x' to enter |
| 84 |
the key in hex. |
| 85 |
.TP |
| 86 |
\fBsession\-timeout\fR \fIMILLISECONDS\fR |
| 87 |
Specify the session timeout length to use in milliseconds. |
| 88 |
.TP |
| 89 |
\fBretransmission\-timeout\fR \fIMILLISECONDS\fR |
| 90 |
Specify the retransmission timeout length to use in |
| 91 |
milliseconds. |
| 92 |
.TP |
| 93 |
\fBauthentication\-type\fR \fIAUTHENTICATION\-TYPE\fR |
| 94 |
Specify the authentication type to use. The following |
| 95 |
authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, |
| 96 |
and MD5. |
| 97 |
.TP |
| 98 |
\fBcipher\-suite\-id\fR \fICIPHER\-SUITE\-ID\fR |
| 99 |
Specify the cipher suite id to use. The following cipher suite |
| 100 |
ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12. |
| 101 |
.TP |
| 102 |
\fBprivilege\-level\fR \fIPRIVILEGE\-LEVEL\fR |
| 103 |
Specify the privilege type to use. The following privilege |
| 104 |
levels are supported: USER, OPERATOR, ADMIN. |
| 105 |
.TP |
| 106 |
\fBworkaround\-flags\fR \fIWORKAROUNDS\fR |
| 107 |
Specify workaround flags to use. Multiple workarounds can be |
| 108 |
specified separated by whitespace. Please see tool manpages for |
| 109 |
details about available workarounds for each tool. The following |
| 110 |
workarounds are supported: assumeio, spinpoll, idzero, forcepermsg, |
| 111 |
unexpectedauth, endianseq, authcap, intel20, supermicro20, sun20, |
| 112 |
opensesspriv, integritycheckvalue, assumesystemevent. |
| 113 |
.TP |
| 114 |
\fBverbose\-count\fR \fICOUNT\fR |
| 115 |
Specify default verbose count to use for |
| 116 |
.B ipmi-sel(8). |
| 117 |
.TP |
| 118 |
\fIsensors\-types\fR \fITYPE-LIST\fR |
| 119 |
Specify sensor types of SEL events to log. Multiple types can be |
| 120 |
specified separated by whitespace. Users may specify sensor types by |
| 121 |
string or by number (decimal or hex). Please see |
| 122 |
.B ipmi-sel(8) |
| 123 |
\fI\-\-list\-types\fR option to see possible string input types. |
| 124 |
.TP |
| 125 |
\fIexclude\-sensor\-types\fR \fSENSOR-TYPES-LIST\fR |
| 126 |
Specify sensor types of SEL events to not log. default sensor types |
| 127 |
to not show sensor outputs for. Multiple sensor types can be |
| 128 |
specified separated by whitespace. Users may specify sensor types by |
| 129 |
string or by number. Please see |
| 130 |
.B ipmi-sel(8) |
| 131 |
\fI\-\-list\-types\fR option to see possible string input types. |
| 132 |
.TP |
| 133 |
\fBsystem\-event\-only\fR \fIENABLE|DISABLE\fR |
| 134 |
Specify if output should only include system event records. |
| 135 |
.TP |
| 136 |
\fBoem\-event\-only\fR \fIENABLE|DISABLE\fR |
| 137 |
Specify if output should only include OEM event records. |
| 138 |
.TP |
| 139 |
\fBevent\-state\-config\-file\fR \fIFILE\fR |
| 140 |
Specify the event state configuration file. |
| 141 |
.TP |
| 142 |
\fBinterpret\-oem\-data\fR \fIENABLE|DISABLE\fR |
| 143 |
Specify if |
| 144 |
.B ipmiseld |
| 145 |
should attempt to interpret OEM data or not. |
| 146 |
.TP |
| 147 |
\fBentity\-sensor\-names\fR \fIENABLE|DISABLE\fR |
| 148 |
Specify if output of sensor names should include entity ids and |
| 149 |
instances or not. |
| 150 |
.TP |
| 151 |
\fBnon\-abbreviated\-units\fR \fIENABLE|DISABLE\fR |
| 152 |
Specify if output should have units abbreviated by default or not. |
| 153 |
.TP |
| 154 |
\fBevent\-state\-filter\fR \fIFILTERSTRING\fR |
| 155 |
Specify event states to be filtered out and not logged. |
| 156 |
.TP |
| 157 |
\fB\-\-warning\-threshold\fR \fIPERCENTINT\fR |
| 158 |
Specify SEL fullness warning threshold as an integer percentage. |
| 159 |
.TP |
| 160 |
\fB\-\-clear\-threshold\fR \fIPERCENTINT\fR |
| 161 |
Specify SEL fullness clear threshold as an integer percentage. |
| 162 |
.TP |
| 163 |
\fBsystem\-event\-format\fR \fIFORMATSTRING\fR |
| 164 |
Specify the format of the log output when a SEL system event is |
| 165 |
encountered. |
| 166 |
.TP |
| 167 |
\fBoem\-timestamped\-event\-format\fR \fIFORMATSTRING\fR |
| 168 |
Specify the format of the log output when a SEL OEM timestamped event |
| 169 |
is encountered. |
| 170 |
.TP |
| 171 |
\fBoem\-non\-timestamped\-event\-format\fR \fIFORMATSTRING\fR |
| 172 |
Specify the format of the log output when a SEL OEM non-timestamped |
| 173 |
event is encountered. |
| 174 |
.TP |
| 175 |
\fBpoll\-interval\fR \fISECONDS\fR |
| 176 |
Specify the poll interval to check the SEL for new events. |
| 177 |
.TP |
| 178 |
\fBlog\-facility\fR \fISTRING\fR |
| 179 |
Specify the log facility to use. |
| 180 |
.TP |
| 181 |
\fBlog\-priority\fR \fISTRING\fR |
| 182 |
Specify the log priority to use. |
| 183 |
.TP |
| 184 |
\fBcache\-directory\fR \fIDIRECTORY\fR |
| 185 |
Specify the cache directory to use. |
| 186 |
.TP |
| 187 |
\fBignore\-sdr\fR \fIDISABLE\fR |
| 188 |
Specify if the SDR should be ignored. |
| 189 |
.TP |
| 190 |
\fBre\-download\-sdr\fR \fIDISABLE\fR |
| 191 |
Specify if the SDR should be re-downloaded on start. |
| 192 |
.TP |
| 193 |
\fBclear\-sel\fR \fIDISABLE\fR |
| 194 |
Specify if the SEL should be cleared on start. |
| 195 |
.TP |
| 196 |
\fBthreadpool\-count\fR \fINUM\fR |
| 197 |
Specify the threadpool count for parallel SEL polling. |
| 198 |
.SH "FILES" |
| 199 |
@IPMISELD_CONFIG_FILE_DEFAULT@ |
| 200 |
#include <@top_srcdir@/man/manpage-common-reporting-bugs.man> |
| 201 |
.SH COPYRIGHT |
| 202 |
Copyright (C) 2012-2015 Lawrence Livermore National Security, LLC. |
| 203 |
.SH "SEE ALSO" |
| 204 |
ipmiseld(8), ipmi-sel(8) |
| 205 |
#include <@top_srcdir@/man/manpage-common-homepage.man> |