# MCipm.ctl:244: Collects Local IPMI Information
# $Id: MCipm.ctl,v 1.6 2014/05/06 11:40:36 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/EXPLORER/MCipm.ctl,v 1.6 2014/05/06 11:40:36 RDA Exp $
#
# Change History
# 20140429  LDE  Add _sn_ tags.

=head1 NAME

EXPLORER:MCipm - Collects Local Intelligent Platform Management Interface
Information

=head1 DESCRIPTION

This module collects local Intelligent Platform Management Interface (IPMI)
information.

=cut

use Explorer
use Mrc

# Initialization
var $VALIDATE = true
keep $VALIDATE

section begin

var $ERR = '---## Associated Errors'
var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'

run EXPLORER:XPLRlib('ipmi')

#------------------------------------------------------------------------------
# XPLR_ipmi section
#------------------------------------------------------------------------------

section XPLR_ipmi

# Validate the execution context
if !${B_GLOBAL:true}
 return
call log_run('Processing IPMI sections ...')

# Locate ipmitool
if $[XPL]->has_ipmitool
 var $IPMITOOL = last
else
 return log_info('Ipmitool is not available')

=head2 ipmi - Intelligent Platform Management Interface

Gathers the Intelligent Platform Management Interface information using the
following commands:

=over 2

=item o C<ipmitool -I bmc chassis poh>

=item o C<ipmitool -I bmc chassis power status>

=item o C<ipmitool -I bmc chassis restart_cause>

=item o C<ipmitool -I bmc chassis status>

=item o C<ipmitool -I bmc fru>

=item o C<ipmitool -I bmc fru print>

=item o C<ipmitool -I bmc mc getenables>

=item o C<ipmitool -I bmc mc info>

=item o C<ipmitool -I bmc pef list>

=item o C<ipmitool -I bmc pef status>

=item o C<ipmitool -I bmc sdr elist full>

=item o C<ipmitool -I bmc sdr list all>

=item o C<ipmitool -I bmc sel elist>

=item o C<ipmitool -I bmc sel info>

=item o C<ipmitool -I bmc sensor list>

=item o C<ipmitool -I bmc sunoem cli version | /bin/grep SP>

=item o C<ipmitool -I bmc sunoem led get>

=item o C<ipmitool -I bmc sunoem sbled get>

=item o C<ipmitool -I bmc -v sel elist>

=item o C<ipmitool -V>

=item o C<ilomconfig list system-summary>

=back

=cut

debug ' Inside IPMI collection, gathering IPMI data information'

# Determine the commands to collect
var @cmd = (\
  ['ipmi/ipmitool_mc_info',\
   $IPMITOOL,'-I bmc mc info',\
   '---+ BMC Hardware Information',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_chassis_restart_cause',\
   $IPMITOOL,'-I bmc chassis restart_cause',\
   '---+ Cause of the Last System Restart',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_chassis_power_status',\
   $IPMITOOL,'-I bmc chassis power status',\
   '---+ Chassis Power Status',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_mc_getenables',\
   $IPMITOOL,'-I bmc mc getenables',\
   '---+ Enabled Options for the BMC',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_fru',\
   $IPMITOOL,'-I bmc fru',\
   '---+ Field Replaceable Unit (FRU) Information',\
   {out=>{tag=>'_sn_ipmitool_I_bmc_fru_'},req=>{inc=>4}}],\
  ['ipmi/ipmitool_fru_print',\
   $IPMITOOL,'-I bmc fru print',\
   '---+ Field Replaceable Unit (FRU) Information',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sdr_elist_full',\
   $IPMITOOL,'-I bmc sdr elist full',\
   '---+ Full Sensor Data Records (SDR)',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sunoem_cli_version',\
   $IPMITOOL,'-I bmc sunoem cli version | /bin/grep SP',\
   '---+ Output of Version ILOM CLI Command',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_pef_status',\
   $IPMITOOL,'-I bmc pef status',\
   '---+ Platform Event Filtering (PEF) Status',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_pef_list',\
   $IPMITOOL,'-I bmc pef list',\
   '---+ Platform Event Filtering (PEF) Table Entries',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_chassis_poh',\
   $IPMITOOL,'-I bmc chassis poh',\
   '---+ Power-On Hours Counter',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sunoem_led_get',\
   $IPMITOOL,'-I bmc sunoem led get',\
   '---+ Read LED Status',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sunoem_sbled_get',\
   $IPMITOOL,'-I bmc sunoem sbled get',\
   '---+ Read LED Status',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sensor_list',\
   $IPMITOOL,'-I bmc sensor list',\
   '---+ Sensors and Thresholds Information',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sdr_list_all',\
   $IPMITOOL,'-I bmc sdr list all',\
   '---+ Sensor Data Repository Entries and Readings',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_chassis_status',\
   $IPMITOOL,'-I bmc chassis status',\
   '---+ Status of the System Chassis and Main Power',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sel_elist',\
   $IPMITOOL,'-I bmc sel elist',\
   '---+ System Event Log (SEL) Contents',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_sel_info',\
   $IPMITOOL,'-I bmc sel info',\
   '---+ System Event Log (SEL) Contents',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_-v_sel_elist',\
   $IPMITOOL,'-I bmc -v sel elist',\
   '---+ System Event Log (SEL) Contents with Increased Verbosity',\
   {req=>{inc=>4}}],\
  ['ipmi/ipmitool_-v',\
   $IPMITOOL,'-V',\
   '---+ Version Information for Ipmitool'])
if ?nvl(testFile('x','/usr/bin/ilomconfig'),\
        testFile('x','/usr/sbin/ilomconfig'))
 call push(@cmd,\
   ['ipmi/ilomconfig_list_system-summary',\
    last,'list system-summary',\
    '---+ List System Summary',\
    {req=>{inc=>4}}])

# Generate the report
report ipmi
title '---+!! Intelligent Platform Management Interface'
title $TOC
call do_exec(@cmd)
if isCreated(true)
 toc '2:[[',getFile(),\
     '][rda_report][Intelligent Platform Management Interface]]'

=head1 SEE ALSO

L<EXPLORER:DCxplr|collect::EXPLORER:DCxplr>,
L<EXPLORER:XPLRlib|collect::EXPLORER:XPLRlib>

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut