pefconfig(8) - Linux man page

Name

pefconfig - show and configure BMC LAN parameters and set up a PEF entry to send BMC LAN Alerts for OS Critical Stop log events

Synopsis

pefconfig [-delq#rstx -n pefnum -i eth1 -a alertnum ] [-I ipadr -M macadr -S subnet -B baud_sol ]
[-G gwyip -H gwymac -L lan_channel_num ]
[-A alertip -X alertmac -C community ]
[-u user_to_set -p password_to_set ]
[-N nodename -U rmt_username -Fimb ]
[-P/-R rmt_node_pswd -E -T1 -V2 ]

Description

pefconfig is a program that uses an IPMI driver to send IPMI commands which configure a new Platform Event Filter table entry for an OS Critical Stop (0x20) SEL firmware log event, so that it will be enabled to send a BMC LAN Alert. This utility also sets up all of the BMC LAN Parameters to enable sending the BMC LAN Alerts. The IP address and MAC address of the local system, the default gateway, and the alert destination can be defaulted to those specified in Linux, or can be overridden by user parameters. This utility can use either the /dev/ipmi0 driver from OpenIPMI, the /dev/imb driver from Intel, the /dev/ipmikcs driver from valinux, direct user-space IOs, or the IPMI LAN interface if -N. This utility is designed to be used on systems with IPMI 1.5 or greater in order to support PEF records.

Options

Command line options are described below. Note that without options, pefconfig behaves as if option -r were used. To configure IPMI LAN & PEF, use option -e.
-a alertnum
Specify which PEF alert number is to be used. Default is 1. This would only be used if extra PEF alert destinations had been set.
-d
This option disables the BMC LAN and PEF parameters, so as not to allow BMC LAN connections or alerts.
-e
This option enables the BMC LAN configuration and PEF event alerts. The utility will attempt to obtain the default BMC LAN parameters from the OS automatically, or they can be specified with command options below.
-i ethif
By default, the eth0 interface is used to find IP and MAC addresses. Sometimes, however, the first ethernet port on the baseboard may be represented by Linux as eth1 or eth2 instead. If so, use this option to indicate the correct ethernet interface to use. By default, pefconfig will scan up to 32 eth interfaces for the onboard one that BMC LAN uses.
-l
This option enables the BMC LAN configuration, but not PEF events. The utility will attempt to obtain the default BMC LAN parameters from the OS automatically, or they can be specified with command options below.
-n num
By default, the new PEF entry for OS Critical Stop is inserted at offset 12 into the table. This can be changed to insert it at an offset > 12 if another entry already exists at offset 12.
-#
Same as -q below.
-q
Specify an alternate user number for the LAN username from the -u option. This is normally user number 2, 3, or 4, where 2 is the default. The maximum number of users is 15.
-r
This option just reads the configuration without writing any BMC LAN parameters or writing any new entries to the PEF table.
-s
This option will also display some of the Serial parameters.
-t
Test if the BMC LAN has already been configured. Returns 0 if so.
-x
Causes extra debug messages to be displayed.
-B baud_sol
This specifies the Baud rate for SerialOverLan. The possible values are: 9600, 19.2k, 38.4k, 57.6k, and 115.2k. The default is 19.2k.
-D
This causes the local IP address to be determined by DHCP instead of a static IP address.
-I ip_addr
This specifies the local IP address to use for the BMC LAN on eth0. The default is to automatically obtain this from the Linux ifconfig.
-M mac_addr
This specifies the local MAC address to use for the BMC LAN on eth0. The format can be either 11:22:33:44:55:66 or 11-22-33-44-55-66. The default is to automatically obtain this from the Linux ifconfig.
-S subnet
This specifies the local subnet mask to use for the BMC LAN on eth0. The default is to automatically obtain this from the Linux ifconfig.
-G gwy_ip_addr
This specifies the default gateway IP address to use for the BMC LAN. The default is to automatically obtain this from the Linux route table.
-H gwy_mac_addr
This specifies the default gateway's MAC address to use for the BMC LAN. The format can be either 11:22:33:44:55:66 or 11-22-33-44-55-66. The default is to automatically obtain this from the Linux arp cache.
-A alert_ip_addr
This specifies the SNMP Alert Destination IP address to use for the BMC LAN. By default, this utility will attempt to obtain this from the /etc/snmp/snmpd.conf file, via the trapsink parameter. The alert destination will see the BMC LAN traps with the enterprises.3183.1.1 OID. If no alert IP address is specified in either snmpd.conf or this parameter, or if that IP address does not respond, the other SNMP parameters for BMC LAN will be skipped.
-X alert_mac_addr
This specifies the SNMP Alert Destinations's MAC address to use for the BMC LAN. The format can be either 11:22:33:44:55:66 or 11-22-33-44-55-66. The default is to attempt to obtain this from the Linux arp cache. This parameter is ignored if there is no Alert IP address.
-C snmp_community
This specifies the SNMP Community name to use for BMC LAN Alerts. The default community string is "public". This parameter is ignored if there is no Alert IP address.
-u username_to_set
This specifies the firmware username to set for BMC LAN access. If a username is specified, user 3 will be set. If not specified, the default user 1 will be used.
-p password_to_set
This specifies the firmware password to set for BMC LAN access. If not specified, the user and password configuration will not be changed.
-L lan_ch_num
This specifies the IPMI LAN channel number used for BMC LAN. This varies by platform, and can be found in the platform technical specifications. By default, pefconfig scans all IPMI channels to find a LAN channel for BMC LAN.
-N nodename
Nodename or IP address of the remote target system. If a nodename is specified, IPMI LAN interface is used. Otherwise the local system management interface is used.
-P/-R rmt_pswd
Remote password for the nodename given. The default is a null password.
-U rmt_user
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, lan2, lan, kcs, smb. The default is to detect any available driver type and use it.
-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.

Examples

To read existing settings:
pefconfig -r

To enable IPMI LAN with default settings detected:
pefconfig -e

To set up IPMI LAN for a unique IP address and set PEF SNMP Alerts:
pefconfig -e -I 192.168.1.1 -A 192.168.1.10

To set the IPMI LAN password for the default user:
pefconfig -e -p mypassword

To disable access to the IPMI LAN channel:

pefconfig -d

Sample Pef Table

These 11 PEF table entries are configured from the factory for various Intel Sahalee BMC systems, and will be applied as the defaults for a system with an empty PEF table:
PEF(01): 01 Temperature Sensor event - enabled for alert
01 c0 01 01 00 ff ff 01 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(02): 02 Voltage Sensor event - enabled for alert
02 c0 01 01 00 ff ff 02 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(03): 04 Fan Failure event - enabled for alert
03 c0 01 01 00 ff ff 04 ff 01 95 0a 00 00 00 00 00 00 00 00 00
PEF(04): 05 Chassis Intrusion event - enabled for alert
04 c0 01 01 00 ff ff 05 05 6f 01 00 00 00 00 00 00 00 00 00 00
PEF(05): 08 Power Supply Fault event - enabled for alert
05 c0 01 01 00 ff ff 08 ff 6f 06 00 00 00 00 00 00 00 00 00 00
PEF(06): 0c Memory ECC Error event - enabled for alert
06 c0 01 01 00 ff ff 0c 08 6f 02 00 00 00 00 00 00 00 00 00 00
PEF(07): 0f FRB Failure event - enabled for alert
07 c0 01 01 00 ff ff 0f 06 6f 01 00 00 00 00 00 00 00 00 00 00
PEF(08): 07 BIOS POST Error event - enabled for alert
08 c0 01 01 00 ff ff 07 ff 6f 1c 00 00 00 00 00 00 00 00 00 00
PEF(09): 13 Fatal NMI event - enabled for alert
09 c0 01 01 00 ff ff 13 ff 6f 3e 03 00 00 00 00 00 00 00 00 00
PEF(10): 23 Watchdog Timer Reset event - enabled for alert
0a c0 01 01 00 ff ff 23 03 6f 0e 00 00 00 00 00 00 00 00 00 00
PEF(11): 12 System Restart event - enabled for alert
0b c0 01 01 00 ff ff 12 ff 6f 02 00 00 00 00 00 00 00 00 00 00

See Also

alarms(8) bmchealth(8) fruconfig(8) getevent(8) hwreset(8) icmd(8) sensor(8) showsel(8) tmconfig(8) wdt(8)

Warnings

See http://ipmiutil.sourceforge.net/ for the latest version of pefconfig and any bug fix list.

Copyright

Copyright © 2001-2004 Intel Corp.

See the file COPYING in the distribution for more details regarding redistribution.

This utility is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

Author

Andy Cress <arcress@users.sourceforge.net>

Referenced By

isolconsole(8)