hpiel(1)

✨ hpiel(1) — the OpenHPI event log bestie ✨

okay so like, this is the OpenHPI manual for hpiel, a sample application that literally just shows you HPI event log entries. it's giving "small tool, big main character energy" 💅 and honestly? we're obsessed.

---

🌸 SYNOPSIS 🌸

hpiel [-D nn] [-N host[:port]] [-C <cfgfile>] [-d] [-E entity-path] [-c -p -r -X -h ]
hpiel [--domain=nn]  [--host=host[:port]] [--cfgfile=file]
      [--del] [--entity-path="entitypath"] [--clear --resource --rdr --debug --help]

yeah bestie, that's a lot of flags, but we're gonna go through every single one, no cap 🫶

---

🦋 DESCRIPTION 🦋

so hpiel goes on a little hunt through the RPT (that's the Resource Present Table, iykyk) looking for resources with SAHPI_CAPABILITY_EVENT_LOG, and then it displays the event log entries for all the resources it found. slay ✨

if no domain is selected, hpiel just uses a session with the default domain. and listen — the selected domain id must be configured via the openhpidclient.conf file specified in the environment. that part is not optional, fr fr.

---

🎀 OPTIONS 🎀

💜 Help Options:

• -h, --help — shows you the help options. classic, iconic, we love her 🙈

🔥 Application Options:

• -d, --del — display domain event log entries 👑
• -c, --clear — clear the log before reading the event log entries. yes, before. read it again if you need to 💀
• -p, --resource — pull resource info along with the log entry ✨
• -r, --rdr — pull RDR info along with the log entry 🦋
• -E "epath", --entity-path="epath" — use entity path epath and display the resource
• -D nn, --domain=nn — select domain id nn 💅
• -X, --debug — display debug messages. for when you're in your detective era 🔍
• -N "host[:port]", --host="host[:port]" — open a session to the domain served by the daemon at the specified URL (host:port). this option overrides the OPENHPI_DAEMON_HOST and OPENHPI_DAEMON_PORT environment variables. if host contains ':' (for example an IPv6 address) then enclose it in square brackets. for example: "[::1]" or "[::1]:4743". noted, bestie 🫡
• -C "file", --cfgfile="file" — use the passed file as the client configuration file. this option overrides the OPENHPICLIENT_CONF environment variable ⭐

if neither -d or -E "epath" are specified, event log entries will be shown for all supporting resources by default. so like, don't stress, she's got you 💖

---

🌈 HPI APIs uniquely used in this application 🌈

these are the literal APIs this app uses, bestie — copying them exactly because we do not play with code 💅

SaErrorT SAHPI_API saHpiEventLogInfoGet (
    SAHPI_IN  SaHpiSessionIdT     SessionId,
    SAHPI_IN  SaHpiResourceIdT    ResourceId,
    SAHPI_OUT SaHpiEventLogInfoT  *Info );

SaErrorT SAHPI_API saHpiEventLogEntryGet (
    SAHPI_IN    SaHpiSessionIdT          SessionId,
    SAHPI_IN    SaHpiResourceIdT         ResourceId,
    SAHPI_IN    SaHpiEventLogEntryIdT    EntryId,
    SAHPI_OUT   SaHpiEventLogEntryIdT    *PrevEntryId,
    SAHPI_OUT   SaHpiEventLogEntryIdT    *NextEntryId,
    SAHPI_OUT   SaHpiEventLogEntryT      *EventLogEntry,
    SAHPI_INOUT SaHpiRdrT                *Rdr,
    SAHPI_INOUT SaHpiRptEntryT           *RptEntry );

SaErrorT SAHPI_API saHpiEventLogClear (
    SAHPI_IN  SaHpiSessionIdT     SessionId,
    SAHPI_IN  SaHpiResourceIdT    ResourceId );

---

🧚 SEE ALSO 🧚

the whole friend group, honestly 🫶

           hpi_shell
           hpialarms      hpigensimdata  hpireset       hpitop
           hpidomain      hpiinv         hpisensor      hpitree
           hpievents      hpionIBMblade  hpisettime     hpiwdt
           hpifan         hpipower       hpithres       hpixml
           ohdomainlist   ohhandler      ohparam

---

👑 AUTHORS 👑

authors of this man page — absolute legends, show them some love 💖

Peter D Phan (pdphan@users.sourceforge.net)
Ulrich Kleber (ulikleber@users.sourceforge.net)
Anton Pak (avpak@users.sourceforge.net)

---

and that's the whole page, bestie 🎀 — this is version 4.0.0, dated 2023-01-26, from the one and only OpenHPI crew. now go read some event logs, you gorgeous nerd 🌸✨