Msvm_LANEndpoint class

Article
01/07/2021

Represents the logical connection point for a network adapter. When the LAN endpoint is connected to a switch port, the network adapter connected to the LAN 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_LANEndpoint : CIM_LANEndpoint
{
  string   InstanceID;
  string   Caption = "LAN Endpoint";
  string   Description = "Microsoft Virtual LAN Endpoint";
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_LANEndpoint";
  string   NameFormat = "Microsoft Virtual Device ID";
  uint16   ProtocolType;
  uint16   ProtocolIFType;
  string   OtherTypeDescription;
  string   LANID;
  uint16   LANType;
  string   OtherLANType;
  string   MACAddress;
  string   AliasAddresses[];
  string   GroupAddresses[];
  uint32   MaxDataSize;
  boolean  Connected;
};

Members

The Msvm_LANEndpoint class has these types of members:

Methods
Properties

Methods

The Msvm_LANEndpoint class has these methods.

Method	Description
RequestStateChange	Requests a state change.

Properties

The Msvm_LANEndpoint class has these properties.

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.

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 (.. )

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "LAN Endpoint".

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 LAN 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, and it is always set to "Msvm_LANEndpoint".

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Microsoft Virtual LAN Endpoint".

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.

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, and it is always set to 5 (OK).

Value	Meaning
5	The health status is normal.

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, and it is set to "Microsoft Virtual Device ID".

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, and each array element is always set to 2 (OK).

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, and it is always set to Null.

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.

Unknown (0)
Other (1)
Regular 1822 (2)
HDH 1822 (3)
DDN X.25 (4)
RFC877 X.25 (5)
Ethernet CSMA/CD (6)
ISO 802.3 CSMA/CD (7)
ISO 802.4 Token Bus (8)
ISO 802.5 Token Ring (9)
ISO 802.6 MAN (10)
StarLAN (11)
Proteon 10Mbit (12)
Proteon 80Mbit (13)
HyperChannel (14)
FDDI (15)
LAP-B (16)
SDLC (17)
DS1 (18)
E1 (19)
Basic ISDN (20)
Primary ISDN (21)
Proprietary Point-to-Point Serial (22)
PPP (23)
Software Loopback (24)
EON (25)
Ethernet 3Mbit (26)
NSIP (27)
SLIP (28)
Ultra (29)
DS3 (30)
SIP (31)
Frame Relay (32)
RS-232 (33)
Parallel (34)
ARCNet (35)
ARCNet Plus (36)
ATM (37)
MIO X.25 (38)
SONET (39)
X.25 PLE (40)
ISO 802.211c (41)
LocalTalk (42)
SMDS DXI (43)
Frame Relay Service (44)
V.35 (45)
HSSI (46)
HIPPI (47)
Modem (48)
AAL5 (49)
SONET Path (50)
SONET VT (51)
SMDS ICIP (52)
Proprietary Virtual/Internal (53)
Proprietary Multiplexor (54)
IEEE 802.12 (55)
Fibre Channel (56)
HIPPI Interface (57)
Frame Relay Interconnect (58)
ATM Emulated LAN for 802.3 (59)
ATM Emulated LAN for 802.5 (60)
ATM Emulated Circuit (61)
Fast Ethernet (100BaseT) (62)
ISDN (63)
V.11 (64)
V.36 (65)
G703 at 64K (66)
G703 at 2Mb (67)
QLLC (68)
Fast Ethernet 100BaseFX (69)
Channel (70)
IEEE 802.11 (71)
IBM 260/370 OEMI Channel (72)
ESCON (73)
Data Link Switching (74)
ISDN S/T Interface (75)
ISDN U Interface (76)
LAP-D (77)
IP Switch (78)
Remote Source Route Bridging (79)
ATM Logical (80)
DS0 (81)
DS0 Bundle (82)
BSC (83)
Async (84)
Combat Net Radio (85)
ISO 802.5r DTR (86)
Ext Pos Loc Report System (87)
AppleTalk Remote Access Protocol (88)
Proprietary Connectionless (89)
ITU X.29 Host PAD (90)
ITU X.3 Terminal PAD (91)
Frame Relay MPI (92)
ITU X.213 (93)
ADSL (94)
RADSL (95)
SDSL (96)
VDSL (97)
ISO 802.5 CRFP (98)
Myrinet (99)
Voice Receive and Transmit (100)
Voice Foreign Exchange Office (101)
Voice Foreign Exchange Service (102)
Voice Encapsulation (103)
Voice over IP (104)
ATM DXI (105)
ATM FUNI (106)
ATM IMA (107)
PPP Multilink Bundle (108)
IP over CDLC (109)
IP over CLAW (110)
Stack to Stack (111)
Virtual IP Address (112)
MPC (113)
IP over ATM (114)
ISO 802.5j Fibre Token Ring (115)
TDLC (116)
Gigabit Ethernet (117)
HDLC (118)
LAP-F (119)
V.37 (120)
X.25 MLP (121)
X.25 Hunt Group (122)
Transp HDLC (123)
Interleave Channel (124)
FAST Channel (125)
IP (for APPN HPR in IP Networks) (126)
CATV MAC Layer (127)
CATV Downstream (128)
CATV Upstream (129)
Avalon 12MPP Switch (130)
Tunnel (131)
Coffee (132)
Circuit Emulation Service (133)
ATM SubInterface (134)
Layer 2 VLAN using 802.1Q (135)
Layer 3 VLAN using IP (136)
Layer 3 VLAN using IPX (137)
Digital Power Line (138)
Multimedia Mail over IP (139)
DTM (140)
DCN (141)
IP Forwarding (142)
MSDSL (143)
IEEE 1394 (144)
IF-GSN/HIPPI-6400 (145)
DVB-RCC MAC Layer (146)
DVB-RCC Downstream (147)
DVB-RCC Upstream (148)
ATM Virtual (149)
MPLS Tunnel (150)
SRP (151)
Voice over ATM (152)
Voice over Frame Relay (153)
ISDL (154)
Composite Link (155)
SS7 Signaling Link (156)
Proprietary P2P Wireless (157)
Frame Forward (158)
RFC1483 Multiprotocol over ATM (159)
USB (160)
IEEE 802.3ad Link Aggregate (161)
BGP Policy Accounting (162)
FRF .16 Multilink FR (163)
H.323 Gatekeeper (164)
H.323 Proxy (165)
MPLS (166)
Multi-Frequency Signaling Link (167)
HDSL-2 (168)
S-HDSL (169)
DS1 Facility Data Link (170)
Packet over SONET/SDH (171)
DVB-ASI Input (172)
DVB-ASI Output (173)
Power Line (174)
Non Facility Associated Signaling (175)
TR008 (176)
GR303 RDT (177)
GR303 IDT (178)
ISUP (179)
Proprietary Wireless MAC Layer (180)
Proprietary Wireless Downstream (181)
Proprietary Wireless Upstream (182)
HIPERLAN Type 2 (183)
Proprietary Broadband Wireless Access Point to Multipoint (184)
SONET Overhead Channel (185)
Digital Wrapper Overhead Channel (186)
ATM Adaptation Layer 2 (187)
Radio MAC (188)
ATM Radio (189)
Inter Machine Trunk (190)
MVL DSL (191)
Long Read DSL (192)
Frame Relay DLCI Endpoint (193)
ATM VCI Endpoint (194)
Optical Channel (195)
Optical Transport (196)
Proprietary ATM (197)
Voice over Cable (198)
Infiniband (199)
TE Link (200)
Q.2931 (201)
Virtual Trunk Group (202)
SIP Trunk Group (203)
SIP Signaling (204)
CATV Upstream Channel (205)
Econet (206)
FSAN 155Mb PON (207)
FSAN 622Mb PON (208)
Transparent Bridge (209)
Line Group (210)
Voice & Feature Group (211)
Voice FGD EANA (212)
Voice DID (213)
MPEG Transport (214)
6To4 (215)
GTP (216)
Paradyne EtherLoop 1 (217)
Paradyne EtherLoop 2 (218)
Optical Channel Group (219)
HomePNA (220)
GFP (221)
ciscoISLvlan (222)
actelisMetaLOOP (223)
Fcip (224)
IANA Reserved (225..4095)
IPv4 (4096)
IPv6 (4097)
IPv4/v6 (4098)
IPX (4099)
DECnet (4100)
SNA (4101)
CONP (4102)
CLNP (4103)
VINES (4104)
XNS (4105)
ISDN B Channel Endpoint (4106)
ISDN D Channel Endpoint (4107)
BGP (4108)
OSPF (4109)
UDP (4110)
TCP (4111)
802.11a (4112)
802.11b (4113)
802.11g (4114)
802.11h (4115)
NFS (4200)
CIFS (4201)
DAFS (4202)
WebDAV (4203)
HTTP (4204)
FTP (4205)
NDMP (4300)
Telnet (4400)
SSH (4401)
SM CLP (4402)
SMTP (4403)
LDAP (4404)
RDP (4405)
HTTPS (4406)
DMTF Reserved (..)
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, and it is always set to 12 (Not Applicable).

Value	Meaning
12	Not applicable.

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, and each array element is always set to "OK".

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, but it is not supported.

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, but it is not used.

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