docs/man/nut-ipmipsu.txt

   1 NUT-IPMIPSU(8)
   2 ==============
   3
   4 NAME
   5 ----
   6
   7 nut-ipmipsu - Driver for IPMI Power Supply Units (PSU)
   8
   9 SYNOPSIS
  10 --------
  11
  12 *nut-ipmipsu* -h
  13
  14 *nut-ipmipsu* -a 'PSU_NAME' ['OPTIONS']
  15
  16 NOTE: This driver is experimental, and still a work-in-progress. Feedback is
  17 encouraged.
  18
  19 NOTE: This man page only documents the hardware-specific features of the
  20 nut-ipmipsu driver.  For information about the core driver, see
  21 linkman:nutupsdrv[8].
  22
  23 SUPPORTED HARDWARE
  24 ------------------
  25
  26 This driver should support a wide range of PSUs through local IPMI interface.
  27
  28 nut-ipmipsu currently use the GNU FreeIPMI project, for IPMI implementation.
  29
  30
  31 EXTRA ARGUMENTS
  32 ---------------
  33
  34 This driver doesn't support any optional settings.
  35
  36 INSTALLATION
  37 ------------
  38
  39 This driver is not built by default.  You can build it by using
  40 "configure --with-ipmi=yes".
  41
  42 You also need to give proper permissions on the local IPMI device file
  43 (/dev/ipmi0 for example) to allow the NUT user to access it.
  44
  45 An udev rules file (nut-ipmipsu.rules) is provided and automatically installed
  46 on udev enabled system. This file is generally installed in /etc/udev/rules.d/
  47 or /lib/udev/rules.d/ on newer systems, to address the permission settings
  48 problem. For more information, refer to nut/scripts/udev/README.
  49
  50 INSTANT COMMANDS
  51 ----------------
  52
  53 This driver doesn't support any instant commands.
  54
  55 IMPLEMENTATION
  56 --------------
  57
  58 The "port" value is used to identify the PSU.  For instance, to target
  59 FRU 0x2, use the following in *ups.conf*:
  60
  61         [pdu]
  62                 driver = nut-ipmipsu
  63                 port = id2
  64
  65 This driver will report various information related to a PSU, including:
  66
  67  - manufacturer, model, serial and part numbers,
  68  - nominal voltage and frequency,
  69  - actual current and voltage,
  70  - status of the PSU:
  71
  72    * 'OL' means that the PSU is present and providing power,
  73    * 'OFF' means that the PSU is present but not providing power (power cable removed),
  74    * 'stale' (no data) means that the PSU is not present (ie physically removed).
  75
  76 Here is an example output for a Dell r610 server:
  77
  78         device.mfr: DELL
  79         device.mfr.date: 01/05/11 - 08:51:00
  80         device.model: PWR SPLY,717W,RDNT
  81         device.part: 0RN442A01
  82         device.serial: CN179721130031
  83         device.type: psu
  84         driver.name: nut-ipmipsu
  85         driver.parameter.pollinterval: 2
  86         driver.parameter.port: id2
  87         driver.version: 2.6.1-3139M
  88         driver.version.data: IPMI PSU driver
  89         driver.version.internal: 0.01
  90         input.current: 0.20
  91         input.frequency.high: 63
  92         input.frequency.low: 47
  93         input.voltage: 232.00
  94         input.voltage.maximum: 264
  95         input.voltage.minimum: 90
  96         ups.id: 2
  97         ups.realpower.nominal: 717
  98         ups.status: OL
  99         ups.voltage: 12
 100
 101 AUTHOR
 102 ------
 103 Arnaud Quette <arnaud.quette@free.fr>
 104
 105 SEE ALSO
 106 --------
 107 The core driver:
 108 ~~~~~~~~~~~~~~~~
 109 linkman:nutupsdrv[8]
 110
 111 Internet resources:
 112 ~~~~~~~~~~~~~~~~~~~
 113 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
 114
 115 GNU FreeIPMI home page: http://www.gnu.org/software/freeipmi/