Export (0) Print
Expand All

Msvm_VmLANEndpoint class

Hyper-V

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

class Msvm_VmLANEndpoint : CIM_LANEndpoint
{
  string   Caption = "LAN Endpoint";
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_VmLANEndpoint";
  string   Description = "Microsoft Virtual LAN Endpoint";
  uint16   OperationalStatus[] = { 2 };
  uint16   EnabledState = 5;
  datetime TimeOfLastStateChange;
  string   Name;
  string   NameFormat;
  uint16   ProtocolType;
  string   OtherTypeDescription = "Virtual Ethernet";
  boolean  BroadcastResetSupported = False;
  string   LANID;
  uint16   LANType;
  string   OtherLANType;
  string   MACAddress;
  string   AliasAddresses[];
  string   GroupAddresses[];
  uint32   MaxDataSize = 1500;
  uint16   ProtocolIFType;
  boolean  Connected;
};

Members

The Msvm_VmLANEndpoint class has these types of members:

Methods

The Msvm_VmLANEndpoint class has these methods.

MethodDescription
BroadcastReset

This method is not supported.

RequestStateChange

This method is not supported.

 

Properties

The Msvm_VmLANEndpoint class has these properties.

AliasAddresses
Data type: string array
Access type: Read-only

Other unicast addresses that may be used. This property is inherited from CIM_LANEndpoint and is not used.

BroadcastResetSupported
Data type: boolean
Access type: Read-only

Indicates whether the instrumentation supports the BroadcastReset method. This property is inherited from CIM_ProtocolEndpoint and is always set to False.

Caption
Data type: string
Access type: Read-only

A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement and is always set to "LAN Endpoint".

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

The name of the class or the subclass used in the creation of an instance. This property is inherited from CIM_ServiceAccessPoint and is always set to "Msvm_VmLANEndpoint".

Description
Data type: string
Access type: Read-only

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

ElementName
Data type: string
Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. 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 is always set to 2 (Enabled).

EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of this element. This property is inherited from CIM_ProtocolEndpoint and is always set to 5 (Not Applicable).

GroupAddresses
Data type: string array
Access type: Read-only

The multicast addresses to which this LAN endpoint listens. This property is inherited from CIM_LANEndpoint and is not used.

HealthState
Data type: uint16
Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. This property is inherited from CIM_ManagedSystemElement and is always set to 5 (OK).

InstallDate
Data type: datetime
Access type: Read-only

The date and time when the object was installed. Lack of a value does not indicate that the object is not installed. This property is inherited from CIM_ManagedSystemElement and is not used.

LANID
Data type: string
Access type: Read-only

A label or identifier for the LAN Segment to which the Endpoint is connected. This property is inherited from CIM_LANEndpoint and is not used.

LANType
Data type: uint16
Access type: Read-only

The type of technology used on the LAN. This property is inherited from CIM_LANEndpoint and is not used.

MACAddress
Data type: string
Access type: Read-only

The principal unicast address used. This property is inherited from CIM_LANEndpoint.

MaxDataSize
Data type: uint32
Access type: Read-only

The largest information field that may be sent or received by the LANEndpoint. This property is inherited from CIM_LANEndpoint and is always set to 1500.

Name
Data type: string
Access type: Read-only

A string that identifies this protocol endpoint with either a port or an interface on a device. This property is inherited from CIM_ProtocolEndpoint.

NameFormat
Data type: string
Access type: Read-only

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

OperationalStatus
Data type: uint16 array
Access type: Read-only

The current statuses of the element. This property is inherited from CIM_ProtocolEndpoint and 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 is inherited from CIM_EnabledLogicalElement and is not used.

OtherLANType
Data type: string
Access type: Read-only

A free-form string that describes the type of technology used on the LAN when the value of the LANType property is equal to 1 (Other). This property is inherited from CIM_LANEndpoint and is not used.

OtherTypeDescription
Data type: string
Access type: Read-only

The type of protocol endpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property is inherited from CIM_ProtocolEndpoint and is always set to "Virtual Ethernet".

ProtocolIFType
Data type: uint16
Access type: Read-only

Enumeration is limited to Layer 2-related and reserved values for this subclass of protocol endpoint. 1 (Other). This property is inherited from CIM_ProtocolEndpoint.

ProtocolType
Data type: uint16
Access type: Read-only

This property is inherited from CIM_ProtocolEndpoint and is not used.

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 is always set to 12 (Not Applicable).

Status
Data type: string
Access type: Read-only

A string that specifies the current status of the object. This property is inherited from CIM_ManagedSystemElement but is not used.

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 is always set to NULL.

SystemCreationClassName
Data type: string
Access type: Read-only

The creation class name of the scoping system. This property is inherited from CIM_ServiceAccessPoint and is always set to "Msvm_ComputerSystem".

SystemName
Data type: string
Access type: Read-only

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

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_ProtocolEndpoint and is not used.

Remarks

Access to the Msvm_VmLANEndpoint class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Examples

See Querying Networking Objects.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

End of client support

None supported

End of server support

Windows Server 2012

Namespace

\\.\Root\Virtualization

MOF

WindowsVirtualization.mof

See also

CIM_LANEndpoint
Networking Classes

 

 

Community Additions

ADD
Show:
© 2014 Microsoft