MSFT_NetAdapterBindingSettingData class

This class represents the binding information of a network adapter.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("NetAdapterCim")]
class MSFT_NetAdapterBindingSettingData : MSFT_NetAdapterSettingData
{
  string  Caption;
  string  Description;
  string  ElementName;
  string  InstanceID;
  string  Name;
  string  InterfaceDescription;
  uint32  Source;
  string  SystemName;
  boolean Enabled;
  string  DisplayName;
  string  ComponentID;
  string  BindName;
  string  ComponentClassName;
  string  ComponentClassGuid;
  uint32  Characteristics;
};

Members

The MSFT_NetAdapterBindingSettingData class has these types of members:

• Methods
• Properties

Methods

The MSFT_NetAdapterBindingSettingData class has these methods.

Method	Description
Disable	Disables a binding to a network adapter.
Enable	Enables a binding to a network adapter.

 

Properties

The MSFT_NetAdapterBindingSettingData class has these properties.

BindName

Data type: string

Access type: Read-only

The name used by NDIS. This is typically the service name for the protocol.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 64 )

A short textual description of the object. This property inherits from CIM_ManagedElement.

Characteristics

Data type: uint32

Access type: Read-only

Characteristics of the network component represented by this binding.

ComponentClassGuid

Data type: string

Access type: Read-only

The class GUID of the network component represented by this binding.

ComponentClassName

Data type: string

Access type: Read-only

The class name of the network component represented by this binding.

ComponentID

Data type: string

Access type: Read-only

The component ID of the transport or filter.

Description

Data type: string

Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

DisplayName

Data type: string

Access type: Read-only

The display name of the transport or filter.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. The same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits from CIM_ManagedElement.

Enabled

Data type: boolean

Access type: Read/write

If True, the binding has been enabled by admin. If False, the binding has been disabled.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

This property inherits from CIM_SettingData.

InterfaceDescription

Data type: string

Access type: Read-only

Interface Description, also known as "ifDesc" or display name is a unique name assigned to the network adapter during installation. This name cannot be changed and is persisted as long as the network adapter is not uninstalled. This property inherits from MSFT_NetAdapterSettingData.

Name

Data type: string

Access type: Read-only

Name, also known as Connection Name, "ifAlias", or InterfaceAlias, is a unique name assigned to the adapter during installation. The Name of the adapter can be changed by the administrator and is persisted across the boot or network adapter restart. This property inherits from MSFT_NetAdapterSettingData.

Source

Data type: uint32

Access type: Read-only

The source of the setting data. This property inherits from MSFT_NetAdapterSettingData.

Unknown (0)

Other (1)

Device (2)

Persistent storage (3)

SystemName

Data type: string

Access type: Read-only

The scoping System\'s Name. This property inherits from MSFT_NetAdapterSettingData.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\StandardCimv2
MOF	NetAdapterCim.mof
DLL	NetAdapterCim.dll