docs/man/nutscan.txt

   1 NUTSCAN(3)
   2 ==========
   3
   4 NAME
   5 ----
   6
   7 nutscan - Network UPS Tools (NUT) device discovery library
   8
   9 DESCRIPTION
  10 -----------
  11
  12 The Network UPS Tools (NUT) *nutscan* library provides the same discovery
  13 related features that are also offered by linkman:nut-scanner[8].
  14
  15 It enables the discovery of supported NUT devices (USB, SNMP, Eaton XML/HTTP
  16 and IPMI) and NUT servers (using Avahi, or the classic connection method).
  17
  18
  19 DISCOVERY FUNCTIONS
  20 -------------------
  21
  22 First, include the required header file:
  23
  24  #include <nut-scan.h>
  25
  26 Then, to discover new devices, use the appropriate function:
  27
  28 - linkman:nutscan_scan_usb[3] for supported USB devices,
  29 - linkman:nutscan_scan_snmp[3] for supported SNMP agents,
  30 - linkman:nutscan_scan_xml_http[3] for Eaton Network Management Card,
  31 - linkman:nutscan_scan_nut[3] for NUT servers (upsd), using the classic method,
  32 - linkman:nutscan_scan_avahi[3] for NUT servers (upsd), using the mDNS (Avahi) method,
  33 - linkman:nutscan_scan_ipmi[3] for supported IPMI PSU.
  34
  35
  36 All of these functions return a list of devices found, using the nutscan_device_t
  37 structure. This structure is described in linkman:nutscan_add_device_to_device[3].
  38
  39 Helper functions are also provided to output data using standard formats:
  40
  41 - linkman:nutscan_display_parsable[3] for parsable output,
  42 - linkman:nutscan_display_ups_conf[3] for ups.conf style.
  43
  44
  45 ERROR HANDLING
  46 --------------
  47 There is currently no specific mechanism for error handling.
  48
  49
  50 SEE ALSO
  51 --------
  52 linkman:nut-scanner[8],
  53 linkman:nutscan_scan_usb[3], linkman:nutscan_scan_snmp[3],
  54 linkman:nutscan_scan_xml_http[3], linkman:nutscan_scan_nut[3],
  55 linkman:nutscan_scan_avahi[3], linkman:nutscan_scan_ipmi[3],
  56 linkman:nutscan_display_parsable[3], linkman:nutscan_display_ups_conf[3],
  57 linkman:nutscan_new_device[3], linkman:nutscan_free_device[3],
  58 linkman:nutscan_add_device_to_device[3], linkman:nutscan_add_option_to_device[3],
  59 linkman:nutscan_cidr_to_ip[3],
  60 http://avahi.org/