**************************************************************************** * * INTEL CORPORATION PROPRIETARY INFORMATION * * This software is supplied under the terms of a license agreement or * nondisclosure agreement with Intel Corporation and may not be copied * or disclosed except in accordance with the terms of that agreement. * Copyright (c) 1999-2007 Intel Corporation. All Rights Reserved. * **************************************************************************** Intel(R) PRO Alerting Suite ASF Compliant Software SUMMARY This document discusses what is provided with this release, how the directory structure is organized, and instructions on how to use the provided content. See the file relnotes.txt for documentation on known errata and a summary of changes made since the previous release. SOFTWARE CONTENT DESCRIPTION This release contains the Intel PRO Alerting Suite ASF Compliant executables and sample source code. TABLE OF CONTENTS INTEL PRO ALERTING AGENT INSTALL - ASF AGENT INSTALLATION REQUIREMENTS - ASF AGENT INSTALLATION PROCEDURES - DEFAULT INSTALLATION DIRECTORIES - SILENT INSTALLATIONS AND UNINSTALLING THE SOFTWARE - COMPILATION OF MOF and MFL Files - ASF AGENT MERGE MODULES INTEL PRO ALERTING SUITE CONFIGURATION NOTES INTEL ASF AGENT WMI PROVIDER INTEL ASF AGENT WMI SAMPLE APPLICATION INTEL PRO ALERTING DRIVERS - ASFALRT DRIVER ============================================================================ INTEL PRO ALERTING AGENT INSTALL ============================================================================ ASF AGENT INSTALLATION REQUIREMENTS ---------------------------------------------------------------------------- The ASF Agent requires: 1) One of the supported operating systems specified in this document. 2) Microsoft Installer (Version 1.2 or greater) service installed and running. 3) Microsoft WMI (Version 1.5 or greater) service installed and running. ASF AGENT INSTALLATION PROCEDURES The ASF Agent Install represents the combined functionality of the ASF Agent and ASF Agent Provider merge modules. Additionally, the Installer redistributables are installed on client systems that lack the Installer requirements. See Supported Environments below. To install the ASF Agent Install, double-click setup.exe. To repair a damaged installation or change the selected features run setup.exe again. DEFAULT INSTALLATION DIRECTORIES ---------------------------------------------------------------------------- By default, the ASF Agent stack is installed in the following directories: ASF Agent Directory - Program Files\Intel\ASF Agent ASF Agent Provider Directories - Program Files\Intel\ASF Agent and at Windows\System32\Drivers SILENT INSTALLATIONS AND UNINSTALLING THE SOFTWARE ---------------------------------------------------------------------------- Listed below is the silent mode installation and uninstalling the software: Note: For install, setup.exe should be used instead of msiexec. setup.exe additionally will detect the presence of the MSI Windows Installer on the client system. If not present, the appropriate MSI Installer redistributable for NT4 will be installed. Silent mode installation ------------------------ >setup /qn [SMARTINSTALL=] [INSTGUI=] [/Lv "asfmsi.log"] Uninstalling the software ------------------------- >setup /X "ASFAgent.msi" /qn [/Lv "asfmsi.log"] Option Parameters Meaning ------ ---------- ------- /I Package/ProductCode Installs or configures a product /q n No User Interface /L v Logfile Log verbose, output to log file SMARTINSTALL 0 = Install ASF Agent without checking BIOS compatibility and adapters presence. (default) 1 = Install ASF Agent only if BIOS supports ASF and machine includes at least one ASF supported adapter. 2 = Install ASF Agent only if BIOS supports ASF. INSTGUI 0 = Do not install GUI application. 1 = Install GUI. (default) For additional command line options, refer to the Microsoft MSI SDK (Version 1.2). In Windows XP or greater, ensure that you use the cmd.exe to create the DOS shell. COMPILATION OF MOF and MFL Files ------------------------------------------------------ The agent install requires the presence of the WMI core prior to the installation. The agent install attempts to compile the applicable MOF/MFL files. If, however, the Agent MOF files do not get compiled with the install, you must either : (a) Run the Install repair option. This option is accessible by running the program installation file again and choosing "Repair" on the Program Maitenance dialog. (b) Manually compile the following files. 1) ASFAgtLN.MOF 2) Language specific MFL file For example, for an English based system, the end user needs to run the following command line. mofcomp.exe ASFAgtLN.MOF mofcomp.exe EnuAgt.MFL Note that the language specific MFL files require the appropriate language specific WMI core. ASF AGENT MERGE MODULES ------------------------------------------- ASF AGENT MERGE MODULE INSTALLATION The ASF Agent merge module can be merged into a MSI based installation by associating it with a feature. Refer to the Intel ASF Component Installation white paper and the Microsoft Installer Version 1.2 SDK for additional details on integrating merge modules into a MSI based install. 3 Merge Modules are supplied with the ASF Agent: Agent.msm - ASF Agent dll and ASF Agent Service executable Aprov.msm - ASF Agent WMI Providers Custom.msm - ASF Agent customization files (ie. ini file) Additionally, the ASF Agent merge module is dependent on the ASF Provider merge module and the Custom merge module. Supported Environments The ASF Agent merge module requires: 1) One of the OS's specified in this document. 2) Microsoft SNMP Trap service installed and operating. 3) Microsoft WMI service installed and operating. ================================================= INTEL PRO ALERTING SUITE ASF COMPLIANT SOFTWARE - CONFIGURATION NOTES ================================================= The ASF Agent Service (ASFAGENT.EXE) uses the ASF Configuration DLL (ASFCFGSV.DLL) to detect ASF compliant network devices in the system and to configure them for remote manageability. The ASF Agent Service is designed to be launched automatically when the operating system starts. The service runs until the operating system is shutdown. By continuously running, the Agent Service is able to monitor changes in system and device states and respond to them in a timely manner. The ASF Configuration DLL (ASFCFGSV.DLL) detects ASF compliant network devices in ACPI systems and configures them for remote manageability. It is loaded into the process space of the ASF Agent Service (ASFAGENT.EXE). Note: When attempting to stop the ASF Agent service while the WMI Console is still open, the Service Control Manager occasionally reports an error in stopping the service. This is normal behavior due to Microsoft Window's COM functionality. After this error message, the SCM either continues and stops the service successfully, or leaves it in the "started" state requiring another "stop" command by the user. To avoid these Windows messages, close the WMI Console before manually stopping the ASF Agent Service. ASF AGENT SERVICE SUPPORTED OPERATING SYSTEMS ---------------------------------------------------------------------------- 1. Windows 2000 SP4 2. Windows XP SP2 3. Windows 2003 Server SP1 4. Windows XP x64 SP1 5. Windows Vista x32 6. Windows Vista x64 ASF AGENT SERVICE ERROR, WARNING AND INFORMATIONAL CODES ---------------------------------------------------------------------------- 0x80040201 Invalid parameter passed to function 0x80040202 Configuration DLL has not been successfully initialized 0x80040203 Requested resource was not found 0x80040204 Aolan.ini could not be found. 0x80040205 Failed to read left and right values of a section line in INI file. 0x80040206 Error while reading sections from INI file. INI file format corrupted. 0x80040208 Not enough memory for copy output. 0x80040209 Exception encountered. 0x8004020A Cannot locate the selected adapter. 0x8004020C Timeout while acquiring locks internally. 0x8004020D Unable to get Proxy IP address or port number from INI file. 0x8004020E Unable to get resource ID pairs from INI file. 0x8004020F Unable to get system name given system ID from INI file. 0x80040210 SMBUS ARP Address of ASF Capable adapters may be invalid 0x80040211 No ASF Capable adapters found in the system 0x80040212 Invalid function to enable/disable. 0x80040213 End of function list encountered. 0x80040214 ACPI Bios is not present in the system 0x80040215 The selected adapter is not present in the system. 0x80040216 Management console cannot be reached 0x80040217 Registry cannot be accessed 0x80040218 The configuration software does not support this operating system 0x80040219 Error starting a thread to ping Management station. 0x8004021A Error starting a thread to detect power transitions in the system. 0x8004021B Management console cannot be reached since Link is down 0x8004021C Internal Initialization Error. 0x8004021D ASF disabled due to BIOS configuration setting 0x8004021E Older versions of the drivers present in the system. 0x8004021F Unable to continue configuration as the driver may be disabled 0x80040220 No ASF Capable adapters found in the system or the driver of ASF Capable adapters may be disabled 0x80040221 Invalid window handle passed as parameter 0x80040222 Device handle count is not zero 0x80040223 Invalid parameter passed to function ================================================= INTEL ASF AGENT WMI PROVIDER ================================================= ASF Agent WMI Provider is a DLL component that allows WMI-based management applications to configure ASF compliant alerting network cards for remote manageability. You can use the provided WMI sample application Console.exe to specify several configuration network parameters. The parameters may include timer intervals (for heartbeat, watchdog), management console's network address, and enable/disable of remote control capabilities. Installation requires ASF supported NIC driver ASF Agent Provider schema resides in the root\cimv2 namespace. Install by default compiles MOF file and English version of MFL. If end system has WMI Core component for any specific language that locale specific MFL also gets compiled. ============================================================================ INTEL ASF AGENT WMI SAMPLE APPLICATION ============================================================================ This application demonstrates how WMI can be used to get and set properties for Intel's ASF Agent. You can run the application directly from the CD or from a copied version on the local system. =====Running the application========== The application presents the user with property pages (tabs) to view current ASF related settings. To Enable ASF, you must provide the IP address of a "Management Console" which is a system on the network that can receive alerts. On the main tab enter the proxy IP address and then click the checkbox to enable alerting. When any user changeable property is changed, the "APPLY" button is enabled. Click Apply to accept the changes or click OK to accept the changes and close the application. To close the application without accepting the last changes, click Cancel. =====Building the application from the source files======== * You must install the Microsoft WMI SDK, available from msdn.microsoft.com * The project file assumes that the WMI SDK is installed in its default location in c:\program files\wmi. * You must install Microsoft Visual Studio 6.0 with latest service pack. =====Developing WMI applications======== * Refer to the MOF directory in the ASF agent samples directory for ASF class definitions. ============================================================================ PREREQUISITES ============================================================================ 1) Intel(R) NIC driver. 2) Intel(R) HECI driver for systems that include a HECI device (Averill). ============================================================================ INTEL PRO ALERTING DRIVER ============================================================================ ASFALRT DRIVER * Third-party trademarks are the property of their respective owners.