---
name: "libipmiconsole"
section: "3"
platform: "linux"
package: "freeipmi"
version: "1.6.20-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/libipmiconsole"
---

# libipmiconsole(3)

IPMI SOL library

## NAME

libipmiconsole - IPMI SOL library

## SYNOPSIS

**#include \<ipmiconsole.h\>**

**int ipmiconsole\_engine\_init(unsigned int thread\_count, unsigned int debug\_flags);**

**int ipmiconsole\_engine\_submit(ipmiconsole\_ctx\_t c, Ipmiconsole\_callback callback, void \*callback\_arg);**

**int ipmiconsole\_engine\_submit\_block(ipmiconsole\_ctx\_t c);**

**void ipmiconsole\_engine\_teardown(int cleanup\_sol\_sessions);**

**ipmiconsole\_ctx\_t ipmiconsole\_ctx\_create(const char \*hostname, struct ipmiconsole\_ipmi\_config \*ipmi\_config, struct ipmiconsole\_protocol\_config \*protocol\_config, struct ipmiconsole\_engine\_config \*engine\_config);**

**int ipmiconsole\_ctx\_errnum(ipmiconsole\_ctx\_t c);**

**char \*ipmiconsole\_ctx\_strerror(int errnum);**

**ipmiconsole\_ctx\_status\_t ipmiconsole\_ctx\_status(ipmiconsole\_ctx\_t c);**

**int ipmiconsole\_ctx\_fd(ipmiconsole\_ctx\_t c);**

**int ipmiconsole\_ctx\_generate\_break(ipmiconsole\_ctx\_t c);**

**void ipmiconsole\_ctx\_destroy(ipmiconsole\_ctx\_t c);**

## DESCRIPTION

**Libipmiconsole** implements a high level serial-over-lan (SOL) API for remote console access. It can be used to establish and manage multiple IPMI 2.0 SOL sessions. The goal of this library is to abstract away all of the underlying IPMI/SOL details away from the user into a relatively simple file descriptor interface. Alternate default configuration value can be set for **libipmiconsole** via the libipmiconsole.conf file. See **[libipmiconsole.conf(5)](/libipmiconsole.conf/5.md)** for more information.

## FILES

/usr/include/ipmiconsole.h /etc/freeipmi//libipmiconsole.conf

## REPORTING BUGS

Report bugs to \<freeipmi-users@gnu.org\> or \<freeipmi-devel@gnu.org\>.

## COPYRIGHT

Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.\
 Copyright (C) 2006-2007 The Regents of the University of California.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

## SEE ALSO

[libipmiconsole.conf(5)](/libipmiconsole.conf/5.md), [ipmiconsole(8)](/ipmiconsole/8.md)

http://www.gnu.org/software/freeipmi/