1libipmiconsole(3)               System Commands              libipmiconsole(3)
2
3
4

NAME

6       libipmiconsole - IPMI SOL library
7

SYNOPSIS

9       #include <ipmiconsole.h>
10
11       int ipmiconsole_engine_init(unsigned int thread_count, unsigned int de‐
12       bug_flags);
13
14       int ipmiconsole_engine_submit(ipmiconsole_ctx_t c, Ipmiconsole_callback
15       callback, void *callback_arg);
16
17       int ipmiconsole_engine_submit_block(ipmiconsole_ctx_t c);
18
19       void ipmiconsole_engine_teardown(int cleanup_sol_sessions);
20
21       ipmiconsole_ctx_t  ipmiconsole_ctx_create(char  *hostname, struct ipmi‐
22       console_ipmi_config  *ipmi_config,  struct  ipmiconsole_protocol_config
23       *protocol_config);
24
25       int ipmiconsole_ctx_errnum(ipmiconsole_ctx_t c);
26
27       char *ipmiconsole_ctx_strerror(int errnum);
28
29       ipmiconsole_ctx_status_t ipmiconsole_ctx_status(ipmiconsole_ctx_t c);
30
31       int ipmiconsole_ctx_fd(ipmiconsole_ctx_t c);
32
33       int ipmiconsole_ctx_generate_break(ipmiconsole_ctx_t c);
34
35       int ipmiconsole_ctx_destroy(ipmiconsole_ctx_t c);
36
37

DESCRIPTION

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

FILES

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

REPORTING BUGS

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

54       Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.
55       Copyright (C) 2006-2007 The Regents of the University of California.
56
57       This library is free software; you can redistribute it and/or modify it
58       under the terms of the GNU General Public License as published  by  the
59       Free  Software Foundation; either version 3 of the License, or (at your
60       option) any later version.
61

SEE ALSO

63       libipmiconsole.conf(5), ipmiconsole(8)
64
65       http://www.gnu.org/software/freeipmi/
66
67
68
69libipmiconsole 1.6.11             2023-06-07                 libipmiconsole(3)
Impressum