nut/tools/nut-scanner/nut-scan.h
2016-07-18 02:11:41 +02:00

111 lines
3.4 KiB
C

/*
* Copyright (C)
* 2011 - EATON
* 2012 - Arnaud Quette <arnaud.quette@free.fr>
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*! \file nut-scan.h
\brief general header for nut-scanner
\author Frederic Bohe <fredericbohe@eaton.com>
\author Arnaud Quette <arnaud.quette@free.fr>
*/
#ifndef NUT_SCAN_H
#define NUT_SCAN_H
#include <nutscan-init.h>
#include <nutscan-device.h>
#include <nutscan-ip.h>
#ifdef WITH_IPMI
#include <freeipmi/freeipmi.h>
#endif
#ifdef __cplusplus
/* *INDENT-OFF* */
extern "C" {
/* *INDENT-ON* */
#endif
/* SNMP structure */
typedef struct nutscan_snmp {
char * community;
char * secLevel;
char * secName;
char * authPassword;
char * privPassword;
char * authProtocol;
char * privProtocol;
char * peername;
void * handle;
} nutscan_snmp_t;
/* IPMI structure */
/* Settings for OutofBand (remote) connection */
typedef struct nutscan_ipmi {
char* username; /* IPMI 1.5 and 2.0 */
char* password; /* IPMI 1.5 and 2.0 */
int authentication_type; /* IPMI 1.5 */
int cipher_suite_id; /* IPMI 2.0 */
char* K_g_BMC_key; /* IPMI 2.0, optional key for 2 key auth. */
int privilege_level; /* for both */
unsigned int workaround_flags; /* for both */
int ipmi_version; /* IPMI 1.5 or 2.0? */
} nutscan_ipmi_t;
/* IPMI auth defines, simply using FreeIPMI defines */
#ifndef IPMI_AUTHENTICATION_TYPE_NONE
#define IPMI_AUTHENTICATION_TYPE_NONE 0x00
#define IPMI_AUTHENTICATION_TYPE_MD2 0x01
#define IPMI_AUTHENTICATION_TYPE_MD5 0x02
#define IPMI_AUTHENTICATION_TYPE_STRAIGHT_PASSWORD_KEY 0x04
#define IPMI_AUTHENTICATION_TYPE_OEM_PROP 0x05
#define IPMI_AUTHENTICATION_TYPE_RMCPPLUS 0x06
#endif
#ifndef IPMI_PRIVILEGE_LEVEL_ADMIN
#define IPMI_PRIVILEGE_LEVEL_ADMIN 0x04
#endif
#define IPMI_1_5 1
#define IPMI_2_0 0
/* Scanning */
nutscan_device_t * nutscan_scan_snmp(const char * start_ip, const char * stop_ip, long usec_timeout, nutscan_snmp_t * sec);
nutscan_device_t * nutscan_scan_usb();
nutscan_device_t * nutscan_scan_xml_http(long usec_timeout);
nutscan_device_t * nutscan_scan_nut(const char * startIP, const char * stopIP, const char * port, long usec_timeout);
nutscan_device_t * nutscan_scan_avahi(long usec_timeout);
nutscan_device_t * nutscan_scan_ipmi(const char * startIP, const char * stopIP, nutscan_ipmi_t * sec);
nutscan_device_t * nutscan_scan_eaton_serial(const char* ports_list);
/* Display functions */
void nutscan_display_ups_conf(nutscan_device_t * device);
void nutscan_display_parsable(nutscan_device_t * device);
#ifdef __cplusplus
/* *INDENT-OFF* */
}
/* *INDENT-ON* */
#endif
#endif