{ "content": [ { "type": "text", "text": "# openipmi_eventd (man)\n\n## NAME\n\nopenipmieventd - An IPMI event handler\n\n## SYNOPSIS\n\nopenipmieventd [ [\n\n## DESCRIPTION\n\nThe openipmieventd program listens for IPMI events for the given connection and sends them\nto another program to process, or to a file.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS** (1 subsections)\n- **DESCRIPTION**\n- **PARAMETERS** (4 subsections)\n- **OPTIONS** (6 subsections)\n- **USAGE** (1 subsections)\n- **EVENT KEY-VALUE PAIRS**\n- **SEE ALSO**\n- **KNOWN PROBLEMS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "openipmi_eventd", "section": "", "mode": "man", "summary": "openipmieventd - An IPMI event handler", "synopsis": "openipmieventd [ [", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-f", "long": "--outfile", "arg": null, "description": "Send all events to the given file" }, { "flag": "-k", "long": "--exec-now", "arg": null, "description": "Immediately spawn the given program and send the event information to that program's standard input. The program should not quit, if it does then this program will exit with an error." }, { "flag": "-i", "long": "--event-stdin", "arg": null, "description": "Send the event information to the program's standard input instead of the commandline." }, { "flag": "-e", "long": "--delete-events", "arg": null, "description": "Delete events from the SEL (System Event Log) once they have been processed. Note that the program has to have handled the event without error for the event to be deleted. Otherwise the events are not deleted from the SEL." }, { "flag": "-b", "long": "--dont-daemonize", "arg": null, "description": "Do not daemonize the program, run it as a foreground process." }, { "flag": "-d", "long": "--debug", "arg": null, "description": "Debug the program, turn on output, send all logs to stderr, and do not run the process as a daemon." } ], "examples": [], "see_also": [ { "name": "openipmiconparms", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/openipmiconparms/7/json" } ], "section_outline": [ { "name": "NAME", "lines": 3, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "[...]]]", "lines": 1 } ] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "PARAMETERS", "lines": 1, "subsections": [ { "name": "", "lines": 3 }, { "name": "", "lines": 4 }, { "name": "", "lines": 3 }, { "name": " [ [ [...]]]", "lines": 4 } ] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-f --outfile", "lines": 3, "flag": "-f", "long": "--outfile" }, { "name": "-k --exec-now", "lines": 5, "flag": "-k", "long": "--exec-now" }, { "name": "-i --event-stdin", "lines": 3, "flag": "-i", "long": "--event-stdin" }, { "name": "-e --delete-events", "lines": 5, "flag": "-e", "long": "--delete-events" }, { "name": "-b --dont-daemonize", "lines": 3, "flag": "-b", "long": "--dont-daemonize" }, { "name": "-d --debug", "lines": 4, "flag": "-d", "long": "--debug" } ] }, { "name": "USAGE", "lines": 11, "subsections": [ { "name": "vent.", "lines": 5 } ] }, { "name": "EVENT KEY-VALUE PAIRS", "lines": 63, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "KNOWN PROBLEMS", "lines": 3, "subsections": [] }, { "name": "AUTHOR", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "openipmieventd - An IPMI event handler\n\n", "subsections": [] }, "SYNOPSIS": { "content": "openipmieventd [ [", "subsections": [ { "name": "[...]]]", "content": "" } ] }, "DESCRIPTION": { "content": "The openipmieventd program listens for IPMI events for the given connection and sends them\nto another program to process, or to a file.\n\n", "subsections": [] }, "PARAMETERS": { "content": "", "subsections": [ { "name": "", "content": "The name to use for the OpenIPMI domain. This will appear in logs and some names.\n\n" }, { "name": "", "content": "The parameters for the connection depend on the connection type. These are all de‐\nscribed in openipmiconparms (7)\n\n" }, { "name": "", "content": "Zero or more of the options defined in OPTIONS below.\n\n" }, { "name": " [ [ [...]]]", "content": "The program to run. This must be the full path to the program. Any given parameters\nare passed to the program before any IPMI parameters.\n\n" } ] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-f --outfile", "content": "Send all events to the given file\n\n", "flag": "-f", "long": "--outfile" }, { "name": "-k --exec-now", "content": "Immediately spawn the given program and send the event information to that program's\nstandard input. The program should not quit, if it does then this program will exit\nwith an error.\n\n", "flag": "-k", "long": "--exec-now" }, { "name": "-i --event-stdin", "content": "Send the event information to the program's standard input instead of the commandline.\n\n", "flag": "-i", "long": "--event-stdin" }, { "name": "-e --delete-events", "content": "Delete events from the SEL (System Event Log) once they have been processed. Note\nthat the program has to have handled the event without error for the event to be\ndeleted. Otherwise the events are not deleted from the SEL.\n\n", "flag": "-e", "long": "--delete-events" }, { "name": "-b --dont-daemonize", "content": "Do not daemonize the program, run it as a foreground process.\n\n", "flag": "-b", "long": "--dont-daemonize" }, { "name": "-d --debug", "content": "Debug the program, turn on output, send all logs to stderr, and do not run the process\nas a daemon.\n\n", "flag": "-d", "long": "--debug" } ] }, "USAGE": { "content": "When started, this program will connect to the given IPMI domain, ignore all existing logs,\nand set up to listen from logs from all sources. When an event comes in, it will handle the\nevent depending on how it is configured.\n\nBy default the program will be called on each log and the event information passed on the\nprogram's command line. The first parameter (after the ones given on the openipmieventd com‐\nmand line) will be the event type, the rest are key-value pairs as defined below.\n\nIf -i is given on the commandline, instead of passing in the event information on the command\nline, it will be passed into the program's standard input. The first line will be the event\ntype, and each line will have a key-value pair up until the last line, which will be ende‐‐", "subsections": [ { "name": "vent.", "content": "If -k is given on the command line, the program will be started immediately and expected to\ntake events on its standard input as they come in. Each event will start with an event type,\ncontain key-value pairs, and end in endevent.\n\n" } ] }, "EVENT KEY-VALUE PAIRS": { "content": "The first line and parameter of an event is always the event type (either threshold , dis‐‐\ncrete , or unknown ). Then the following then the following, in no particular order. When\nsending to a file, or another program via standard input, endevent will mark the end of an\nevent.\n\n\nassert true|false\nIf true, the event is being asserted (the alarm present). If false, the alarm\nwas present but has now gone away.\n\neventtype \nThe event type, per the IPMI specification.\n\neventtime \nThe time (in seconds) for the IPMI event. It is 64 bits.\n\neventdata \nThe raw event data, vals is a list of hex numbers.\n\nid \nThe OpenIPMI id of the sensor. This is in the format: .. where the entity id and instance identify the object be‐\ning monitored and the sensor names comes from the sensor. Only for discrete\nand threshold events.\n\nval \nThe sensor value that cause the event, in floating point format. Optional and\nonly present for threshold sensors.\n\nraw \nThe sensor value that cause the event, in raw (hex) format. Optional and only\npresent for threshold sensors.\n\noff \nThe bit in the sensor that caused the event, only present for discrete sensors.\n\nseverity\nThe severity of the event. For discrete sensors this optional and is a number\nbetween 0 and 14. Them meaning depends on the specific sensor type. For\nthreshold sensors this is one of:\n\nlowernoncritical\n\nlowercritical\n\nlowernonrecoverable\n\nuppernoncritical\n\nuppercritical\n\nuppernonrecoverable\n\nprevseverity\nfor discrete sensors.\n\ndirection\nThe direction of the event, only for threshold sensors. This can be difficult\nto understand and is not consistent on IPMI systems. The IPMI specifiation\ndoes define what this means. For instance, what does an assertion of an upper\ncritcal event going low mean?\n\n", "subsections": [] }, "SEE ALSO": { "content": "openipmiconparms(7)\n\n", "subsections": [] }, "KNOWN PROBLEMS": { "content": "None\n\n", "subsections": [] }, "AUTHOR": { "content": "Corey Minyard \n\n\n\nOpenIPMI 03/4/15 openipmieventd(1)", "subsections": [] } } } }