home | help 
libipmiconsole(3)		 System Commands	       libipmiconsole(3)

NAME
     libipmiconsole - IPMI SOL library

SYNOPSIS
     #include <ipmiconsole.h>

     int  ipmiconsole_engine_init(unsigned  int  thread_count,	unsigned int de-
     bug_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(char  *hostname,  struct ipmicon-
     sole_ipmi_config *ipmi_config, struct  ipmiconsole_protocol_config  *proto-
     col_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);

     int 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  un-
     derlying  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) for more information.

FILES
     /usr/include/ipmiconsole.h /usr/local/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 un-
     der 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), ipmiconsole(8)

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

libipmiconsole 1.6.18		   2026-06-02		       libipmiconsole(3)
home | help