/* Copyright (C) 1991-2012 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The	GNU  C	Library is free software; you can redistribute it
and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later ver-
sion.

   The	GNU  C Library is distributed in the hope that it will be
useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See  the
GNU

   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Pub-
lic
   License along with the GNU C Library; if not, see
   <http://www.gnu.org/licenses/>.  */ /* This header is separate
from features.h so that the compiler can
   include  it	implicitly at the start of every compilation.  It
must
   not itself include <features.h> or any other header	that  in-
cludes
   <features.h>  because  the  implicit  include comes before any
feature
   test macros that may be defined in a  source  file  before  it
first
   explicitly  includes  a  system header.  GCC knows the name of
this
   header in order to preinclude it.  */ /* We do support the IEC
559  math  functionality,  real  and complex.  */ /* wchar_t uses
ISO
/IEC 10646 (2nd ed., published 2011-03-15) /
libipmiconsole(3)						  System Commands						 libipmiconsole(3)

   Unicode 6.0.  */ /* We do not support C11 <threads.h>.  */

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(char *hostname, struct ipmiconsole_ipmi_config	*ipmi_config,  struct  ipmiconsole_protocol_config
       *protocol_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 underlying IPMI/SOL details away from the user into a  rela-
       tively simple file descriptor interface.

FILES

       /usr/include/ipmiconsole.h

REPORTING BUGS

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

COPYRIGHT

       Copyright (C) 2007-2012 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

       ipmiconsole(8)

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

libipmiconsole 1.2.9						    2014-06-10							 libipmiconsole(3)