ipmimisc  README

Files included:

/usr/share/ipmimisc/tamutil    - use direct TAM commands to manage the front 
				 panel LEDs, either locally or via IPMI LAN.
/usr/share/ipmimisc/tamled     - use the TAM API to manage the front panel LEDs
/usr/share/ipmimisc/getadvipmi - show the Advanced IPMI parameters from IMM
/usr/share/ipmimisc/immconfig  - show and configure IMM parameters
/usr/share/ipmimisc/diskevents - catch HSC disk events and send SNMP traps
/usr/share/ipmimisc/iresetbmc  - resets BMC to factory defaults, restarts BMC
/usr/share/ipmimisc/seltime    - sync BMC SEL time with OS system time

/usr/share/ipmimisc/sensorm    - show SDRs and set thresholds, even if mBMC
/usr/share/ipmimisc/iboot      - like ipmiutil reset, but sets Init strings
/usr/share/ipmimisc/amtcfg     - shows and configures AMT 1.0 parameters
/usr/share/ipmimisc/icmd       - standalone build of ipmiutil cmd
/usr/share/ipmimisc/alarms     - standalone of ipmiutil alarms for diskevents
/usr/share/ipmimisc/ievents    - decode raw 16-byte IPMI events

/usr/share/ipmimisc/README     - this document
/usr/share/ipmimisc/COPYING    - license
/usr/share/ipmimisc/diskevt.sh - init.d script to start/stop diskevents svc
/usr/share/ipmimisc/iommib.mib - adaptec IOM MIB for default disk events
/usr/share/ipmimisc/ipmi_if.sh - script to detect IPMI interface type
/usr/share/ipmimisc/libfreeipmi.so - sample FreeIPMI library
/usr/share/ipmimisc/libtamapi.so.1 - TAM API library for tamled

/usr/share/man/man8/diskevents.8.gz
/usr/share/man/man8/getadvipmi.8.gz
/usr/share/man/man8/immconfig.8.gz
/usr/share/man/man8/tamled.8.gz
/usr/share/man/man8/tamutil.8.gz
/usr/share/man/man8/seltime.8.gz

-----------------------------------------------------------------------------
USAGE INFORMATION
1.1     DISKEVENTS (diskevents)
1.2     IMMCONFIG  (immconfig)
1.3     GETADVIPMI (getadvipmi)
1.4     TAMLED     (tamled)
1.5     TAMUTIL    (tamutil)
1.6     SELTIME    (seltime)

-----------------------------------------------------------------------------
1.1     DISKEVENTS (diskevents)

DISKEVENTS(8)							DISKEVENTS(8)

NAME
       diskevents - monitor disk events and send SNMP traps

SYNOPSIS
       diskevents [-h <host> -t <time> -x -NUP]

DESCRIPTION
       A  service to monitor the SAF-TE disk insertion and removal events via
       IPMI and send SNMP traps when these events occur.   This	 service  can
       run under Linux or Windows.

       This utility can use either the /dev/ipmi0 driver from MontaVista, the
       /dev/imb driver from Intel, the /dev/ipmikcs driver from	 valinux,  or
       the GNU FreeIPMI library.

OPTIONS
       -a     show all new SEL records

       -f file
	      index file with path, default=/var/log/diskevt.idx

       -h host
	      specifies	 the  hostname	or IP Address of the SNMP server.  It
	      will be sent enterprises.795.12.1 traps.

       -o     run Once only, otherwise runs forever

       -t time
	      time interval in seconds between loops

       -x     Display extra debug messages

       -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.

       -P/-R password
	      Remote password for the nodename given.  The default is a	 null
	      password.

       -U username
	      Remote  username for the nodename given.	The default is a null
	      username.

       -E     Use the remote password from  Environment	 variable  IPMI_PASS-
	      WORD.

       -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,
	      2=User   level,	3=Operator   level,   4=Administrator	level
	      (default), 5=OEM level.


-----------------------------------------------------------------------------

1.2     IMMCONFIG  (immconfig)

IMMCONFIG(8)							 IMMCONFIG(8)

NAME
       immconfig - gets and sets IMM advanced IPMI parameters

SYNOPSIS
       immconfig [-mnohktx] [-pN=value]

DESCRIPTION
       immconfig  is  a	 program  that	uses IPMI commands to get and set IMM
       advanced parameters for a TIGI2U IMM.  It shows parameters  for the
       following  IMM  advanced  features: SMTP, HTTP, telnet, SNMP, and
       KVM.

       This utility can use either the /dev/ipmi0 OpenIPMI driver  from	 Mon-
       taVista,	 the /dev/imb driver from Intel, the /dev/ipmikcs driver from
       valinux, or user-space direct I/Os if no driver is detected.

OPTIONS
       -m0    disable SMTP alerting

       -m1    enable SMTP alerting

       -n0    disable SNMP gets and sets, SNMP traps are supported  via	 IPMI
	      PET.

       -n1    enable  SNMP  gets  and sets, SNMP traps are supported via IPMI
	      PET.

       -o0    disable Serial-Over-LAN (SOL)

       -o1    enable Serial-Over-LAN (SOL)

       -h0    disable HTTP web service

       -h1    enable HTTP web service

       -k0    disable embedded KVM

       -k1    enable embedded KVM

       -t0    disable Telnet service

       -t1    enable Telnet service

       -pN=value
	      Sets another parameter number  N	with  the  ’value’  specified
	      within the section designated by one of the other options.

       -x     Causes extra debug messages to be displayed.


-----------------------------------------------------------------------------

1.3     GETADVIPMI (getadvipmi)

GETADVIPMI(8)							GETADVIPMI(8)

NAME
       getadvipmi - Gets advanced IPMI parameters for IMM

SYNOPSIS
       getadvipmi [-P pswd]

DESCRIPTION
       getadvipmi is a program that uses IPMI commands to get advanced param-
       eters from a TIGI2U IMM.	 It shows parameters for  the  following  IMM
       advanced features: SMTP, HTTP, telnet, SNMP, and KVM.

       This utility can use either the /dev/ipmi0 driver from MontaVista, the
       /dev/imb driver from Intel, the /dev/ipmikcs driver from	 valinux,  or
       the GNU FreeIPMI library.

OPTIONS
       No options are currently supported.


-----------------------------------------------------------------------------

1.4     TAMLED     (tamled)

TAMLED(8)							    TAMLED(8)

NAME
       tamled - display and set alarm indicators

SYNOPSIS
       tamled [-agicmnpx]

DESCRIPTION
       tamled  is  a  program  that uses TAM API functions to display and set
       alarm indicators, which are usually LEDs on the system  chassis	front
       panel.  This utility requires that the TAM software daemon is started.

       Kontron provides a Telco Alarms Manager API which presents  a  consoli-
       dated interface for all alarm management applications.

OPTIONS
       Command line options are described below.


       -a01   Sets  the alarm ID for setting/clearing TAM records.  The value
	      is read as hex digits.  The default is 0x01.

       -g51   Sets the generator ID for setting/clearing  TAM  records.	  The
	      value is read as hex digits.  The default is 0x51.

       -i61   Sets  the generator Info for setting/clearing TAM records.  The
	      value is read as hex digits.  The default is 0x61.

       -cN    Sets a Critical Alarm.  If N=0, turn it off.  If N=1,  turn  it
	      on.

       -mN    Sets  a Major Alarm.  If N=0, turn it off.  If N=1, turn it on.

       -nN    Sets a Minor Alarm.  If N=0, turn it off.	 If N=1, turn it  on.

       -pN    Sets  a Power Alarm.  If N=0, turn it off.  If N=1, turn it on.
	      Note that the Power LED is also wired to the System  Fault  LED
	      in  the back of the system, so this state may be off for Power,
	      but the LED could be lit for a  System  Fault  reason  instead.
	      Refer  to the system Technical Product Specification for System
	      Faults.

       -x     Causes extra debug messages to be displayed.

SEE ALSO
       tamutil(8) for BMC TAM without TAM daemon


-----------------------------------------------------------------------------

1.5     TAMUTIL    (tamutil)

TAMUTIL(8)							   TAMUTIL(8)

NAME
       tamutil - display and set alarm indicators

SYNOPSIS
       tamutil [-agicmnprIx -N node -U user -P/-R pswd -ETV]

DESCRIPTION
       tamutil	is a program that uses IPMI commands to display and set alarm
       indicators, which are usually LEDs on the system chassis front  panel.
       This utility can use either the /dev/ipmi0 driver from MontaVista, the
       /dev/imb driver from Intel, the /dev/ipmikcs driver from valinux,  the
       GNU FreeIPMI library, or IPMI LAN.

       Note that this utility may not be the only logic setting alarm states.
       The BMC firmware, system management software, or cluster fault manager
       may also want to set alarm states.  Kontron provides a Telco Alarms 
       Manager API which presents a consolidated interface for all alarm 
       management applications.

OPTIONS
       Command line options are described below.

       -a01   Sets  the alarm ID for setting/clearing TAM records.  The value
	      is read as hex digits.  The default is 0x01.

       -g51   Sets the generator ID for setting/clearing  TAM  records.	  The
	      value is read as hex digits.  The default is 0x51.

       -i61   Sets  the generator Info for setting/clearing TAM records.  The
	      value is read as hex digits.  The default is 0x61.

       -cN    Sets a Critical Alarm.  If N=0, turn it off.  If N=1,  turn  it
	      on.

       -mN    Sets  a Major Alarm.  If N=0, turn it off.  If N=1, turn it on.

       -nN    Sets a Minor Alarm.  If N=0, turn it off.	 If N=1, turn it  on.

       -pN    Sets  a Power Alarm.  If N=0, turn it off.  If N=1, turn it on.
	      Note that the Power LED is also wired to the System  Fault  LED
	      in  the back of the system, so this state may be off for Power,
	      but the LED could be lit for a  System  Fault  reason  instead.
	      Refer  to the system Technical Product Specification for System
	      Faults.

       -I5    Sets the ID LED for 5 seconds.  If 0, turn it off.  If 255 (and
	      IPMI 2.0), turn it on forever.

       -r     Removes  the  specified TAM Entry.  This can be used along with
	      -g,-i,-a to specify removing a previously displayed TAM  entry.
	      By  default,  if	no  other  parameters are used, the first TAM
	      entry will be removed.

       -t     Tests whether or not BMC TAM is enabled and active.  The return
	      status is 1 if BMC TAM is active, and 0 otherwise.

       -x     Causes extra debug messages to be displayed.


       -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.

       -P/-R password
	      Remote  password for the nodename given.	The default is a null
	      password.

       -U username
	      Remote username for the nodename given.  The default is a	 null
	      username.

       -E     Use  the	remote	password from Environment variable IPMI_PASS-
	      WORD.

       -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,
	      2=User   level,	3=Operator   level,   4=Administrator	level
	      (default), 5=OEM level.

SEE ALSO
       tamled(8)

-----------------------------------------------------------------------------

1.6     SELTIME    (seltime)

SELTIME(8)							    SELTIME(8)


NAME
       seltime - synchronize BMC SEL time with OS system time

SYNOPSIS
       seltime [-sx -NUPRETVF]


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.

       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.


OPTIONS
       -s     Sets the SEL time (usually once a day).

       -x     Causes eXtra debug messages to be displayed.


       -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.

       -P/-R password
	      Remote  password	for the nodename given.	 The default is a null
	      password.

       -U username
	      Remote username for the nodename given.  The default is  a  null
	      username.

       -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,
	      gnu, landesk, lan, lan2, lan2i, kcs, smb.	 Note that lan2i means
	      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,
	      3=sha1/sha1/cbc128,  4=sha1/sha1/xrc4_128,  5=sha1/sha1/xrc4_40,
	      6=md5/none/none, ... 14=md5/md5/xrc4_40.

       -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,
	      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.
	      Alternatives for the password are -E or -P.



SEE ALSO
       tamutil(8)


-----------------------------------------------------------------------------

