Intel® PRO Network Adapters WMI and CDM Providers User Guide The information below is provided by the supplier of the referenced device without independent verification by Dell and is subject to the restrictions and disclaimers noted below.
Back to Contents Page Introduction: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview Welcome to the Intel® PRO Network Adapters WMI and CDM Providers User's Guide. This document describes the external view of the Intel PRO Network Adapters WMI and CDM Providers.
Back to Contents Page WMI: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview Common Information Model (CIM Schema) Overview Web-Based Enterprise Management (WBEM) is a Desktop Management Task Force (DMTF) initiative intended to provide enterprise system managers with a standardized, cost-effective method for end station management.
Back to Top Common Information Model (CIM Schema) The Common Information Model (CIM) presents a consistent and unified view of all types of logical and physical objects in a managed environment. Managed objects are represented using object-oriented constructs such as classes. The classes include properties that describe data and methods that describe behavior. The CIM is designed by the DMTF to be operating system and platform independent.
that are part of a typical Win32 environment. For additional information on CIM, visit http://www.dmtf.org. Please read all restrictions and disclaimers.
Back to Contents Page Main Features: Intel® PRO Network Adapters WMI and CDM Providers User Guide NCS WMI Provider Features CDM Provider Features NCS WMI Provider Features The main features of the WMI Provider are as follows: Adapter Features Enumerate all physical adapters supported by Intel® PROSet. Enumerate an installed adapter's settings. Add/remove/update settings for an installed adapter. Obtain an adapter's physical device information. Obtain an adapter's system slot device information.
Please read all restrictions and disclaimers.
Back to Contents Page Installed Files: Intel® PRO Network Adapters WMI and CDM Providers User Guide WMI Files CDM Provider Files WMI Files Executables The WMI Provider executables are as follows: NcsWmiCo.exe — The core provider. Implements the IANet_NetService and the core event classes. NcsWmiIm.exe — The instance and method provider. Implements the Ethernet Adapter Schema, the Teaming Schema, the Setting Schema and the VLAN Schema. NcsWmiEv.exe — The event provider.
The executables for the CDM Provider are as follows: Ncsdiag.exe is the main executable file for the CDM diagnostics. It conforms to the Microsoft* WMI interface specification and is accessed as an out-of-process COM server. Other executables from the Intel® PROSet software stack MOF Files The master .
Back to Contents Page Back to Top 10
Back to Contents Page Security: Intel® PRO Network Adapters WMI and CDM Providers User Guide The WMI and CDM Providers use client impersonation to manage security. Every call into the Providers will be made in the client's own security context, which is passed down to the lower layers. One or all operations may fail if you do not have administrative rights on the target machine. Please read all restrictions and disclaimers.
Back to Contents Page Namespace and Context: Intel® PRO Network Adapters WMI and CDM Providers User Guide The CIM classes reside in a namespace. The standard Microsoft* namespace is called root/cimv2 and is based on CIM v2.2 or root/default. The WMI and CDM Provider classes can be added to this namespace. The Providers are based on CIM v2.5. Because of this and differences used in the keys of the objects, the Providers' classes are located in a separate namespace, root/IntelNCS.
Please read all restrictions and disclaimers.
Back to Contents Page Locales and Localization: Intel® PRO Network Adapters WMI and CDM Providers User Guide Localized MOF Files Localized Attribute Data There are two aspects to WMI and CDM Provider localization — localized MOF files and localized attribute data. Localized MOF Files All the MOF files used by the Providers are localized according to the Microsoft Windows* Management Instrumentation (WMI) globalization model.
SWbemServices.ExecQuery must specify the WBEM_FLAG_USE_AMENDED_QUALIFIERS flag to request localized data along with the basic definition. This is required in all functions that produce displayable values using value maps, display descriptions or other amended qualifiers from the MOF files. Back to Top Localized Attribute Data To get localized attribute data (such as error messages), the Providers need to know the locale of the caller for every call.
Back to Contents Page Error Reporting: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview Error Codes Overview This section about IANet_ExtendedStatus describes how to handle errors generated by WMI and CDM Providers. How and when an error object is returned depends on whether a call is synchronous, semi-synchronous or asynchronous. In most cases, the HRESULT is set to WBEM_E_FAILED when an error occurs.
0x80040916 — "Setting is not one of the allowed values" 0x80040917 — "WMI: Qualifier not found" 0x80040918 — "WMI: Qualifer set not found" 0x80040919 — "WMI: Safe array access failed" 0x8004091A — "WMI: Unhandled exception" 0x8004091B — "WMI: Operation is not supported for this class" 0x8004091C — "WMI: Unexpected event class" 0x8004091D — "WMI: Bad event data" 0x8004091E — "WMI: Operation succeeded with warnings" 0x8004081F — "WMI: The NCS Service has been stopped.
0x80040206 — "Sync Layer: The session lock handle already exists" 0x80040207 — "Sync Layer: Invalid session lock handle" 0x80040208 — "Sync Layer: Session already locked" 0x80040209 — "Sync Layer: Invalid media service module Id" 0x8004020A — "Sync Layer: Invalid Advanced Service Module Id" 0x8004020B — "Sync Layer: Invalid device service module Id" 0x8004020C — "Sync Layer: Invalid component type Id" 0x8004020D — "Sync Layer: Invalid bus interface module Id" 0x8004020E — "Sync Layer: Invalid sink window ha
Back to Contents Page The Core Schema: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview IANet_NetService Core Events Use Cases Overview The Core Schema consists of the IANet_NetService class and the core event classes. Back to Top IANet_NetService Purpose The IANet_NetService class is the root object from the IANet_ schema. This class enables the client to access the sessions that are required to perform sets. Instances There is one instance of this object.
There are no user-modifiable properties of this class. Supported Attributes This class implements two attributes: Version — Contains the current version of the core provider. InstallDate — Contains the date that the providers were installed. Methods The following methods can be used to manage sessions: void GetSessionHandle(([OUT] string SessionHandle, [out] uint32 ActiveSessions) — Used to set a session handle string, which should be placed in the context object in the SessionHandle qualifier.
After the event provider gets an unknown event from an event source After the software that provides the events has been shutdown After the event provider gets an event but the event source cannot get further data about the event Event Data The EventType can be one of the following: "Could not get event data". An event occurred, but the event source cannot get further data about the event. "Event source has shut down". The data source for the event was shutdown.
SELECT * FROM IANet_Event — Request all events. SELECT * FROM IANet_SessionEvent — Request all session events. SELECT * FROM IANet_InternalErrorEvent — Request all internal events. Please read all restrictions and disclaimers.
Back to Contents Page The Ethernet Adapter Schema: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview IANet_EthernetAdapter IANet_IPProtocolEndpoint IANet_BootAgent IANet_PCIDevice IANet_EthernetPCIDevice Overview The adapter schema is used to model the various configurable Intel® PROSet Ethernet Adapters. This schema is based on the CIM v2.5 schema.
You cannot create instances of IANet_EthernetAdapter. Removing Instances Deleting an instance of IANet_EthernetAdapter will uninstall physical adapters. Only non-virtual Intel adapters may be uninstalled in this way. A session handle is required for this operation. Modifying Properties There are no user-modifiable properties for this class.
address, they will be associated with only one IP Protocol endpoint instance. The Provider does not support this advanced use as it is not required or used by Intel PROSet. Creating Instances You cannot create instances of IANet_IPProtocolEndpoint. The instance exists only if the operating system has bound the protocol to the endpoint. Removing Instances You cannot remove instances of IANet_IPProtocolEndpoint. Modifying Properties There are no user-modifiable properties for this class.
Supported Attributes The following read-only attributes are required by Intel PROSet: InvalidImageSignature Version UpdateAvailable FlashImageType Unsupported Attributes The following attributes are not required by Intel PROSet and are, therefore, not supported: Caption Description InstallDate Started StartMode Status Methods The following methods on this class can be used to update the Flash ROM on the NIC: uint32 ProgramFlash( [IN, ValueMap {"0","1"} , Va
Unsupported Attributes The following attributes are not supported by the WMI Provider: AdditionalAvailabitlity Capabilities CapabilityDescriptions Caption DeviceSelectTiming ErrorCleared ErrorDescription IdentifyingDescription InstallDate LastErrorCode MaxNumberController MaxQuiesceTime Name OtherIdentifyingInfo PowerManagementCapabilities PowerManagementSupported PowerOnHours ProtocolDescription ProtocolSupported SelfTestEnabled TimeOfLastReset TotalPowerOnHours Back to Top IANet_EthernetPCIDevice Purpose
PowerManagementSupported PowerOnHours ProtocolDescription ProtocolSupported SelfTestEnabled Status StatusInfo TimeOfLastReset TotalPowerOnHours Methods There are no supported methods for this class. Please read all restrictions and disclaimers.
Back to Contents Page The Setting Schema: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview IANet_Configuration IANet_Setting IANet_SettingInt IANet_SettingEnum IANet_SettingSlider IANet_SettingMultiSelection IANet_SettingString Overview Back to Top IANet_Configuration Purpose This class is used to group a collection of IANet_Setting instances. The class is derived from CIM_Configuration.
Associations An IANet_AdapterConfiguration instance will exist to associate each adapter (IANet_EthernetAdapter) with its configuration. An IANet_VLANConfiguration instance will exist to associate each VLAN (IANet_VLAN) with its configuration. An IANet_BootAgentConfiguration instance will exist to associate each boot agent (IANet_BootAgent) with its configuration. Methods There are no supported methods for this class. Unsupported Attributes None.
CurrentValue <= max CurrentValue > = min (CurrentValue - min) is a multiple of Step Where max, min, CurrentValue and Step are all attributes of IANet_SettingInt. Associations Each IANet_SettingInt instance is associated with an IANet_Configuration instance using an instance of IANet_SettingContext. Unsupported Attributes SettingID is not used. Methods There are no supported methods for this class. To make changes to a setting, modify the required property and call PutInstance.
Removing Instances You cannot remove instances of this class. Modifying Properties The CurrentValue attribute is the only modifiable property of this class. Modify this property by using Put() to change the value, then call PutInstance() to update the setting. The Providers will check that CurrentValue Є PossibleValues[] Associations Each IANet_SettingSlider instance is associated with an IANet_Configuration instance using an instance of IANet_SettingContext. Unsupported Attributes SettingID is not used.
Modifying Properties The CurrentValue attribute is the only modifiable property of this class. Modify this property by using Put() to change the value, then call PutInstance() to update the setting. Associations Each IANet_SettingMultiSelection instance is associated with an IANet_ElementConfiguration instance using an instance of IANet_SettingString. Methods There are no supported methods for this class. Unsupported Attributes SettingID is not used. Methods There are no supported methods for this class.
Back to Contents Page The Team Schema: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview IANet_TeamOfAdapters IANet_TeamedMemberAdapter IANet_NetworkVirtualAdapter Overview The Team Schema describes how the Ethernet adapters are grouped together into teams. Back to Top IANet_TeamOfAdapters Purpose This class implements the CIM_RedundancyGroup class.
to the team members and the virtual adapter and settings for the team. Modifying Properties Use Put() to change the value of the TeamingMode property, then call PutInstance() to update the team. Associations Each adapter in a team is associated with the team's instance of IANet_TeamOfAdapters using an instance of IANet_TeamMemberAdapter. The virtual adapter for the team is associated with this class using an instance of IA_NetNetworkVirtualAdapter.
This is an association class. Methods There are no supported methods on this class. Please read all restrictions and disclaimers.
Back to Contents Page The VLAN Schema: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview IANet_802dot1QVLANService IANet_VLAN Overview Back to Top IANet_802dot1QVLANService Purpose This class is used to hold the IEEE 802.1Q properties of a network adapter. The class implements the CIM class CIM_802dot1QVLANService. Instances An instance of this class exists for each adapter or team that supports IEEE 802.1Q. Each adapter can have just one IANet_802dot1QVLANService.
If the team does not have VLANs and you use a session handle in the context while enumerating this class. Creating Instances You cannot create instances of this class. If the adapter does not have an instance associated with it, then the adapter does not support this service. Removing Instances You cannot delete instances of this class. Modifying Properties There are no modifiable properties of this class.
Back to Contents Page Getting the Current Configuration: Intel® PRO Network Adapters WMI and CDM Providers User Guide Getting Getting Getting Getting Getting Getting Getting Getting Getting Getting the the the the the the the the the the Physical Adapters PCI Devices Adapter Settings Team Configuration Team Settings VLAN Configuration VLAN Settings IP Protocol Information Boot Agent Information Boot Agent Settings The client does not need to get a session handle to read the current configuration.
devices configure. This is equivalent to IWbemServices::CreateInstanceEnumAsync. Enumerate all PCI devices used by Intel® PROSet configured adapters. SELECT * FROM IANet_EthernetPCIDevice Determine if adapter is installed. N/A IANet_EthernetPCIDevice Check the “Availability” attribute of IANet_EthernetPCIDevice. If equal to 10 “Not Installed”, then the device is not installed. Note: Not much information is known about the device at this stage.
members of the team. The association class IANet_NetworkVirtualAdapter contains no useful data - clients are really only interested in the endpoints of this association. IANet_TeamedMemberAdapter does contain useful data about how the member adapter is used within the team. Task WQL Queries Result Class Comments Enumerate all teams SELECT * FROM IANet_TeamOfAdapters IANet_TeamOfAdapters There is one instance of IANet_TeamOfAdapters for each team.
IANet_SettingSlider Back to Top Getting the VLAN Configuration Each adapter that supports VLANs has an IANet_802dot1QVLANService associated with it, using the association class IANet_Device802do1QVVLANServiceImplementation. If an adapter does not have an instance of this class associated with it, then it does not support VLANs. Each VLAN is represented by an instance of IANet_VLAN. The VLAN is not directly associated with the adapter - it is associated with the IANet_802dot1QVLANService for the adapter.
The Provider will give some limited information about the IP Protocol Endpoints that are associated with adapters, VLANs and teams. No other protocols are supported. The main class containing the protocol information is IANet_IPProtocolEndpoint. There are two association classes: IANet_VLANProtocolDependency and IANet_AdapterProtocolImplementation. To get the IP endpoint for a team, first get the virtual IANet_EthernetAdapter for the team, i.e., the IP Endpoint is associated with this instance.
Please read all restrictions and disclaimers.
Back to Contents Page Updating the Configuration: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview Changing the Adapter, Team, or VLAN Settings Creating a New (Empty) Team Adding an Adapter to a Team Removing an Adapter from a Team Deleting a Team Changing the Mode of a Team Changing an Adapter's Priority within a Team Uninstalling an Adapter Creating a VLAN Changing the Attributes of a VLAN Deleting a VLAN Updating the Boot Agent Overview In most cases, to update the configuration, t
The last description is returned when the current value for IANet_SettingEnum, IANet_SettingSlider or IANet_SettingMultiSelection is not one of the allowable values. The only attribute for a setting that the client can change is CurrentValue. The WMI Provider will ignore changes made to any of the other values. There are no supported methods on the setting class. To make changes to a setting modify the CurrentValue property, call PutInstance.
PreCheck is available. Requires an Apply call before operation is executed. To remove an adapter from a team, delete the IANet_TeamedMemberAdapter instance that associates the adapter to the team using IWbemServices::DeleteInstance(). If this action fails, check IANet_ExtendedStatus for the error code. Back to Top Deleting a Team Deleting a team: Requires Session Handle. PreCheck is available. Requires an Apply call before operation is executed.
To uninstall an adapter, call IWbemServices::DeleteInstance, passing the object path of the adapter to uninstall. Back to Top Creating a VLAN Creating a VLAN: Requires Session Handle. PreCheck is available. Requires an Apply call before operation is executed. To create a VLAN, call the CreateVLAN method on the IANet_802dot1QVLANService for the adapter to which the VLAN is to be added. The following arguments must be passed to the method: VLANNumber, which is the number of the VLAN.
IANet_BootAgent for the adapter (e.g., use IWbemServices::GetObject using the object path). Then, execute ReadFlash() to read the existing flash boot ROM image or ProgramFlash() to update the flash boot ROM image. If this action fails, check the IANet_ExtendedStatus for the error code.
Back to Contents Page Event Notifications: Intel® PRO Network Adapters WMI and CDM Providers User Guide Concrete Event Classes Registering for Events Back to Top Concrete Event Classes IANet_802dot3AdapterEvent Purpose This event notifies the client about a change in the status or configuration of an adapter. Triggers The event occurs after an adapter status changes or after you have changed an adapter setting and called Apply.
This event notifies the client about a change in the status or configuration of a team. Triggers The event occurs: After the status of an adapter changes. After you have changed a team setting and called Apply. After the team configuration has been changed and you call Apply. Event Data TeamPath contains the object path of the team that caused the event. IANet_802dot3VlanEvent Purpose This event notifies the client about a change in the status or configuration of a VLAN.
Back to Contents Page Optimized WQL Queries: Intel® PRO Network Adapters WMI and CDM Providers User Guide Overview Getting the Settings for a Particular Adapter, VLAN, or Team Getting One Setting Overview The WMI Provider is optimized to allow applications to get settings using queries. The WMI Provider can recognize the following queries and will only return the objects that match.
Back to Contents Page Diagnostics: Intel® PRO Network Adapters WMI and CDM Providers User Guide Diagnostic Classes Registry Entries Logging Associative Classes Tests Diagnostic Classes IANet_DiagTest Purpose IANet_DiagTest is subclassed from CIM_DiagnosticTest. The class provides a generic vehicle to run and control diagnostic tests for an Intel® PROSet supported Ethernet adapter.
The referenced parameter ManagedSystemElement, combined with this object’s object path combine to reference instances of DiagnosticResultForMSE, which will be deleted. Also, all references of DiagnosticResult objects referenced by DiagnosticResultForMSE will be deleted. Also, all instances of DiagnosticResultForTest, which refer to the deleted DiagnosticResult objects, will be deleted.
Paste the IANet_DiagTest object path into the dialog box. Click OK. Select the test in the drop-down box under method. Click the Edit In Parameters button. For RunTest, Setting and SystemElement are the In parameters. Paste the previously saved Setting and Adapter object paths and close. 20. Click the Execute button. 21. Enumerate the IANet_DiagResult class, in the same manner as the In parameters. 22. Examine the selected result object as needed. 16. 17. 18. 19.
Instances of IANet_DiagResult display result data for a particular test run on a particular adapter. Instances of this class correspond identically to instances of IANet_DiagTest and IANet_DiagSetting. Instances Instances of IANet_DiagResult correspond to results of a particular test run on a specific adapter. The format for the key is the same as IANet_DiagTest and IANet_DiagSetting.
responder test Enable REG_DWORD 0 Enable (1) or Disable (0) usage of a results log file. FileAppend REG_DWORD 1 Append (1) log results file to existing log results file. If 0, delete existing file. LogFileName REG_SZ NcsDiag.log The name of the log results file. MaxFileSize REG_DWORD 0x10000 Maximum size of the log results file. MaxPktsRcvd REG_DWORD 200 In Quick Mode (from IANet_DiagSetting), send/receive test will terminate when the number of packets received is greater than this value.
MAC Loopback PHY Loopback Link All error messages from these tests result from HRESULT error codes returned from calls to lower stack layers. The error codes are stored internally as error codes and are not translated into error messages until the IANet_DiagResult objects are de-referenced by enumeration or object calls are received from a management application.
Back to Contents Page Executing Methods in IANet_DiagTest: Intel® PRO Network Adapters WMI and CDM Providers User Guide Executing RunTest, and Other Methods in WbemTest The RunTest method from the MOF file is as follows: uint32 RunTest([IN] CIM_ManagedSystemElement ref SystemElement, [IN] CIM_DiagnosticSetting ref Setting, [OUT] CIM_DiagnosticResult ref Result); The first two parameters are In parameters. You must get the object path of both objects referenced.
Back to Contents Page Summary of CIM Classes: Intel® PRO Network Adapters WMI and CDM Providers User Guide Class Can Create? Can Delete? Implemented Methods Settable Properties Unsupported Properties Instance Count Related Association Classes IANet_802dot1QVLANService N N CreateVLAN GRVPEnabled, JoinTime Description, Install Date, Started, StartMode, Status One instance for each team or adapter that supports VLANs IANet_Device802dot1QVLANServiceImplementation, IANet_VLANFor IANet_AdapterCon
IANet_DiagResult N N None None EstimatedTimeOfPerforming, HaltOnError, OtherStateDescription, ReportSoftErrors, TestWarningLevel One for each adapter/test combination IANet_DiagResultForTest, IANet_DiagResultForMSEM IANet_EthernetAdapter N Y IdentifyAdapter HasVLANs IsPowerMgmtSupported GetPowerUsage SetPowerUsage GetPowerUsageOptions SetPowerUsageOptions TestCable AdvancedTestCable TestLinkSpeed None AutoSense – (this is exposed as a setting), ErrorCleared, OtherIdentifyingInfo, IdentifyingDes
IANet_Setting N N None None SettingID This is an abstract class. IANet_SettingContext IANet_SettingContext N N None None None One instance for each setting This class associates IANet_Setting with an IANet_Configuration.
Back to Contents Page Intel Software License Agreement (Final, License): Intel® PRO Network Adapters WMI and CDM Providers User Guide IMPORTANT - READ BEFORE COPYING, INSTALLING OR USING Do not use or load this software and any associated materials (collectively, the "Software") until you have carefully read the following terms and conditions. By loading or using the Software, you agree to the terms of this Agreement. If you do not wish to so agree, do not install or use the Software.
you retain no copies of the Software. LIMITED MEDIA WARRANTY. If the Software has been delivered by Intel on physical media, Intel warrants the media to be free from material physical defects for a period of ninety days after delivery by Intel. If such a defect is found, return the media to Intel for replacement or alternate delivery of the Software as Intel may select. EXCLUSION OF OTHER WARRANTIES.
Back to Contents Page Support: Intel® PRO Network Adapters WMI and CDM Providers User Guide Web and Internet Sites http://www.dell.com Customer Support Technicians If the troubleshooting procedures in this document do not resolve the problem, please contact Dell Computer Corporation for technical assistance (refer to the "Getting Help" section in your system documentation). Before you call... You need to be at your computer with your software running and the product documentation at hand.
