Intel 82559ER, 82573E, 82599 10, 8255X, 82540EP Manual

Intel PROSet For

Windows* Device Manager

WMI Provider User‟s Guide

White Paper

Revision 1.7

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

2

Introduction

Intel® PROSet for Windows* Device Manager deploys Network Configuration Services version 2.0, an easy to use solution

for deploying and managing all Intel end-station networking technologies using industry standard methods. The NCS2

architecture works closely with the Windows Management Instrumentation (WMI) service to provide remote management of

Intel network devices. This document describes the WMI classes and providers supplied by Intel® PROSet for Windows*

Device Manager.

This document is divided into several sections

Technology overview – an overview of WMI technology.

Class summaries – the class and namespace details for the NCS2 architecture.

Working examples – how to use the NCS2 architecture to manage Intel® network devices.

Errata – additional information specific to some environments.

Intel® PROSet for Windows*Device Manager WMI providers offer the following features.

Category

Features

Adapter

Enumerate all supported physical network adapters

Update settings for an adapter

Obtain an adapter‟s physical device information

Monitor adapter link

Uninstall an adapter driver

Query IPv4 and IPv6 adapter addresses

Boot

Change an adapter‟s boot agent settings

View and modify adapter iSCSI settings

Diagnostics

Enumerate diagnostic tests, settings, and results

Run or stop a diagnostic test on an installed adapter

Team

Enumerate supported team types

Create or remove a team of adapters

Update team settings

Add or remove team member adapters

Change team member priorities

Obtain the IPv4 protocol settings for a team

VLAN

Create, discover, or remove Virtual LANs on an adapter or team

Update VLAN settings

Obtain the IPv4 protocol settings for a VLAN

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

3

Technology Overview

This section offers an overview of Windows Management Instrumentation in Microsoft operating systems and is

recommended for anyone not familiar with the architecture. Further reading on this topic is encouraged and additional are

links are provided at the end of this section.

Web-based Enterprise Management

Web-based Enterprise Management (WBEM) is a Distributed Management Task Force (DMTF) initiative providing enterprise

system managers with a standardized, cost-effective method for end station management. The WBEM initiative

encompasses a multitude of tasks, ranging from simple workstation configuration to full-scale enterprise management

across multiple platforms. Central to the initiative is the Common Information Model (CIM), an extensible data model

representing objects in typical management environments, and the Managed Object Format (MOF) language for defining and

storing modeled data.

Windows Management Instrumentation

Windows Management Instrumentation (WMI) is the Microsoft implementation of WBEM for Windows* operating systems. It

exposes a programmable interface to view and interact with management objects. Running as a system service, this

operating system component offers many powerful capabilities.

WMI consists of the following components:

Management applications

Managed objects

Providers

Management infrastructure

A COM API to allow access to management information.

Management applications process or display data from managed objects, which are logical or physical enterprise

components. These components are modeled using CIM and accessed by applications through Windows Management

Services. Providers supply Windows Management with data from managed objects, handle requests from applications and

notification of events. The providers for Intel® PROSet for Windows* Device Manager play a central role in network card

configuration management.

Windows management consists of the CIM Object Manager (for handling the communication between management

applications and providers) and a central storage area (CIMOM object repository). Data is placed in the repository using

either the MOF language compiler or the Windows Management API.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

4

The following diagram shows the interrelationship of these components:

Figure 1 – Windows Management Architecture

Common Information Model

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 as classes. CIM was designed by the DMTF to be operating system

and platform independent, but the Microsoft implementation pre-dominates the specification. WBEM technology includes an

extension of CIM for Microsoft Windows* operating system platforms. Please refer to the DMTF CIM schema on the DMTF

web site for more information. Intel® PROSet for Windows* Device Manager is based on CIM Schema version 2.6.

CIM defines three levels of classes:

Classes representing managed objects that apply to all areas of management. These classes provide a basic

vocabulary for analyzing and describing managed systems and are part of what is referred to as the “core

model.”

Classes representing managed objects that apply to a specific management area but are independent of a

particular implementation or technology. These classes are part of what is referred to as the common model -

an extension of the core model.

Classes representing managed objects that are technology-specific additions to the common model. These

classes typically apply to specific platforms such as UNIX or the Microsoft Win32 environment.

Inheritance Relationships

Classes can be related by inheritance, where a child class includes data and methods from its parent. Inheritance

relationships are not typically visible to the management application using them, nor are the applications required to know

the inheritance hierarchy. Class hierarchies can be viewed with CIM repository viewers. Since the NCS2 architecture uses

inheritance, it is important to understand the limits and capabilities of these relationships.

Association Classes

Windows Management also supports association classes. Association classes link two different classes to model a user-

defined relationship, and are visible to management applications. Third-party developers can also define association classes

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

5

for their management environment. Associations represent a relationship between two WMI objects (classes). The

properties of the association class include two pointers or references, each linking to a different instance. The relationships

are maintained by path only; the association class does not have the capabability to modify the instances it links. For

additional information on CIM, visit http://www.dmtf.org

CIM Tools

There are many ways to interact with a CIM repository depending on which operating system the user has installed. These

tools are best used to view CIM information; scripting and programming languages are recommended for configuration

changes.

Tool

Explanation

Wbemtest

Native support on any Windows* operating system where WMI has been installed.

CIM Studio

Browser based implementation of WBEMTest.exe and much easier to use. However, it requires download and install

an additional program. To locate this tool, search for “WMI Administrative Tools” on Microsoft‟s web site

(www.microsoft.com).

Windows

Powershell

Optional shell environment which offers powerful scripting capabilities and provides easy access to WMI

namespaces through simple queries.,

WMIC

Windows Management Instrumentation Command-line. A command line interface to WMI namespaces.

Installed Files

Executables

When information is requested about Intel® PROSet for Windows* Device Manager through a WMI service call, the NCS2

provider will be launched. This will be visible as a running process in the operating system. Start and shutdown of WMI

providers is completely transparent to user; there is no need to directly manipulate them. After a period of inactivity, the

NCS2 provider will unload itself (usually a few minutes).

Filename

Description

Ncs2Prov.exe

Intel® PROSet for Windows* Device Manager WMI provider.

Dynamically Linked Libraries

The following dynamically linked libraries are used by Intel® PROSet for Windows* Device Manager.

Filename

Description

Ncs2Core.dll

Implements the Ethernet Adapter Schema.

Ncs2Diag.dll

Implements the Diagnostics Schema.

Ncs2Boot.dll

Implements the Boot Agent Schema.

Ncs2Team.dll

Implements the Team Schema.

Ncs2VLAN.dll

Implements the VLAN Schema.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

6

MOF Files

A “MOF” file is a Managed Object Format file which contains information about WMI classes. A set of basic MOF files are

included on distribution media for reference only. There are separate MOF files for language neutral and language specific

data, which become available upon installation. The following are .mof files for the „root\IntelNCS2‟ namespace.

Filename

Description

ICmLn.mof

CIM base classes on which the NCS2 classes depend.

ICmEnu.mfl

US English version of the CIM base classes.

ICoreLn.mof

Classes for the IEEE 802.3 adapters.

ICoreEnu.mfl

US English textual amendments to the adapter classes.

IBootLn.mof

Classes for the IEEE 802.3 boot service

IBootEnu.mfl

US English textual amendments to the 802.3 boot service classes.

IDiagLn.mof

Classes for the CDM (Common Diagnostic Model).

IDiagEnu.mfl

US English textual amendments to the CDM classes.

ITeamLn.mof

Classes for the IEEE 802.3 teams.

ITeamEnu.mfl

US English textual amendments to the team classes.

IVLANLn.mof

Classes for the IEEE 802.3 VLANs.

IVLANEnu.mfl

US English textual amendments to the VLAN classes.

Security

The NCS2 WMI provider uses client impersonation to manage the security; every call will be made in the client‟s own

security context. This context is passed down to the lower layers. An operation may fail if the user does not have suitable

administrative rights on the target machine. Please see Permissions for more information.

Namespaces

CIM classes are organized into namespaces, a logical partitioning of the CIM object management repository. Installation of

Intel® PROSet for Windows* Device Manager will create the namespace “root\IntelNCS2” The NCS2 architecture uses this

namespace to organize management information and make it available to clients. This namespace is only visible when

PROSet has been installed and will be removed upon product uninstall.

root\IntelNCS2

The root\IntelNCS2 namespace contains information about Intel® PROSet for Windows* Device Manager configuration and is

based on CIM version 2.6. The root\CIMv2 namespace was not used as a primary because it is based on CIM version 2.2 and

has object key differences. Classes in this namespace have been extended through class inheritance to contain information

specific to the NCS2 architecture. All operations regarding adapters, teams, VLANs, boot agent settings, and diagnostics

must interact with this namespace.

Locales and Localization

Localized MOF files

All the MOF files used by the NCS2 WMI Provider are localized according to the Microsoft Windows Management

Instrumentation globalization model. To accomplish this, each class definition is separated into the following:

a language-neutral version that contains only the basic class definition in the .mof file.

a language-specific version that contains localized information, such as property descriptions that are specific

to a locale in the corresponding .mfl file.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

7

Class Storage

The language-specific class definitions are stored in a child sub-namespace beneath the namespace that contains a

language-neutral basic class definition. For example, for the NCS2 WMI Provider, a child namespace ms_409 will exist

beneath the root/IntelNCS2 namespace for the English locale. Similarly, there exists a child sub-namespace for each

supported language beneath the root/IntelNCS2 namespace.

Runtime Support

To retrieve localized data, a WMI application can specify the locale using strLocale parameter in

SWbemLocator::ConnectServer and IWbemLocator::ConnectServer calls. If the locale is not specified, the default locale for

that system will be used. (e.g. MS_409 for US English). This locale is used to select the correct namespace when adding in

the English strings. In addition, IWbemServices::GetObject, SWbemServices.GetObject, IWbemServices:: ExecQuery, and

SWbemServices.ExecQuery must specify the WBEM_FLAG_USER_AMENDED_ QUALIFIERS flag to request localized data

stored in the localized namespace, along with the basic definition. This is required in all functions that produce displayable

values using value maps or display descriptions or other amended qualifiers from the MOF files.

WBEM Context

IWbemContext is a WMI programming interface which allows users to optionally communicate additional parameters to

providers when submitting function calls. If you plan on making any changes to the NCS2 configuration through a WMI call,

then you must pass a WbemContext parameter. These optional parameters are constructed by the user and passed as part

of a WbemServices call. Interaction with NCS2 is dependent upon WbemContext objects when modify operations are

requested. Thus, any request to NCS2 for a configuration change requires a WbemContext object to be constructed by the

user and passed in the WbemServices function call. The following table contains the context qualifiers (named values) used

by the NCS2 Provider.

Context Qualifier

Variant Type

Description

ClientSetId

VT_BSTR

A client handle allows the NCS2 software to manage single access to the

configuration. The application cannot make any changes to classes without first

establishing this; see the section on the IANet_NetService class to see how to

establish and use a client handle.

MachineName

VT_BSTR

The name of the machine that is connecting to the IntelNCS2 provider. This is

required for logging.

Use Cases

A session handle is required to change a configuration and is managed through the root\IntelNCS2 namespace classes. This

identification number allows the NCS2 software to manage single access to the configuration, thereby preventing changes

from more than one source at a time. Understanding the role of these client handles is crucial for successful management

changes.

Getting a Client Handle

The client must get the object path of the single instance of IANet_NetService before accessing the client handle. There will

only be one instance of this class. Before making any changes to the configuration, the client must get a client handle

provided by this class through the BeginApply ( ) method. Use this method to obtain a numeric lock ID which will

authenticate access requests. Client handles are random numbers generated new each time they are requested. This lock

will remain in place until the Apply ( ) method is called or the provider unloads itself from inactivity. Client handles are only

required during operation which make a configuration change.

Using a Client Handle in the IWbemContext Object

After the client handle is obtained, a WbemContext object has to be created. Store the client handle in the ClientSetId

qualifier of this object. A pointer to this COM object should be passed to every call into IWbemServices. The client handle is

not required when making calls to access the IANet_NetService object as this takes the handle as an explicit argument. By

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

8

passing the client handle as an argument with the method, the software stack can identify the source of the request. Since

the client handle is a number, it can be treated as such for assignment purposes.

Finishing with a Client Handle

After changing the configuration, call the IANet_NetService::Apply ( ) method to commit the changes. The client handle ID is

passed as an argument to the Apply ( ) method. This may return a follow-up action code (e.g., reboot the system before the

changes can take effect). If any devices became disabled during change operations, committing an Apply ( ) method will

enable them.

Error Reporting

This section details how to handle errors generated by the NCS2 provider. 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. At this point, however, it is unknown whether WMI or a NCS2 Provider generated

the error.

Getting the Error Object

Synchronous Calls

Use GetErrorInfo ( ) to get the IErrorInfo object. Use QueryInterface ( ) to get the IWbemClassObject that contains the error

information.

Asynchronous Calls

The IWbemClassObject is passed back as the last item in the last SetStatus ( ) call. After you get the error object instance,

you can check the __Class property to determine the origin of the error. WMI creates an instance of __ExtendedStatus, and

the NCS2 WMI Provider creates an instance of IANet_ExtendedStatus for errors relating to IANet_ classes and NCS2 WMI

Provider. IANet_ExtendedStatus is derived from __ExtendedStatus and contains the following attributes:

Error Codes

For all error codes, the NCS2 provider gives a description customized to the locale. Error codes are in the form of HRESULT

with severity set to one (1) and facility set to ITF. An application may use these codes as a basis for a recovery action. See

IANet_ExtendedStatus for a list of error codes.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

9

Classes

The following classes are used by Intel® PROSet for Windows* Device Manager and are located in the root\IntelNCS2

namespace.

Class List

IANet_DiagTestForMSE

IANet_EthernetAdapter

IANet_ExtendedStatus

IANet_LogicalEthernetAdapter

IANet_NetService

IANet_NetworkVirtualAdapter

IANet_PhysicalEthernetAdapter

IANet_Setting

IANet_TeamedMemberAdapter

IANet_TeamOfAdapters

IANet_TeamSetting

IANet_TeamSettingEnum

IANet_TeamSettingInt

IANet_TeamSettingMultiSelection

IANet_TeamSettingSlider

IANet_TeamSettingString

IANet_TeamToTeamSettingAssoc

IANet_VLAN

IANet_VLANFor

IANet_VLANSetting

IANet_VLANSettingEnum

IANet_VLANSettingInt

IANet_VLANSettingMultiSelection

IANet_VLANSettingSlider

IANet_VLANSettingString

IANet_VLANToVLANSettingAssoc

IANet_802dot1QVLANService

IANet_AdapterSetting

IANet_AdapterSettingEnum

IANet_AdapterSettingInt

IANet_AdapterSettingMultiSelection

IANet_AdapterSettingMultiString

IANet_AdapterSettingSlider

IANet_AdapterSettingString

IANet_AdapterToSettingAssoc

IANet_BootAgent

IANet_BootAgent_iSCSI_Adapters

IANet_BootAgentSetting

IANet_BootAgentSettingEnum

IANet_BootAgentSettingInt

IANet_BootAgentSettingString

IANet_BootAgentToBootAgentSettingAssoc

IANet_Device802dot1QVLANServiceImplementation

IANet_DeviceBootServiceImplementation

IANet_DiagConnectionResultStrings

IANet_DiagResult

IANet_DiagResultForMSE

IANet_DiagResultForTest

IANet_DiagResultInPackage

IANet_DiagSetting

IANet_DiagSettingForTest

IANet_DiagTest

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

10

IANet_802dot1QVLANService

This class is used to hold the IEEE 802.1Q properties of a network adapter. This 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 or team can have just one

IANet_802dot1QVLANService. Some teams, such as multi-vendor fault tolerant teams do not support this service. The user 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. The user cannot delete instances of this class.

Properties

There are no supported or modifiable properties.

Methods

Method

Returns

Parameters

Detail

CreateVLAN

uint16

[in] uint32 VLANNumber

[in] string Name

[out] ref:IANet_VLAN

Used to create a VLAN on the adapter or team.

The client must supply the VLAN number and

the VLAN name, and will get the object path of

the newly created VLAN.

Associations

IANet_Device802dot1QVLANServiceImplementation

IANet_AdapterSetting

This abstract class is used to describe a settable property in a configuration. The class is derived from IANet_Setting. Instances of

this class will exist for each setting on each adapter. There are several sub-classes for IANet_AdapterSetting. The sub-classes

correspond to the different types and ranges of values that settings can take. Each sub-class corresponds to a different style of GUI

that may be used to display or change the settings.

Instances

There will be one instance for every class which inherits this one; a single instance for every type of adapter setting.

Properties

See class IANet_Setting for supported properties.

Methods

There are no supported methods.

Associations

Association Class

Association Partner

IANet_AdapterToSettingAssoc

IANet_PhysicalEthernetAdapter

IANet_AdapterSettingInt

The class models a setting that takes an integer value. There are several IANet setting classes used to model integers. The

differences between these classes concerns how the integer is displayed and modified by the user interface and how validation is

done by the NCS2 WMI Provider. For IANet_AdapterSettingInt, it is expected that the user interface will display an edit box with a

spin control.

Instances

An instance of this class exists for each setting that should be displayed as an integer edit box. Users can neither create nor remove

instances.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

11

Name

Type

Description

base

uint64

Base is the root from which an integer value may take values.

max

sint64

The maximum value the integer can take.

min

sint64

The minimum value the integer can take.

Scale

sint64

The unit of measurement to set or estimate series of marks or points at known intervals to measure value

of the parameter.

step

sint64

Granularity of the integer value.

Modifiable properties: CurrentValue must be within the range of .min and .max.

Methods

There are no supported methods.

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterSettingEnum

The class models an enumeration setting value. For IANet_AdapterSettingEnum, it is expected that the user interface will display a

list of strings which map onto a small number of enumerated values. (e.g., a drop list , combo box).

Instances

An instance of this class exists for each setting that will be displayed as an enumeration.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

DescriptionMap

[ ] string

Contains what each value means

PossibleValues

[ ] sint64

An array of possible values allowed for the enum.

Modifiable properties: CurrentValue  PossibleValues[]

Methods

There are no supported methods.

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterSettingMultiString

The class objectifies adapter related driver and network device settings; specifically, it handles multi-string settings.

Instances

An instance of this class exists for each setting that will be as a list of string values. Users can neither create nor remove instances.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

Maxlength

uint32

The maximum length of the string.

Modifiable properties: CurrentValue

Methods

There are no supported methods.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

12

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterSettingMultiSelection

This class models a setting whereby the user can select several options from a list of options. For

IANet_AdapterSettingMultiSelection, it is expected that the GUI will display multi-selection list box which will allow the user to

choose any (or no) option(s).

Instances

An instance of this class exists for each setting that should be displayed as a list of options.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

FirstLabel

string

The label that should be displayed on the left side of the slider.

LastLabel

string

The label that should be displayed on the right side of the slider.

PossibleValues

[ ] sint64

The initial value of the parameter.

Modifiable properties: CurrentValue  PossibleValues[]

Methods

There are no supported methods.

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterSettingString

This class models a setting whereby the user can enter a free-form string value. For IANet_AdapterSettingString, it is expected that

the user interface will display an edit box.

Instances

An instance of this class exists for each setting that should be displayed as a string.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

MaxLength

uint32

The maximum length of the string.

Modifiable properties: CurrentValue

Methods

There are no supported methods.

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterSettingSlider

The class models a setting that specifically handles Slider settings. For IANet_AdapterSettingSlider, it is expected that the user

interface will display a slider which will allow the user to choose the value in a graphical manner – the actual value chosen need not

be displayed.

Instances

An instance of this class exists for each setting that will be displayed as a slider. Users can neither create nor remove instances.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

13

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

FirstLabel

string

The label that should be displayed on the left side of the slider.

LastLabel

string

The label that should be displayed on the right side of the slider.

PossibleValues

[ ] sint64

The initial value of the parameter.

Modifiable properties: CurrentValue  PossibleValues[]

Methods

There are no supported methods.

Associations

Inherits an association with IANet_PhysicalEthernetAdapter through IANet_AdapterToSettingAssoc.

IANet_AdapterToSettingAssoc

This is an association class between an instance of IANet_PhysicalEthernetAdapter and IANet_AdapterSetting.

Instances

There will be one instance of this class for every adapter setting on an adapter.

Properties

Name

Type

Description

Element

ref

Reference to IANet_PhysicalEthernetAdapter

Setting

ref

Reference to IANet_AdapterSetting

IANet_BootAgent

This class is used to capture information about the network boot capabilities of an adapter (e.g., settings for the PXE Boot Agent

supported by some Intel adapters).

Instances

An instance exists for each adapter that supports boot agent capabilities, even if the boot agent is not currently installed. Users can

neither create nor remove instances.

Properties

Name

Type

Description

Values

FlashImageType

uint32

Boot Agent Flash Image type.

0 PXE

1 PXE_EFI

3 EFI

4 DISABLED

5 BLANK

6 MISSING

7 iSCSI

255 Unknown

InstalledFlashImageTypes

uint32

Boot Agent flash image types that

are currently installed in the ROM.

1 PXE

2 EFI

4 ISCSI

255 Unknown

InvalidImageSignature

boolean

Will be set to true if the boot agent has a corrupted flash image.

iSCSI_Status

uint32

Boot Agent iSCSI status.

0 iSCSI_PRIMARY

1 iSCSI_SECONDARY

2 iSCSI_DISABLED

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

14

There are no other supported properties.

Modifiable properties: none

Methods

There are two methods on this class that can be used to update the Flash ROM on the NIC:

Method

Returns

Parameters

Detail

ProgramFlash

uint32

[IN] uint32 Action

[IN] array of uint8 NewFlashData

[OUT] uint32 FlashRetCode

This method is used to update the Flash ROM on the NIC.

This will cause the NIC to stop communicating with the

network while the flash is updated.

ReadFlash

uint32

[OUT] array of uint8 FlashData

This method reads the Flash ROM on the NIC.

Associations

Association Class

Association Partner

IANet_BootAgentToBootAgentSettingAssoc

IANet_BootAgentSetting

IANet_DeviceBootServiceImplementation

IANet_PhysicalEthernetAdapter

IANet_BootAgent_iSCSI_Adapters

This class is used to capture information about iSCSI supported adapters installed in the system.

Instances

There will be one instance of each adapter which supports iSCSI boot. Users can neither create nor remove instances.

Properties

There are no other supported properties.

Modifiable properties: none

Methods

There is one method of this class which can be used to set the iSCSI priority of adapters:

Method

Returns

Parameters

Detail

SetiSCSI_Status

uint32

[IN] uint32 iSCSI_State

[OUT] uint32 RetCode

This method will update the status of adapters that support iSCSI Boot.

The function only takes the primary and secondary adapter IDs and

sets them accordingly. The remaining adapters are set to disabled.

iSCSI_State

0 Set adapter to Primary

1 Set adapter to Secondary

255 Unknown

UpdateAvailable

boolean

Indicates if install or upgrade to boot agent software is available.

Version

string

String describing boot agent version.

VersionNumber

uint32

Boot agent version in the format x.x.x

Name

Type

Description

Values

AdapterName

string

Friendly name of the adapter.

Caption

This is an inherited property; refer to parent class CIM definition.

iSCSI_Status

uint32

The boot agent iSCSI status.

0 iSCSI_PRIMARY

1 iSCSI_SECONDARY

2 iSCSI_DISABLED

255 Unknown

Name

This is an inherited property; refer to parent class CIM definition.

White Paper - Intel PROSet for Windows* Device Manager WMI User‟s Guide

15

2 Set adapter to Disabled

RetCode

0 The state change was successful

1 The state change failed

Associations

There are no associations.

IANet_BootAgentSetting

This abstract class is used to describe a settable property in a configuration. The class is derived from IANet_Setting. Instances will

exist for each Boot Agent setting. There are several sub-classes for IANet_BootAgentSetting which correspond to the different

types and ranges of values that settings can take.

Instances

There will be one instance for every class which inherits this one; a single instance for every type of adapter boot setting.

Properties

See class IANet_Setting for supported properties.

Methods

There are no supported methods.

Associations

Association Class

Association Partner

IANet_BootAgentToBootAgentSettingAssoc

IANet_BootAgent

IANet_BootAgentSettingEnum

The class models an enumeration setting value.

Instances

An instance of this class exists for each setting that will be displayed as an enumeration.

Properties

In addition to the properties supported by IANet_Setting, this class supports:

Name

Type

Description

DescriptionMap

[ ] string

Contains what each value means.

PossibleValues

[ ] sint64

An array of possible values allowed for the Enum.

Modifiable properties: CurrentValue  PossibleValues[]

Methods

There are no supported methods.

Associations

Inherits an association with IANet_BootAgent through IANet_BootAgentToBootAgentSettingAssoc

IANet_BootAgentSettingInt

This class objectifies Boot Agent related driver and network device settings. IANet_BootAgentSettingInt specifically handles Integer

settings.

Instances

An instance of this class exists for each setting that should be displayed as an integer edit box. Users can neither create nor remove

instances.