/+---------------------------------------------------------------------------
//
//  Copyright (C) Intel Corporation, 2003 - 2007.
//
//  File:       README 
//
//  Contents:   a short description for developers
//
//----------------------------------------------------------------------------

Local Manageability Service
===========================

The Local Manageability Service (LMS) allows applications to access the Intel(R) 
Active Management Technology (Intel(R) AMT) FW via the local HECI interface.

The LMS is dependent on the HECI driver.  To use this please make sure that the 
Intel(R) AMT Manageability Interface driver is installed and is connected to
the FW.

The service is meant to be run as a daemon. Messages from the service will be
sent to the syslog. The LMS messages will be marked with a source of "LMS".

Building and installing the LMS:
-----------------------------
In order to build and install the LMS, call "./configure" and then "make install". 
This builds the LMS, installs it, and ensures that it will load upon startup.
Call "make uninstall" to uninstall and remove the LMS.

The LMS may also be built and run manually (not as a daemon), by first
calling "configure", then "make", and then "./lms". This method doesn't load 
LMS upon startup, so it may be better suited for testing purposes.

Uninstalling the LMS:
-----------------------------
In order to uninstall the LMS first stop the service, either by distribution 
provided mechanism or by using "kill" command and then call make uninstall.

Accessing The Intel AMT Device Via The LMS:
-------------------------------------------
Once the LMS is running, it listens for incoming connection requests on the 
ports 16992 and 16993. Each such connection request is passed via the Intel(R)
AMT Manageability Interface driver to the AMT Device, but only if the source
IP address belongs to the local machine. Applications should use either the
host name of the AMT Device (which can be the same or different than the host
name of the machine), or the IP address of 127.0.0.1.

Examples:
	http://127.0.0.1:16992
	https://desktop:16993

Note that if the FW is using a different IP address than the Linux machine
(dedicated address) you cannot use this dedicated address to access the FW via
the LMS. You must use the address 127.0.0.1 or the host name. This is because
otherwise, the Linux routing layer will not know to forward such requests to
the LMS.

When the FW uses a dedicated host name (i.e. different than the one used by
Linux), the LMS should detect this and update the hosts file to indicate that
the host name is an alias of 127.0.0.1. The host file can be found under the
etc folder (/etc/hosts).


Known Issues:
-----------------------------

- LMS currently doesn't handle kill signals, which may cause problems when
restarting the LMS, because of opened sockets. Further testing is required
to determine whether this is an issue.

- LME client initiated requests aren't supported yet. This is a required
feature for Santa Rosa and Bearlake, and will be added to future releases.
This version should not be used with an LME that supports client initiated
requests.

