Msvm_WiFiEndpoint class

Article
01/07/2021

Represents the logical connection point for a network adapter. When the Wi-Fi endpoint is connected to a switch port, the network adapter connected to the Wi-Fi endpoint has network connectivity.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_WiFiEndpoint : CIM_WiFiEndpoint
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType = 71;
  string   OtherTypeDescription;
  string   LANID;
  uint16   LANType;
  string   OtherLANType;
  string   MACAddress;
  string   AliasAddresses[];
  string   GroupAddresses[];
  uint32   MaxDataSize;
  boolean  Connected;
  uint16   EncryptionMethod;
  string   OtherEncryptionMethod;
  uint16   AuthenticationMethod;
  string   OtherAuthenticationMethod;
  uint16   IEEE8021xAuthenticationProtocol;
  string   AccessPointAddress;
  uint16   BSSType;
  boolean  Associated;
};

Members

The Msvm_WiFiEndpoint class has these types of members:

Methods
Properties

Methods

The Msvm_WiFiEndpoint class has these methods.

Method	Description
RequestStateChange	This method is not supported.

Properties

The Msvm_WiFiEndpoint class has these properties.

AccessPointAddress

Data type: string
Access type: Read-only

Contains the MAC address of the access point with which the Wi-Fi endpoint is currently associated. If the Wi-Fi endpoint is not currently associated, then AccessPointAddress should be Null. The MAC address should be formatted as twelve hexadecimal digits (for example, "010203040506"), with each pair representing one of the six octets of the MAC address in canonical bit order (for example, the Group address bit is found in the low order bit of the first character of the string).

AliasAddresses

Data type: string array
Access type: Read-only

Other unicast addresses that may be used to communicate with the LAN endpoint. This property is inherited from CIM_LANEndpoint.

Associated

Data type: boolean
Access type: Read-only

Indicates whether the Wi-Fi endpoint is currently associated to an access point or client station.

Contains True if the Wi-Fi endpoint is associated to an access point or client station; otherwise, False.

AuthenticationMethod

Data type: uint16
Access type: Read-only

Specifies the method used to authenticate the Wi-Fi endpoint and the network to one another.

Unknown (0)
Other (1)
Open System (2)
Shared Key (3)
WPA PSK (4)
WPA IEEE 802.1x (5)
WPA2 PSK (6)
WPA2 IEEE 802.1x (7)
CCKM IEEE 802.1x (8)
DMTF Reserved (9.. )

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (.. )

BSSType

Data type: uint16
Access type: Read-only

Indicates the Basic Service Set (BSS) type of the network that corresponds to the instance. A Basic Service Set is a set of stations controlled by a single coordination function.

Value	Meaning
Unknown 0
Independent 2	The Wi-Fi endpoint is associated directly to another client station.
Infrastructure 3	The Wi-Fi endpoint is associated to a network by using an access point.
DMTF Reserved 4..

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Connected

Data type: boolean
Access type: Read-only

This property is set to True if the Wi-Fi endpoint is connected to a switch port.

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_ServiceAccessPoint.

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16
Access type: Read-only

Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and will be one of the following values.

Enabled (2)
Disabled (3)
Enabled but Offline (6)

EnabledState

Data type: uint16
Access type: Read-only

Specifies the enabled state of the planned system. This property is inherited from CIM_EnabledLogicalElement, and it can be one of the following values.

Value	Meaning
Disabled 3	The system is turned off.
Not Applicable 5	The element does not support being enabled or disabled.
Enabled but Offline 6	The system is enabled, but offline. Any new requests will be dropped.

EncryptionMethod

Data type: uint16
Access type: Read-only

Specifies the encryption method in use to protect the confidentiality of data sent and received by the Wi-Fi endpoint.

Unknown (0)
Other (1)
WEP (2)
TKIP (3)
CCMP (4)
None (5)
DMTF Reserved (6.. )

GroupAddresses

Data type: string array
Access type: Read-only

Multicast addresses to which the LAN endpoint listens. This property is inherited from CIM_LANEndpoint.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement.

IEEE8021xAuthenticationProtocol

Data type: uint16
Access type: Read-only

Contains the Extensible Authentication Protocol (EAP) type if and only if AuthenticationMethod contains 5 (WPA IEEE 802.1x), 7 (WPA2 IEEE 802.1x), or 8 (CCKM IEEE 802.1x).

EAP-TLS (0)
EAP-TTLS/MSCHAPv2 (1)
PEAPv0/EAP-MSCHAPv2 (2)
PEAPv1/EAP-GTC (3)
EAP-FAST/MSCHAPv2 (4)
EAP-FAST/GTC (5)
EAP-MD5 (6)
EAP-PSK (7)
EAP-SIM (8)
EAP-AKA (9)
EAP-FAST/TLS (10)
DMTF Reserved (11.. )

InstallDate

Data type: datetime
Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

LANID

Data type: string
Access type: Read-only

A label or identifier for the LAN segment to which the endpoint is connected. If the endpoint is not currently active/connected, or this information is not known, then this property will be Null. This property is inherited from CIM_LANEndpoint.

LANType

Data type: uint16
Access type: Read-only

This property is deprecated in lieu of the ProtocolType property. This property is inherited from CIM_LANEndpoint.

MACAddress

Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 12 )

The MAC address used in communication with the LAN endpoint. The MAC address is formatted as twelve hexadecimal digits (for example, "010203040506"), with each pair representing one of the six octets of the MAC address in canonical bit order according to RFC 2469. This property is inherited from CIM_LANEndpoint.

MaxDataSize

Data type: uint32
Access type: Read-only
Qualifiers: Units ("Bits")

The largest size, in number of bits, of the information field that may be sent or received by the LAN endpoint. This property is inherited from CIM_LANEndpoint.

Name

Data type: string
Access type: Read-only

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.

NameFormat

Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 256 )

Contains the naming heuristic that is selected to ensure that the value of the Name property is unique. This property is inherited from CIM_ProtocolEndpoint.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

OperationalStatus

Data type: uint16 array
Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement.

OtherAuthenticationMethod

Data type: string
Access type: Read-only

Specifies the 802.11 authentication method if and only if AuthenticationMethod contains 1 (Other). The format of this string is vendor specific.

OtherEnabledState

Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement.

OtherEncryptionMethod

Data type: string
Access type: Read-only

Specifies the 802.11 encryption method if and only if EncryptionMethod contains 1 (Other). The format of this string is vendor specific.

OtherLANType

Data type: string
Access type: Read-only

This property is deprecated in lieu of the OtherTypeDescription property. This property is inherited from CIM_LANEndpoint.

OtherTypeDescription

Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

A string that describes the type of protocol endpoint when the ProtocolIFType property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to Null when the ProtocolIFType property is any value other than 1. This property is inherited from CIM_ProtocolEndpoint.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ProtocolIFType

Data type: uint16
Access type: Read-only

The property is used to categorize and classify instances of this class. If the ProtocolIFType is set to 1 (Other), then the type information should be provided in the OtherTypeDescription property. This property is inherited from CIM_ProtocolEndpoint.

Note

ProtocolIFType is an enumeration that is synchronized with the IANA ifType MIB. Additional values defined by the DMTF are also included.

Other (1)
IEEE 802.11 (71)
IANA Reserved (225..4095)
DMTF Reserved (4301..32767)
Vendor Reserved (32768.. )

ProtocolType

Data type: uint16
Access type: Read-only

This property is deprecated in lieu of the ProtocolIFType property. This property is inherited from CIM_ProtocolEndpoint.

RequestedState

Data type: uint16
Access type: Read-only

The last requested or desired state for the management service. This property is inherited from CIM_EnabledLogicalElement.

Status

Data type: string
Access type: Read-only

Describes the status of the element. This property is inherited from CIM_ManagedSystemElement.

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

StatusDescriptions

Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName

Data type: string
Access type: Read-only

The hosting system's creation class name. This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The name of the hosting system. This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date and time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe