=============================================================
Intel(R) Remote Management Module 2 KiraTool Utility 
Release Notes for version 1.5.14
=============================================================
INTEL Enterprise Platform & Services Marketing
Intel Corporation
2111 N.E. 25th Avenue, Hillsboro, OR 97124 USA
=============================================================
DATE:       March, 2009
TO:           Intel(R) Remote Management Module 2 Customers
SUBJECT: KiraTool Utility   

=============================================================
                               LEGAL INFORMATION
=============================================================
Information in this document is provided in connection with Intel Products
and for the purpose of supporting Intel developed server boards and systems.
No license, express or implied, by estoppel or otherwise, to any intellectual 
property rights is granted by this document. Except as provided in Intel's 
Terms and Conditions of Sale for such products, Intel assumes no liability 
whatsoever, and Intel disclaims any express or implied warranty, relating to 
sale and/or use of Intel products including liability or warranties relating 
to fitness for a particular purpose, merchantability, or infringement of any 
patent, copyright or other intellectual property right. Intel Corporation may 
have patents or pending patent applications, trademarks, copyrights, or other 
intellectual property rights that relate to the presented subject matter.  
The furnishing of documents and other materials and information does not 
provide any license, express or implied, by estoppel or otherwise, to any 
such patents, trademarks, copyrights, or other intellectual property rights.  
Intel products are not intended for use in medical, life saving, or life 
sustaining applications. Intel may make changes to specifications and product 
descriptions at any time, without notice.

Intel is a registered trademark of Intel Corporation. 

*Other names and brands are the property of their respective owners.

Copyright (c) 2009 Intel Corporation.


=============================================================
                              ABOUT THIS RELEASE
=============================================================

General
=======

KiraTool is a small command line based utility which is used to configure and test
Intel Remote Management Module 2. It is an alternative to environments where the 
Intel RMM2 web interface or the graphical psetup utility cannot be used.

Supported operating systems
===========================

* Windows (2000 or newer)
* Linux
* DOS
* EFI


Supported Interfaces
====================

* Remote: LAN (only Windows and Linux version)
* Local:
  - SCSI over USB
  - * System Management interface (KCS) (DOS and linux version only)

Supported Functionality
=======================

* Network configuration (IP/mask/gw/MAC)
* Changing admin's name & password
* Showing serial number
* Resetting to factory defaults
* Firmware information and upgrade
* Device self-test 

Usage
=====

    kiratool [options]  [cmd args]

Options
= = = =

    -a
        must be used for Intel RMM2 modules
 
    -l <ip>
        use remote LAN interface instead of local one 
    -s
        use IPMI-over-SCSI interface 
    -d <device>
        use specified SCSI device; default: auto-detect 
    -u <username>
        user name for login 
    -p <password>
        password for login 
    -P
        prompt for password 
    -f
        force: never prompt for user confirmation 
    -v
        verbose: does additional logging 
    -c
        calm: does not print out anything (silent) 
    -h / -?
        help: shows help and usage information

NOTE:
* If no interface is given, the local system management interface is used



Commands
= = = =

ver
    shows version of kiratool 

info
    shows vendor and device ID of the connected device

ipsrc set static | dhcp | bios
    sets IP address source 
ipsrc [show]
    shows current IP address source 

ip set <ip addr>
    sets IP address (e.g. 192.169.1.123) 
ip [show]
    shows current IP address 

netmask set <netmask>
    sets netmask (e.g. 255.255.255.0) 
netmask [show]
    shows current netmask 

gw set <gw addr>
    sets gateway address (e.g. 192.169.1.1) 
gw [show]
    shows current gateway address 

mac set <mac addr>
    sets MAC address (e.g. "FE:00:00:12:34:56" or "FE0000123456")
mac [show] [-c]
    shows current MAC address (-c = compact mode, e.g. "87654321DCBA" instead of "87:65:43:21:DC:BA")

fw upgrade [-h] [-o] <fw bin file>
    upgrades firmware (-h = cross-hwid, -o = cross-oem) 
fw validate [-h] [-o] <fw bin file>
    checks firmware compatibility (-h = cross-hwid, -o = cross-oem) 
fw [ver]
    shows firmware version information 

serial [show]
    shows device's serial number 

defaults
    resets all settings to factory defaults 

reset
    hard-resets the module

admin name <name>
    changes new admin name 
admin passwd <passwd>
    changes admin's password 
admin [show]
    shows admin's name 

cfg backup <filename>
    backup the device's configuration to a file
cfg restore <filename>
    restore the device's configuration from a file
cfg get <key>
    read and show the given configuration key
cfg set <key> <value>
    sets the given configuration key to the given value

fni [show]
    show status of IPMI over FML forwarding
fni set <on/off>
    turn IPMI over FML forwarding on of off

raw <hex bytes>
    send raw command and prints raw response (<netfn> <cmd> [<d1>] [<d2>] ... [<dN>]: e.g. 06 01) 

test <test>
    performs module self test and shows results (return value is ==0 on success and =0 in failure)

    device
        tests whether the device is vailable at all 
    video <subtest>
        tests video interface (DVO/DVI)

        status
            checks detected video signal and resolution 
        crc
            calculate CRC sum over the captured screen 

    ddc <subtest>
        tests DDC interface

        info
            queries EDID information from the device and compares it to the EDID information known by the OS (only available under Windows)

    ipmb <subtest>
        tests IPMB interface

        bmc
            test whether a BMC responds over IPMB 
        evalboard
	    test whether the IPMB connection between two connected eval boards works

    fml <subtest>
        tests FML interface

        esb2
            test whether an ESB2 is responding on FML when TPT (TCP Pass-Through) is active
        evalboard
	    test whether the FML connection between two connected eval boards works

    usb [-c <channel>] <subtest>
        tests USB interface

        status
            test whether the device's USB modul is enumerated 

     nic [-c <channel>] <subtest>
        test NIC interface
    
        status
            test NIC status and parameters 
        loopback
            test NIC loopback functionality 
        ping <host>
            Test whether pinging a host works 
        broadcast
            Broadcast ping (not yet implemented) 

    all
        performs all tests and subtests one after another

        -s <test to skip>
            Single tests can be skipped using the -s parameter. You can both skip a whole
            component (e.g. -s ddc) and skip a single test (e.g. -s video crc). 
        Included tests:
        
                * ddc info
                * video status
                * ipmb bmc
                * fml esb2
                * usb status
                * nic status 


Return Code
===========

To let the caller know whether an error occured and what went wrong, the tool returns a return code:

* If everything went well, 0 is returned
* For all commands except test, -1 is returned if an error occurs
* If a test fails, the return code indicated which test failed: 

Test 	 	Return code
---------------------------
device 		1
video status 	2
video crc 	3
ddc info 	4
ipmb ddc 	5
fml esb2 	6
usb status 	7
nic status 	8
nic loopback 	9
nic ping 	10
nic broadcast 	11
fml evalboard	12
ipmb evalboard	13

* if test all fails, the return code of the first error which occured is returned;
  the test will not be stopped after the first error!
