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 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 /etc/freeipmi//libipmiconsole.conf

REPORTING BUGS

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

COPYRIGHT

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.