summaryrefslogtreecommitdiff
path: root/doc/UserGuide
diff options
context:
space:
mode:
authorJörg Frings-Fürst <debian@jff.email>2018-08-01 11:19:06 +0200
committerJörg Frings-Fürst <debian@jff.email>2018-08-01 11:19:06 +0200
commitc23016096ab5f8bae409006306e6652e04da030a (patch)
tree255c96d4ea8bd891508720bd98b3b40a4b787459 /doc/UserGuide
parentc7d4db3862a24474655a43c98572e82503d9fa6b (diff)
parentf3bbd65d98b943e7224be2c1ff242fcf04386701 (diff)
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'doc/UserGuide')
-rw-r--r--doc/UserGuide95
1 files changed, 51 insertions, 44 deletions
diff --git a/doc/UserGuide b/doc/UserGuide
index 7f7b705..ee16696 100644
--- a/doc/UserGuide
+++ b/doc/UserGuide
@@ -1,6 +1,6 @@
IPMIUTIL USER GUIDE
- VERSION 3.1.1
+ VERSION 3.1.2
An easy-to-use IPMI server management utility
@@ -2955,6 +2955,9 @@ OPTIONS
-x Causes eXtra debug messages to be displayed.
+ -y Ignore the check for FRU size overflow, and update the FRU any-
+ way.
+
-N nodename
Nodename or IP address of the remote target system. If a node-
name is specified, IPMI LAN interface is used. Otherwise the
@@ -4512,76 +4515,81 @@ ISELTIME(8) ISELTIME(8)
NAME
- iseltime - synchronize BMC SEL time with OS system time
+ iseltime - synchronize BIOS RTC and firmware SEL time from system time
SYNOPSIS
- seltime [-sx -NUPRETVF]
+ iseltime [-sx -N node -U user -P/-R pswd -EFJTVYZ]
DESCRIPTION
- seltime is a program that uses IPMI commands to set the BMC SEL time
- from the OS system time. The OS system time should be in sync with the
- BIOS Real-Time-Clock. The OS system time may also be kept from drift-
- ing via an NTP server. Normally the BIOS will set the BMC time from
- the RTC during boot, but running this command may be necessary periodi-
- cally if the system does not reboot for many weeks, for instance. Note
- that this command should not be run too frequently to avoid BMC timing
- issues. Once per day should be sufficient.
-
- Run with no options, this command reads the BMC SEL time without set-
- ting anything.
+ iseltime is a program that allows synchronizing the hardware time val-
+ ues for RTC (BIOS Real-Time-Clock) and SEL (IPMI firmware SEL time)
+ with the OS system time. Run without options, iseltime shows each of
+ these times to show whether they are the same or not.
- This utility can use either the /dev/ipmi0 openipmi driver, the
- /dev/imb Intel driver, the /dev/ipmikcs valinux driver, a driverless
- interface, or IPMI LAN.
+ The OS system time should be in sync with the BIOS Real-Time-Clock.
+ The OS system time may also be kept from drifting via an NTP server.
+ Normally the BIOS will set the firmware SEL time from the RTC during
+ boot, but running this command may be necessary periodically if the
+ system does not reboot for a long time, for instance. Note that some
+ applications may not handle setting the time backward well. Note that
+ this command should not be run too frequently to avoid firmware timing
+ issues. It should not be set more than once per day.
OPTIONS
- -s Sets the SEL time (no more than once a day).
+ Command line options are described below.
- -x Causes eXtra debug messages to be displayed.
+ -s Set the RTC and IPMI firmware SEL time to match the system time.
+ This should not be performed more often than once a day.
- -N nodename
- Nodename of the remote target system. If a nodename is speci-
- fied, IPMI LAN interface is used. Otherwise the local system
- management interface is used.
+ -x Causes eXtra debug messages to be displayed.
- -P/-R password
- Remote password for the nodename given. The default is a null
- password.
+ -N nodename
+ Nodename or IP address of the remote target system. If a node-
+ name is specified, IPMI LAN interface is used. Otherwise the
+ local system management interface is used.
- -U username
+ -U rmt_user
Remote username for the nodename given. The default is a null
username.
+ -P/-R rmt_pswd
+ Remote password for the nodename given. The default is a null
+ password.
+
-E Use the remote password from Environment variable IPMI_PASSWORD.
-F drv_t
- Force the driver type to one of the followng: imb, va, open,
+ Force the driver type to one of the followng: imb, va, open,
gnu, landesk, lan, lan2, lan2i, kcs, smb. Note that lan2i means
- lan2 with intelplus. The default is to detect any available
+ lan2 with intelplus. The default is to detect any available
driver type and use it.
- -J Use the specified LanPlus cipher suite (0 thru 14):
- 0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
+ -J Use the specified LanPlus cipher suite (0 thru 17):
+ 0=none/none/none, 1=sha1/none/none, 2=sha1/sha1/none,
3=sha1/sha1/cbc128, 4=sha1/sha1/xrc4_128, 5=sha1/sha1/xrc4_40,
- 6=md5/none/none, ... 14=md5/md5/xrc4_40.
+ 6=md5/none/none, ... 14=md5/md5/xrc4_40. Default is 3.
- -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
+ -T Use a specified IPMI LAN Authentication Type: 0=None, 1=MD2,
2=MD5, 4=Straight Password, 5=OEM.
- -V Use a specified IPMI LAN privilege level. 1=Callback level,
+ -V Use a specified IPMI LAN privilege level. 1=Callback level,
2=User level, 3=Operator level, 4=Administrator level (default),
5=OEM level.
- -Y Yes, do prompt the user for the IPMI LAN remote password.
+ -Y Yes, do prompt the user for the IPMI LAN remote password.
Alternatives for the password are -E or -P.
+ -Z Set the slave address for a local MC
+
SEE ALSO
- ipmiutil(8) isel(8) ievents(8) icmd(8)
+ ipmiutil(8) ialarms(8) iconfig(8) icmd(8) idiscover(8) ievents(8)
+ igetevent(8) ihealth(8) ilan(8) ireset(8) isel(8) isensor(8) iserial(8)
+ isol(8) iwdt(8)
WARNINGS
@@ -5354,14 +5362,8 @@ require this step.
The utilities can be run separately, or an ipmiutil directory can be
added into the %PATH%.
-A sample install batch file:
-> set MYBIN=c:\bin
-> copy libeay32.dll %SystemRoot%\system32
-> copy ssleay32.dll %SystemRoot%\system32
-> copy showselmsg.dll %SystemRoot%\system32
-> start showsel.reg
-> mkdir %MYBIN%
-> copy *.exe %MYBIN%
+If using the ipmiutil*.msi, it will automatically install.
+If using the ipmiutil*.zip, then run the install.cmd to install it.
The usage of ipmiutil in Windows is the same as in Linux OS, with the
exception of drivers:
@@ -6294,6 +6296,11 @@ using the ipmiutil library.
8.1 Build instructions for Linux
+Prerequisite packages to build the binaries (make):
+ autoconf automake libopenssl-devel gcc gcc-c++ libtool
+Prerequisite packages to make the rpm (make rpm):
+ rpm rpm-build
+
To build with some GPL code:
If you are building ipmiutil for open-source, then the MD2 hash
for IPMI LAN and the valinux driver interface (/dev/ipmikcs) can