Dell™ OpenManage™ Client Instrumentation Version 7.4 User’s Guide w w w. d e l l . c o m | s u p p o r t . d e l l .
Notes, Notices NOTE: A NOTE indicates important information that helps you make better use of your computer. NOTICE: A NOTICE indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. ____________________ Information in this document is subject to change without notice. © 2006 Dell Inc. All rights reserved. Reproduction in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.
Contents 1 Introduction CIM Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 WMI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Data Sources Used by OMCI . OMCI Architecture . Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Silent Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing the Client Silently . . . . . . . . Performing a Silent Complete Installation Performing a Silent Custom Installation . Upgrading the Client Silently . . . . . . . Uninstalling the Client Silently . . . . . . Administrative Installation 3 WMI Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7 Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WMI Sample Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote System Shutdown . . . . . . . . . . . . . . . Remote System Restart . . . . . . . . . . . . . . . . . Remote BIOS Update . . . . . . . . . . . . . . . . . . Enabling PXE Boot on the Next Reboot . . . . . . . . . Enabling Wakeup on LAN . . . . . . . . . . . . . . . . Retrieving Service Tag, Asset Tag, and BIOS Revision .
Contents
Introduction The Dell™ OpenManage™ Client Instrumentation (OMCI) software enables remote management application programs to access information about the client system, monitor the status of the client system, or change the state of the system, such as shutting it down remotely. OMCI exposes, through standard interfaces, key system parameters that allow administrators to manage, inventory, monitor the system health of, and gather information on deployed Dell client systems.
WMI Overview WMI is Microsoft's implementation of CIM instrumentation. WMI supports CIM and Microsoft-specific CIM extensions. The WMI management infrastructure also includes the CIM Object Manager (CIMOM), which is the interface and manipulation point for CIM objects and information. It acts as a facilitator in gathering information and manipulating object properties. OMCI provides data to WMI, which is the common interface to WMI management applications.
• Data router — This layer collects information from system components in the data provider layer and passes the information up to the Dell WMI provider layer, which then presents it to the CIMOM. • Data provider — This layer provides data to the data router. When it receives a request from the data router, the data provider queries the client system's hardware, drivers, and operating system to determine the available instrumentation.
Features The following are key features of OMCI: • CIM 2.6 Schema Support • Dell LegacySelect 2.0 Support • Remote Boot Device Select • WMI Security • Event Reporting • Remote Shutdown • Remote Wake-Up Configurability • WfM Version 2.0 Compliance CIM 2.6 Schema Support CIM is a standard that describes management data that can be used by many management application programs. OMCI conforms to the CIM 2.
Remote Boot Device Select Remote Boot Device Select allows a network administrator to remotely configure the order of devices from which the system attempts to boot. It consists of two groups: Hard Disk Drive Sequence and Boot Device Sequence. Hard Disk Drive Sequence is used to set the order of the hard drives, and Boot Device Sequence is used to set the order of the type of boot device, such as hard drive, NIC, CD-ROM drive, and diskette drive.
WfM Version 2.0 Compliance OMCI is fully compliant with the Intel® Wired for Management (WfM) 2.0 standard. For more information on this standard and its specifications, see the Intel website at www.intel.com. What's New The following are new updates to OMCI 7.4: 12 • OMCI does not support hard drives configured in a RAID array. Earlier versions of OMCI can generate anomalous disk number, and DiskSizeIncreased and DiskSizeDecreased alerts, when installed on a system with RAID implemented.
• Configuration of BIOS settings for Alert Standard Format (ASF) 2.0: The ASF Specification defines the Remote Management Control Protocol (RMCP), which allows a network administrator to respond to an alert remotely in many different ways like powering on the system, powering off the system, or forcing a reboot. ASF 2.0 adds important security measures to the ASF standard, which defines alerting and remote control interfaces to proactively manage networked devices when their operating system is absent.
Other Dell Documents You Might Need In addition to this User's Guide, you can find the following guides either on the Dell Support website or on the documentation CD: • The Dell OpenManage Client Connector User’s Guide provides information on how to view and configure OMCI properties and perform remote management functions. • The Dell Client Configuration Utility User’s Guide provides information on how to obtain or configure BIOS settings.
Installing Dell™ OpenManage™ Client Instrumentation Dell OpenManage Client Instrumentation (OMCI) can be installed locally using the OMCI installation wizard, or remotely through a silent or administrative installation. Local Installation: The OMCI installation wizard allows you to install the complete package or to do a custom installation of specific components required for a particular environment.
Local Installation Installing the Client 1 Click Download Now to download the installation file (for example, r118302_a00.exe) from the Dell Support website at support.dell.com. When the File Download window appears, save the file. The installation file contains the components for the following languages: English, French, German, Spanish, Simplified Chinese, and Japanese.
Uninstalling the Client To remove the client instrumentation using the Add/Remove Programs icon on the Control Panel, perform the following steps: 1 Click the Start button, point to Settings, and click Control Panel. 2 Click Add/Remove Programs. 3 From the Add/Remove Programs dialog box, select OMCI and click Remove. 4 Follow the prompts on the screen. Silent Installation Installing the Client Silently You can run silent installations (no dialog boxes appear) for complete and custom installations.
Upgrading the Client Silently To upgrade from one version of OMCI 7.x to a later version of OMCI 7.x, execute the following command: setup.exe /s /v"/qn REINSTALLMODE=voums REINSTALL=ALL" A reboot might be required for the upgrade. To suppress it, modify the command line as follows: setup.exe /s /v"/qn REINSTALLMODE=voums REINSTALL=ALL REBOOT= REALLYSUPPRESS" Uninstalling the Client Silently You can silently uninstall the client instrumentation either using or without using the installation program.
You can use the server image to deploy OMCI to client systems on your network by using a login script, Windows system policies, or other methods. For example, the following command line installs silently using the server image: msiexec /i \omci.msi /qn where is the path to the server image. NOTE: For information on using the server image to deploy OMCI, refer to the documentation for the application program that you are using as your deployment agent.
Installing Dell™ OpenManage™ Client Instrumentation
Windows Management Instrumentation WMI Overview Microsoft® Windows® Management Instrumentation (WMI) is Microsoft’s implementation of the Web-Based Enterprise Management (WBEM) effort. It is implemented on Microsoft Windows platforms. There are two components to WMI. In the Dell™ OpenManage™ Client Instrumentation (OMCI) architecture diagram (see Figure 1-1), both of these components are represented by the Microsoft WMI Object Manager box.
NOTE: To connect remotely to WMI services, you must have administrative rights for both the local and the remote systems. NOTE: In Microsoft Windows XP, the default authentication level is changed from CONNECT to PACKET level. This results in a backward compatibility problem with Windows 2000. Systems running Windows 2000 need to have Service Pack 2 installed to be able to connect to WMI on systems running Windows XP. Retrieving Dell Information With SMS 2.
datetime BIOSDate; [SMS_Report(TRUE), read: ToInstance ToSubClass, key] string ServiceTag; [SMS_Report(TRUE), read: ToInstance ToSubClass, write: ToInstance ToSubClass] string AssetTag; }; #pragma namespace ("\\\\.\\Root\\cimv2") //************************************************************* //*** Registers Framework Provider *** //************************************************************* instance of __Win32Provider as $Q { Name = "DellWMI"; ClsId = "{a29197b6-5c8d-4278-ae20-e5c14aed1280}"; }; instance
WMI Scripts WMI provides a scripting interface. Using VBScript or JScript, you can write scripts that connect to WMI services locally or remotely, retrieve information, or execute methods. Because OMCI is implemented through WMI, most OMCI tasks can be scripted. This section provides sample VBScript scripts as examples only. NOTE: To connect remotely to WMI services, you must have administrative rights for both the local and the remote systems. The following text files contain sample scripts.
Alerts Overview Alerts are generated when a system’s state of interest changes. There are two basic types of alerting: local alerting to the current computer user and remote alerting to a management application. Dell™ OpenManage™ Client Instrumentation (OMCI) handles both types of alerting.
ASF Alerting In previous versions of OMCI, environmental alerts were sent as desktop management interface (DMI) alerts. With the introduction of ASF, the environmental alerts are handled by the ASF NIC. ASF monitors the environmental probes at a very low level and sends out a Platform Event Trap (PET) when an event occurs. Where applicable, OMCI notifies the local user of the alert. For information on which PET a specific model of Dell system supports, see the system's User's Guide.
• MaxNTEventLogNotifications: The maximum number of notices of this type that will be sent to the NT event log. Values are 0=never send, 1=first occurrence only, 2=first and second occurrences, and so on. The special value of –1 sends all occurrences. The default value is –1. • MaxDisplayNotifications: The maximum number of notices of this type that will be sent to the local display. Values are 0=never send, 1=first occurrence only, 2=first and second occurrences, and so on.
. Table 4-1. Events Polled by OMCI 7.x OMCI Event Description Severity Level Value FanProbe A cooling device has exceeded a minor threshold. MINOR 4 DiskSizeChanged The size of at least one hard drive has changed.1 WARNING_DEGRADED 3 DiskSizeIncreased The size of at least one hard drive has increased.2 WARNING_DEGRADED 3 DiskSizeDecreased The size of at least one hard drive has decreased.2 WARNING_DEGRADED 3 CurrentProbe An electrical current probe has exceeded a minor threshold.
Table 4-1. Events Polled by OMCI 7.x (continued) OMCI Event Description Severity Level Value MemorySizeIncreased The memory size has been increased.2 WARNING_DEGRADED 3 MemorySizeDecreased The memory size has been decreased.2 WARNING_DEGRADED 3 NumberOfDisksDecreased A hard drive has been removed. WARNING_DEGRADED 3 NumberOfDisksIncreased A hard drive has been added. WARNING_DEGRADED 3 NumberOfProcessorsDecreased A processor has been removed.
Alerts
Component Descriptions Table 5-1 lists the Dell™ instrumentation components, their functions, their default installation locations, and other relevant information. NOTICE: Changing or deleting component files may cause Dell™ OpenManage™ Client Instrumentation (OMCI) to become unusable. NOTE: %ProgramFiles% is a variable that refers to the path to the Program Files directory. By default, this is C:\Program Files. Table 5-1.
Table 5-1. Instrumentation Component Information (continued) Component Default Location or File Name Functional Information IAP %ProgramFiles%\Dell\OpenManage\ Client\Iap.exe Instrumentation Access Provider; component that queries the iap_routing_data.htm file for configuration information, builds the lookup tables, and routes data to a data provider; ensures serialization of BIOS access and consistency of data, and reduces memory and disk requirements.
Table 5-1. Instrumentation Component Information (continued) Component Default Location or File Name Functional Information Indication Provider %ProgramFiles%\Dell\OpenManage\ Client\IndiProv.dll DLL that periodically polls for events occurring at multiple event sources and generates an indication when an event is detected. It then supplies the indication to WMI, which forwards it to indication consumers (subscribers).
Table 5-1. Instrumentation Component Information (continued) Component Default Location or File Name Dell OMCI %ProgramFiles%\Dell\OpenManage\ Schema MOF2 Client\Mofs\DellOMCI_Schema.mof MOF file that contains #pragma include statements for each of the MOF files in OMCI. Dell COO Data MOF1 %ProgramFiles%\Dell\OpenManage\ Client\Mofs\coodata.mof MOF file that provides the default values to the instances of the Cost of Ownership (COO) classes defined in DellOMCI.mof.
Troubleshooting Wakeup on LAN If Wakeup on LAN does not function on a client computer system, perform the following checks: • Use either Dell™ OpenManage™ IT Assistant or system setup on the client system to verify that Wakeup on LAN is enabled. See your Dell system documentation for detailed information. • Ensure that the correct network interface card (NIC) driver is installed. Updated drivers are available on the Dell support website at support.dell.com.
• If both the server and the client system are in a workgroup (not in a domain), perform the following steps: – If the client system is running the Microsoft® Windows® XP Professional or Windows XP Professional x64 Edition operating system and the server is running Windows 2000, verify that Service Pack 2 or later is installed on the server. – If the client system is running a version of Windows XP and is not part of a domain, edit the registry to allow remote connection with administrative privileges.
Appendix WMI Sample Scripts Remote System Shutdown '******************************************************************* '*** Name: SampleShutdown.vbs '*** Purpose: To shut down a Dell™ OMCI client. '*** Usage: cscript.exe //nologo SampleShutdown.vbs '*** '*** This sample script is provided as an example only, and has not '*** been tested, nor is warranted in any way by Dell; Dell disclaims '*** any liability in connection therewith.
Call Usage() WScript.Quit End If '*** Initialize variables strNameSpace = "root/Dellomci" strComputerName = WScript.Arguments(0) strClassName = "Dell_Configuration" strPropValue = "Configuration" strMethod = "Shutdown" '*** Retrieve the Dell_Configuration class Set objInstance = GetObject("WinMgmts:{impersonationLevel= impersonate}//" &_ strComputerName & "/" & strNameSpace & ":" & strClassName) '*** Execute the Shutdown method Set ObjOutParam = objInstance.
Remote System Restart '********************************************************************** '*** Name: SampleRestart.vbs '*** Purpose: To restart a Dell OMCI client. '*** Usage: cscript.exe //nologo SampleRestart.vbs '*** '*** This sample script is provided as an example only, and has not been '*** tested, nor is warranted in any way by Dell; Dell disclaims any '*** liability in connection therewith. Dell provides no technical '*** support with regard to such scripting.
'*** Retrieve the Dell_Configuration class Set objInstance = GetObject("WinMgmts:{impersonationLevel= impersonate}//" &_ strComputerName & "/" & strNameSpace & ":" & strClassName) '*** Execute the Shutdown method Set ObjOutParam = objInstance.ExecMethod_(strMethod) '*** Let the user know whether the method returned success or not '*** Note: if return value is 0, it does not mean the system has '*** shutdown, it only means that the shutdown method was initiated '*** successfully. If objOutParam.
Option Explicit '*** Declare variables Dim strNameSpace Dim strComputerName Dim strClassName Dim strPropValue Dim objInstance Dim ObjOutParam Dim strMethod Dim objMethod Dim objClass Dim objInParam '*** Check that the right executable was used to run the script '*** and that all parameters were passed If (LCase(Right(WScript.FullName, 11)) = "wscript.exe" ) Or _ (Wscript.Arguments.Count < 2) Then Call Usage() WScript.
'*** Set the In parameter of the method to the URL of BIOS header file Set objInParam = objMethod.inParameters.SpawnInstance_() objInParam.sUrl = WScript.Arguments(1) '*** Execute the method Set ObjOutParam = objClass.ExecMethod_(strMethod, objInParam) '*** Let the user know whether the method returned success or not '*** Note: if return value is 0, it does not mean the system's BIOS has '*** been flashed, it only means that the flash method was initiated '*** successfully. If objOutParam.
Option Explicit '*** Declare variables Dim strNameSpace Dim strComputerName Dim strClassName Dim strKeyValue Dim objInstance Dim strPropName Dim strPropValue '*** Check that the right executable was used to run the script '*** and that all parameters were passed If (LCase(Right(WScript.FullName, 11)) = "wscript.exe" ) Or _ (Wscript.Arguments.Count < 1) Then Call Usage() WScript.Quit End If '*** Initialize variables strNameSpace = "root/Dellomci" strComputerName = WScript.
'*** Set the new value for the property and save the instance, but only '*** if the current value is not already 3 ('Enabled') If strPropValue <> 3 Then objInstance.Properties_.Item(strPropName).Value = 3 objInstance.Put_ '*** If any errors occurred, let the user know If Err.Number <> 0 Then WScript.Echo "Setting PXE on next reboot failed." End If End If '*** Sub used to display the correct usage of the script Sub Usage() Dim strMessage strMessage = "incorrect syntax.
Dim Dim Dim Dim strKeyValue objInstance strPropName strPropValue '*** Check that the right executable was used to run the script '*** and that all parameters were passed If (LCase(Right(WScript.FullName, 11)) = "wscript.exe" ) Or _ (Wscript.Arguments.Count < 1) Then Call Usage() WScript.Quit End If '*** Initialize variables strNameSpace = "root/Dellomci" strComputerName = WScript.
'*** If any errors occurred, let the user know If Err.Number <> 0 Then WScript.Echo "Enabling WakeUp On Lan failed." End If End If '*** Sub used to display the correct usage of the script Sub Usage() Dim strMessage strMessage = "incorrect syntax. You should run: " & vbCRLF & _ "cscript.exe //nologo SampleWuOLEnable.vbs " WScript.
Dim strKeyName '*** Check that the right executable was used to run the script '*** and that all parameters were passed If (LCase(Right(WScript.FullName, 11)) = "wscript.exe" ) Or _ (Wscript.Arguments.Count < 1) Then Call Usage() WScript.Quit End If '*** Initialize variables strNameSpace = "root/Dellomci" strComputerName = WScript.
strMessage = strMessage & objInstance.Properties_.Item ("BIOSVersion").Value Exit For Next '*** Display the results WScript.Echo strMessage '*** Sub used to display the correct usage of the script Sub Usage() Dim strMessage strMessage = "incorrect syntax. You should run: " & vbCRLF & _ "cscript.exe //nologo SampleSystemSummary.vbs " WScript.Echo strMessage End Sub Changing BIOS Password '********************************************************************** '*** Name: SampleBIOSPwd.
'*** Check that the right executable was used to run the script '*** and that all parameters were passed If (LCase(Right(WScript.FullName, 11)) <> "cscript.exe" ) Or _ (Wscript.Arguments.Count < 2) Then Call Usage() WScript.Quit End If '*** Initialize variables strNameSpace = "root/Dellomci" strComputerName = WScript.Arguments(0) strClassName = "Dell_Configuration" strKeyValue = "Configuration" strPropName = "Password" strPassEncryptPropName = "PasswordEncrypted" strPwd = WScript.
Dim strMessage strMessage = "Incorrect syntax. You should run: " & vbCRLF & _ "cscript.exe //nologo SampleBIOSPwd.vbs " & Chr(34) & _ " space " & Chr(34) WScript.
• POSTF2KeySetting • PowerManagementSettings • PrimaryParallelATAMaster • PrimaryParallelATASlave • PrimaryVideo • RadioTransmission • SecondaryParallelATAMaster • SecondaryParallelATASlave • SerialATAChannel1 • SerialATAChannel2 • SerialATAChannel3 • SerialATAChannel4 • SerialATAChannel5 • SerialATAChannel6 • SerialATAChannel7 • SerialATAChannel8 • SerialPort1Configuration • SerialPort2Configuration • SpeakerVolume • TertiaryParallelATAMaster • TertiaryParallelATASl
Appendix
Glossary The following list defines or identifies technical terms, abbreviations, and acronyms used in this guide. ASF Abbreviation for Alert Standard Format—Defines remote control and alerting interfaces for operating system absent environments. BIOS Acronym for basic input/output system. BIOS refers to the software code run by a system when first powered on.
device driver DMTF A program that allows the operating system or some other program to interface correctly with a peripheral device, such as a printer. Some device drivers—such as network drivers—must be loaded from the config.sys file (with a device= statement) or as memory-resident programs (usually from the autoexec.bat file). Others—such as video drivers—must load when you start the program for which they were designed.
MOF WBEM There are potentially many ways in which CIM management information could be represented to exchange information. The CIM Specification defines a language based on the Interface Definition Language (IDL) called Managed Object Format (MOF). Acronym for Web Based Enterprise Management.
WMI Acronym for Windows Management Instrumentation which is a set of extensions to the Windows Driver Model that provides an operating system interface through which instrumented components can provide information and notification. WMI is Microsoft's implementation of the Web-Based Enterprise Management (WBEM) Standard from the Distributed Management Task Force (DMTF). WMI allows scripting languages like VBScript to manage Microsoft Windows personal computers and servers, both locally and remotely.
Index A Dell event MOF, 34 L alerts, 25 events polled, 28 local, 26 remote, 25-26 Dell instantiation MOF, 34 language, specifying, 16-17 Dell OMCI MOF, 33 LegacySelect, 10 ASF, 25 alerting, 26 dellWMI.dll, 31 DEvents.dll, 32 DMTF, 25 dpccard.dll, 32 C CIM, 7 cim_iap_data.htm, 33 cim_win32_data.htm, 33 overview, 7 schema, 7 dsmbios.dll, 31 O dsmbios_data.htm, 33 OMCI, 7-8 architecture, 8 BIOS tokens, 12, 50 data sources, 8 features, 10 omci.
Index SMART, 11 SMBIOS, 8 SMS, 22 U uninstall client, 18 updates, 13 upgrade client, 18 user authentication, 21 V VBScript, 24 W WBEM, 21 WDM, 32 WfM, 12 winmgmt, 21 WMI, 7-8, 21, 27, 37 alerting, 26 application layer, 8 control, 21 overview, 8 provider, 8 repository, 21 sample script examples, 37 scripts, 24 security, 21 severity levels, 27 58 Index
