nut/docs/man/nutscan_scan_ipmi.txt
2022-06-29 12:37:36 +02:00

57 lines
1.6 KiB
Text

NUTSCAN_SCAN_IPMI(3)
====================
NAME
----
nutscan_scan_ipmi - Scan local IPMI devices.
SYNOPSIS
--------
#include <nut-scan.h>
nutscan_device_t * nutscan_scan_ipmi(
const char * startIP,
const char * stopIP,
nutscan_ipmi_t * sec);
DESCRIPTION
-----------
The *nutscan_scan_ipmi()* function tries to detect IPMI manageable devices.
If 'start_ip' is NULL, the function searches for a local PSU.
Otherwise, it searches for remote hosts that would serve IPMI protocols,
and would try to authenticate using the data in 'sec' structure.
It issues a NUT request on every IP ranging from 'startIP' to 'stopIP',
where 'stopIP' is optional. Those IP arguments may be either IPv4 or IPv6
addresses or host names.
You MUST call linkman:nutscan_init[3] before using this function.
BUGS
----
Design or implementation of this function may be incomplete: until
recently, this man page stated that it was not implemented yet.
Source code is present, although some blocks are commented away
or hidden with `#if 0`.
RETURN VALUE
------------
The *nutscan_scan_ipmi()* function is not implemented yet.
SEE ALSO
--------
linkman:nutscan_init[3],
linkman:nutscan_scan_usb[3], linkman:nutscan_scan_xml_http_range[3],
linkman:nutscan_scan_nut[3], linkman:nutscan_scan_avahi[3],
linkman:nutscan_scan_snmp[3], linkman:nutscan_display_ups_conf[3],
linkman:nutscan_display_parsable[3], linkman:nutscan_new_device[3],
linkman:nutscan_free_device[3], linkman:nutscan_add_option_to_device[3],
linkman:nutscan_add_device_to_device[3], linkman:nutscan_scan_eaton_serial[3],
linkman:nutscan_cidr_to_ip[3]