Table of Contents

• User Interface Overview

• Creating and Viewing Event Reports

• Launching and Configuring Web servers

• HP-UX Webserver Environment

• SMS Web Server Environment

• Error Handling

• Help

• Detailed Web Page Descriptions

• Functional Specifications

• Performance

• Security

• Valid Configurations

• Standards/Guidelines/Policies/Conventions

IPMI Event Viewer Graphical User Interface (GUI)
***This is the user guide for the GUI only***

User Interface Overview

Initially, the GUI presents the Selection Criteria web page, which contains a "View Events" button. Once the selection criteria have been made and the "View Events" button is clicked, a summary web page is presented in "keyword" format if a log file is specified, or a detail web page is presented if a hex event word pair is specified.

Numbered rows on the summary page may be clicked to open a new window displaying a single event in the most verbose level of detail.

Column headings and field labels may be clicked to open pop-up help windows.

For more information about the user interface, see the Detailed Web Page Descriptions section of this user guide.

Creating and Viewing Event Reports

1. Start the web server (if it is not already running).
   • HP-UX environment
   • SMS environment
2. Authenticate (HP-UX 11.23 ONLY).
3. Select report criteria.
   • Select a hardware event source.
   • Select filter (optional).
   • Specify platform type (optional).
4. Create report.
5. View events in appropriate report format.

Launching and Configuring Web servers

• Prerequisites for launching slview on Windows using Internet Explorer

  If Internet Explorer Enhanced Security Configuration is enabled:

  • You must disable or remove any pop-up blocking software.
  • You must ensure that the browser settings are configured so that they do not block any popups.
    Following elaborates the procedure to configure the browser settings on Windows system:
    1. On the browser window, click Tools and select Internet Options.
       A dialog box pops up.
    2. Click Privacy. Ensure that Block Popup is unchecked.
    3. Select Security and click Local Intranet.
    4. Click Sites and type the URL http://127.0.0.1 in the Add this website to the zone text box.
    5. Click Add and click Close.
    6. To save the configuration, click OK on the dialog box.

HP-UX Webserver Environment

• Starting the HP-UX Web Server

  A root user (i.e. uid 0) or system startup script must start the Apache web server on HP-UX.

  For HP-UX 11.00 or 11.11 the following command must be executed:

     /opt/hpws/apache/bin/apachectl start
  

  The web server will then run until explicitly stopped.

  For HP-UX 11.23 the following command must be executed:

     /usr/sbin/diag/contrib/slweb -s startssl
          Creating server certificates...
          Certificates successfully created.
          Attempting to start server...
          Server successfully started.
  

  The web server will then run until explicitly stopped.

  The first time the web server is started, server certificates required for https usage are created.

  If slweb is invoked without any -s parameter, it will start the web server if one is not already running. slweb then tries to start a web browser if the DISPLAY environment variable is set.

  If there is no DISPLAY variable, you need to manually start a browser and cut/paste the URL:

     /usr/sbin/diag/contrib/slweb
          Attempting to start server...
          Server successfully started.
          ERROR: DISPLAY environment variable not set.
                 Paste the URL https://hpdst360.cup.hp.com:1188/sl/sl.cgi
                 into a browser or set your DISPLAY variable and rerun slweb
  

  Note: If the web server is started without the -s parameter, it automatically terminates after 10 minutes of inactivity.

  If the DISPLAY variable is set:

     /usr/sbin/diag/contrib/slweb
          Attempting to start server...
          Server already running on correct port. 
          Looking for a usable running browser...
          Looking for a usable browser to start...
             SECURITY WARNING: starting a browser in the current environment
             may open you to security risks.  This is the case when the 
             X Server and the browser are on different systems.  Since slweb
             cannot guarantee a secure browser is available, you may:
               .  Paste the URL https://hpdst360.cup.hp.com:1188/sl/sl.cgi
                  into a browser.
               .  Close any non-local instances of your browser on pal2nai172052.nsr.hp.com
                  and rerun slweb.
               .  Use slweb with the "-F" (force) option.
      
            There is either one or more instances of your browser running on
            pal2nai172052.nsr.hp.com that is not local, or a browser cannot
            be started in a secure mode because the X Server is not on
            the same machine as the display variable.
  

  If the DISPLAY variable is set and the -F option is used:

     /usr/sbin/diag/contrib/slweb -F
          Attempting to start server...
          Server successfully started.
          Looking for a usable running browser...
          Looking for a usable browser to start...
          Attempting to start /opt/mozilla/mozilla...
  
              If for some reason the browser did not start you can
              use slweb by manually starting a browser and pasting the URL
              https://hpdst360.cup.hp.com:1188/sl/sl.cgi
              into the browser.
  

  Note: When a root user invokes slweb to start a web browser, the logon screen is bypassed.

• Stopping the HP-UX Web Server

  A root user (i.e. uid 0) or system shutdown script must stop the Apache web server on HP-UX.

  For HP-UX 11.00 or 11.11 the following command must be executed:

     /opt/hpws/apache/bin/apachectl stop
  

  For HP-UX 11.23 the following command must be executed:

     /usr/sbin/diag/contrib./slweb -s stop
          /opt/hpwebadmin/lbin/apachectl stop: httpd stopped
  

  Note: If the web server is started without the -s parameter, it automatically terminates after 10 minutes of inactivity.

SMS Web Server Environment

There are two SMS web server options available to run the event viewer GUI:

• Apache
• Windows IIS (Internet Information Server)
• HP System Management Homepage Web Server

Apache Web Server

In order to run the event viewer GUI on SMS, you must first verify that the Apache web server is installed. If it is not, you must install and configure the Apache web server software. Follow the instructions below:

1. Verify the Apache Web Server has Been Installed

   The event viewer GUI requires any CGI-compliant web server to be present, with Apache 2.x being the preferred choice.
   

   • Checking for Apache on the Windows SMS

     Click the Start button, then mouse to Settings and then click Control Panel.  Double-click Add/Remove Programs.  If Apache has been installed, you will see an entry for "Apache HTTP Server".
     

   • Checking for Apache on the HP-UX SMS

     Perform the following command to scan the list of installed software to see if Apache is present:
     

     $ /usr/sbin/swlist | grep -i apache
       hpuxwsApache                  B.1.0.10.01    HP-UX Apache-based Web Server
     

     The above example is for the latest version of Apache (2.0.48) at the time of this writing.  Note that older versions of Apache use a product number different from "hpuxwsApache".
     

2. Installing the Apache Web Server

   If Apache is not present, you must install it yourself.
   

   • Installing Apache on the Windows SMS

     Web-browse to http://httpd.apache.org/ and download the latest available Apache Win32 binary distribution.  Double-click the downloaded *.msi file to launch the installer.  Accept the licensing agreement and then proceed through the installer accepting all of the default values.
     

     Apache will be started once the installation has been completed.  Your system will have been configured to start Apache automatically at bootup.
     

   • Installing Apache on the HP-UX SMS

     Web-browse to http://www.software.hp.com/ and download the latest version of the HP-UX Apache-based Web Server.  Follow the instructions provided by HP Software Depot for completing the installation.
     

     To start Apache automatically at bootup, you will need to edit /etc/rc.config.d/hpws_apacheconf to specify "HPWS_APACHE_START=1".
     

3. Configuring the Apache Web Server

   Versions of the SMS that include the event viewer GUI also include a pre-installed Apache configuration file for running the GUI.  This default configuration file tells Apache to only listen to port 80 on the 127.0.0.1 loopback interface, defines the http://127.0.0.1/sl/sl.cgi URL, and disables functionality that is not required to run the event viewer GUI.
   

   Alternatively you can create a custom configuration file as described below.
   

   • Configuring Apache on the Windows SMS

     The default configuration file is installed at C:\Program Files\Apache Group\Apache2\conf\httpd.conf.  If you would like to use your own custom configuration file instead, the recommend and required changes are:
     

     • recommended: Listen 127.0.0.1:80
     • recommended: ServerName 127.0.0.1:80
     • required:    ScriptAlias /sl/sl.cgi "C:/Program Files/Hewlett-Packard/EIT/opt/bin/slview.exe"
       
       

   • Configuring Apache on the HP-UX SMS

     The default configuration file is installed at /opt/hpws/apache/conf/httpd.conf.  If you would like to use your own custom configuration file instead, the recommend and required changes are:
     

     • recommended: Listen 127.0.0.1:80
     • recommended: ServerName 127.0.0.1:80
     • required:    ScriptAlias /sl/sl.cgi /opt/smstools/bin/slview

• Starting the SMS Web Server

  Once the Apache web server software is installed and configured (with the recommended settings included in this user guide), the SMS web server starts automatically at SMS bootup. However, the SMS web server can be started manually.

  To manually start the SMS HP-UX web server, the following command must be executed:

          /opt/hpws/apache/bin/apachectl start
  

  To manually start the SMS Windows web server:

  1. Click Start...Programs...Apache HTTP Server...Control Apache Server from the Windows main tool bar.
  2. Click Start on the current submenu.
     
     

• Stopping the SMS Web Server

  The SMS web server runs whenever the SMS is running, but the web server can be stopped manually.

  To stop the SMS HP-UX web server, the following command must be executed:

        /opt/hpws/apache/bin/apachectl stop
  

  To stop the SMS Windows web server:

  1. Click Start...Programs...Apache HTTP Server...Control Apache Server from the Windows main tool bar.
  2. Click Stop on the current submenu.

Windows IIS

• Configuring IIS on Windows 2000

  To configure IIS on the Windows 2000 system, complete the following procedure:

  1. From the desktop, Select Start > Settings > Control Panel > Administrative Tools.
  2. Double click Internet Services Manager.
  3. Double-click on the hostname and then select Default Web Site.
  4. Right-click Default Web Site and select Properties.
  5. Click Web Site. In the text box, type the following IP Address: 127.0.0.1.
  6. Click Home Directory and complete the following tasks:
     • In Local Path text box, enter C:\Program Files\Hewlett-Packard\EIT\opt\bin.
     • Click Execute Permissions and select Scripts and Executables.
  7. Click Apply.
  8. Right-click Default Web site and then click Start.
     The IIS web server is launched.

     Note: To launch the IPMI event viewer, use the URL http://127.0.0.1/slview.exe.
     To stop the IIS Web server, right-click Default Web Site and click Stop.

• Configuring IIS on Windows 2003

  To configure IIS on the Windows 2003 system, complete the following procedure:

  1. From the desktop, Select Start > Settings > Control Panel > Administrative Tools.
  2. Double click Internet Services Manager.
  3. Double-click on the hostname and then select Web Site.
  4. Double-click Web Site and select Default Web Site.
  5. Right-click Default Web Site and select Properties.
  6. Click Web Site. In the text box, type the following IP Address: 127.0.0.1.
  7. Click Home Directory and complete the following tasks:
     • In Local Path text box, enter C:\Program Files\Hewlett-Packard\EIT\opt\bin.
     • Click Execute Permissions and select Scripts and Executables.
  8. Click Apply.
  9. Click Web Service Extension and select All Unknown CGI Extensions.
  10. Click Allow to allow CGI applications to work with IIS Web server.
  11. Right-click Default Web site and then click Start.
      The IIS web server is launched.

      Note: To launch the IPMI event viewer, use the URL http://127.0.0.1/slview.exe.
      To stop the IIS Web server, right-click Default Web Site and click Stop.

HP System Management Homepage Web Server

Perform the following steps to run the IPMI Event Viewer tool within the HP System Management Homepage web server environment:

1. Verify whether the HP System Management Homepage web server is installed.
   • Check your desktop for the "HP System Management HomePage" icon.
   
   NOTE: You must install the HP System Management Homepage web server software if it is not already installed.
   
   
2. Stop the HP System Management Homepage web server.
   • Click Start-> Settings-> Control Panel-> Administrative Tools-> Services.
   • Select the "HP System Management HomePage" service and click Stop.
3. Install the EIT bundle.
   • Verify that the slview.exe file is in the following directory: "C:\HP\hpsmh\data\cgi-bin\slview\slview.exe".
   • Verify that the slview.xml file is in the following directory: "C:\HP\hpsmh\webapp" directory".
   • Verify that the slview.php file is in the following directory: "C:\HP\hpsmh\data\htdocs\slview".
4. Restart the HP System Management Homepage web server.
   • Click Start-> Settings-> Control Panel-> Administrative Tools-> Services.
   • Select the "HP System Management HomePage" service and click Start.
5. Logon to the HP System Management HomePage (https:\\localhost:2381).
6. Launch the IPMI Event Viewer.
   • Click on the Tools bar and select IPMI Event Viewer.

Authenticate (HP-UX 11.23 only)

• Logging On

  The web server framework used on HP-UX 11.23 requires users to log on with a valid HP-UX username and password.

  Note: The standard Apache web server environment used on HP-UX 11.00, HP-UX 11.11, and SMS does not implement a logon feature.

  To log in to the GUI (for HP-UX 11.23 only):

  1. Browse to URL https://hostname:1188/sl/sl.cgi to display the logon screen.
  2. Enter a valid HP-UX username and password.
  3. Click the "Secure Log On" button.
     
     

• Logging Off

  The user may log off at any time by clicking the "Logoff" hyperlink in the heading area of any GUI web page.

  Note: The "Logoff" hyperlink is not present on HP-UX 11.00, HP-UX 11.11, or SMS.

• Timeouts

  Authentication automatically times out after 20 minutes of inactivity. Any further attempts to use the GUI results in a new logon screen being displayed.

Select Criteria

Upon successful authentication, the Hardware Event Viewer Selection Criteria (Selection Criteria) web page is displayed.

For more information about the Selection Criteria web page, see the Detailed Web Page Descriptions section of this user guide.

• Select Hardware Event Source

  A Hardware Event Source must be selected to produce a report. The following three options are available for hardware event source selection:

  1. Standard Log File- Select a standard log file from a platform-dependent standard directory from the drop-down list box.
  2. Arbitrary Log File (Other log file)- Enter an arbitrary pathname to specify any log file in any directory on the host system.
  3. Hex Event Word Pair- Enter two 64-bit hexadecimal words to describe an event.
     
     

• Select Filter (optional)

  Multiple filters may be specified for a given hardware event. The default for both filters is 0 (minor forward progress), which lists all events. The following filters are available:

  • Alert Level Filter: Specify an alert level filter by selecting one of the standard alert levels from the drop-down list box. Events will only be listed if their alert level is greater than or equal to the value specified in this field.
  • Cell Filter: Specify a cell filter by selecting one cell from the drop-down list box. Only events associated with the selected cell will be listed.
    
    

• Specify Platform Type (optional)

  The user may specify the platform type to be used in decoding the event(s) by selecting a platform from the drop-down list box. This field is dynamically populated by extracting all of the platform types listed in the eventdef file.

  • The default platform type used for decoding events from log files is automatically obtained from the beginning of the log file. If platform information is not present in the log file, a platform type of "0" (generic) is assumed.
  • The default platform type used for decoding an event specified via a hex word pair is "0" (generic).

Create Event Report

Once the selection criteria are entered, click on the "View Events" button at the bottom of the Selection Criteria screen.

View Event Report

The report format displayed depends on the criteria entered on the Selection Criteria web page.

• Event Log Summary Results (Summary Results) Web Page

  The Event Log Summary Results Web Page is displayed if "Standard" or "Other" log file types are specified as the Event Source.

  For more information about the Event Log Summary Results web page, see the Detailed Web Page Descriptions section of this user guide.

  

  
  

• Detail Pop-up Window

  The Detailed Pop-up Window is displayed when a singular event is clicked on in the Event Log Summary Results web page.

  For more information about the Detail Pop-up window, see the Detailed Web Page Descriptions section of this user guide.

  

  
  

• Detail Results for Hex-Event Word Pairs

  A verbose detail web page replaces the selection criteria window when the "View Events" button is pressed and hex event word pair data is present.

  For more information about Detail Results for Hex-Event Word Pairs, see the Detailed Web Page Descriptions section of this user guide.

Error Handling

• Unrecoverable errors:
  Unrecoverable errors that prevent prevent successful event formatting (file access problems, eventdef version mismatches, etc) result in the display of a generic "Unrecoverable Error" window. Any specific error messages returned by slview, the tlcomev event viewer library, or the operating system are displayed in a separate box.
  
  
• Warnings in the keyword display:
  Warnings generated during formatting of the keyword summary or detail window are displayed in a box below the selection criteria box.
  
  
• Warnings in the detail display:
  Warnings generated during formatting of the detail display are displayed in a box below the selection criteria box.
  
  
• Errors in populating the selecton criteria list of standard log files:
  If the drop-down list box of standard log files cannot be populated due to an operating system error or the absence of any log files, an appropriate message appears in the drop-down list box instead of a list of log files.

Help

• Help Pop-up Window for Selection Criteria Fields

  The selection criteria field labels are hyperlinks that, when clicked, will open a small static pop-up help window describing the individual field.

• Help Pop-up Window for Keyword/Detail Column/Row Headings

  The keyword display column headings and the detail display row headings may be clicked to open a brief pop-up help window, which describes that column or row.

Detailed Web Page Descriptions

Selection Criteria Web Page

• The Selection Criteria web page is dynamically generated so that the drop-down list of log files is populated with actual file names. The log files are listed in reverse timestamp order, with the most recently modified log file listed first.
• Disabled fields are "grayed out" in a browser-dependent manner.
• Clicking the "Clear" button resets ALL fields (source fields and filter fields) to their default values, as well as enabling all of the source fields.
  Note: Alternatively the user may alter just the source field selection by manually resetting the one enabled field back to its default value, which will result in the other two fields being re-enabled.
• If the user clicks on the "View Events" button without making any event source selections, the form will not be submitted and instead an alert dialog will appear reminding the user that one source must be specified.
• Clicking on a field label will display a pop-up help window describing that particular field.

Event Log Summary Results (Summary Results) Web Page

• The dynamically generated summary results web page mimics the "keyword" display format of the existing command-line interface. Buttons are provided at the top of this page to return to the selection criteria web page or to refresh the current page. Clicking anywhere on a numbered row will open a detail pop-up window displaying that one event in the most verbose format.
• The browser's "Back" button may be clicked to return to the selection criteria screen where the previous selection criteria choices are retained if the browser's cache permits.
• Clicking the "New" button returns you to the selection criteria screen with default values for all fields.
• Clicking the "Refresh" button reformats the current log file using the current selection criteria.
• Clicking on a column heading displays a pop-up help window describing that particular column.
• A message is displayed at the bottom of the keyword summary window if no events matched the filter criteria.

Detail Pop-up Window

• This dynamically generated window displays a single event in the most verbose format and is opened when the user clicks on a numbered row in the keyword summary window. Raw hex values are displayed in combination with fully decoded detail information.
• Clicking on a row heading displays a pop-up help window describing that particular row.

Detail Results for Hex-Event Word Pairs

• This web page replaces the selection criteria window when the "View Events" button is pressed and hex event word pair data is present.
• The browser's "Back" button may be clicked to return to the selection criteria screen where the previous selection criteria choices are retained if the browser's cache permits.
• Clicking the "New" button returns you to the selection criteria screen with default values for all fields.
• Clicking on a row heading displays a pop-up help window describing that particular row.

Functional Specifications

This section lists and describes, in detail, each function and feature of the completed product as seen by the user.

Functionality/Features

• Selection Criteria

  The Selection Criteria web page allows you to designate report criteria. The following criteria can be selected:

  1. Event Source Selection
     
     
     • Standard log file: Lists all files matching IPMI log file-naming conventions.
     • Arbitrary log file: Single log file name is typed into "Other Log" field.
     • Raw hexadecimal data: Single event is entered into the "Hex Event Word Pair" field.
       
       
  2. Filter Criteria

     Two optional filters are available through dynamically generated drop-down lists:

     • Alert level: Selects all events with an alert level greater than or equal to the selected filter value chosen.
     • Cell filter: Selects all events matching a selected cell number.
       
       
  3. Platform Specification

     As with the current event viewer command line interface, the web interface will attempt to determine the appropriate platform type by reading the first few events from the selected log file. If the platform cannot be determined from the log file, the value selected from the platform field on the web page will be used. If a platform is specified by the user, it overrides whatever is found in the log file. If the platform field is left blank, a generic platform type will be used for event decoding.

• Reporting Options

  Once the event source has been selected and the filter criteria and platform options specified, the user must click on the "View Events" button to display the report. Event selection criteria, date, time and log hostname are displayed above the report for convenient reference. The following reporting options are available:

  1. Keyword Event Summary: If the event source is a standard log file, the initial web page is replaced by event summary data in a "keyword" format similar to that used by the existing command line interface. The requested event data is presented in a "keyword" format table consisting of one event per table row. The entire row is a hyperlink that, when clicked, opens a pop-up window containing the selected event formatted at the most verbose level of detail.
  2. Pop-up Verbose Event Data: If you click on an event row in the keyword event summary, a pop-up window opens containing that single event formatted at the most verbose level of detail. If the event source is raw hex data, when you click "View Events", the verbose detail window replaces the selection criteria window.
     
     
• Help

  Field labels and column headings on all web pages are hyperlinks that provide appropriate pop-up help windows.

• Search Capability

  Searching through formatted event data with customized search criteria is accomplished using the web browser's built-in page search functionality (i.e. the Find option on the Edit menu, etc).

Performance

Formatting large log files may consume significant web browser resources.

Security

By default, the GUI is available to all users on the system. The web server configuration files may be modified if it is necessary to restrict access to the web interface. The SMS web server only listens for HTTP requests on the 127.0.0.1 loopback interface. Therefore only a web browser running on the SMS itself can invoke the slview GUI to examine log files contained on the SMS.

Valid Configurations

The GUI runs under Apache on both HP-UX and Windows systems.

HP-UX Web Server Configurations

For HP-UX 11.23 only, the GUI is integrated with the Apache web server bundle used by other HP web-based tools. The default web server configuration files do not need to be modified to get the system up and running. The default configuration is a secure web server (i.e. https) running on port 1188. The GUI is accessed through the URL https://hostname:1188/sl/sl.cgi.

For HP-UX 11.00 and 11.11 only, the Apache web server contained in the HP-UX web server suite (http://www.hp.com/go/apache) is the recommended web server for running the GUI. You must add the following directive to the end of the default configuration file /opt/hpws/apache/conf/httpd.conf:

        ScriptAlias /sl/sl.cgi /usr/sbin/diag/contrib/slview 

The default configuration is a standard web server (i.e. http) running on port 80. The GUI is accessed through the URL http://hostname/sl/sl.cgi.

SMS Web Server Configuration

You must install and configure the Apache web server on SMS. The GUI is accessed through the URL http://127.0.0.1/sl/sl.cgi.

Standard Files and URLs

HP-UX 11.0 and 11.11:

HP-UX 11.23:

SMS HP-UX SMS0405:

SMS Windows SMS0405:

Standards/Guidelines/Policies/Conventions

The GUI attempts to remain browser-neutral in its usage of various HTML, CSS and Javascript functionality.