Msvm_SwitchLANEndpoint class

  • Article

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_SwitchLANEndpoint : CIM_LANEndpoint
{
  string   Caption = "LAN Endpoint";
  string   ElementName;
  datetime InstallDate;
  string   Status;
  uint16   HealthState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_SwitchLANEndpoint";
  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;
  string   StatusDescriptions[] = { "OK" };
  uint16   EnabledDefault = 2;
  boolean  Connected;
};

Members

The Msvm_SwitchLANEndpoint class has these types of members:

Methods

The Msvm_SwitchLANEndpoint class has these methods.

Method Description
BroadcastReset This method is not supported.
RequestStateChange This method is not supported.

Properties

The Msvm_SwitchLANEndpoint class has these properties.

AliasAddresses

Data type: string array

Access type: Read-only

Qualifiers:

Other unicast addresses that may be used to communicate with the LANEndpoint. This property is inherited from CIM_LANEndpoint and is not used.

BroadcastResetSupported

Data type: boolean

Access type: Read-only

Qualifiers: Experimental, MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_PORT_CONFIG_CAPS_T.PortForceLipSupported"), ModelCorrespondence ("CIM_ProtocolEndpoint.BroadcastReset")

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

Qualifiers: MaxLen (64)

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

Qualifiers: Key, MaxLen (256)

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_SwitchLANEndpoint".

Description

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifDescr")

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/write

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

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")

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

Not Applicable (5)

The element does not support being enabled or disabled.

GroupAddresses

Data type: string array

Access type: Read-only

Qualifiers:

The multicast addresses to which the LANEndpoint 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).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

A datetime value that indicates 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

Qualifiers: ModelCorrespondence ("CIM_LANConnectivitySegment.LANID, CIM_LANSegment.LANID")

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

Qualifiers: Deprecated ("CIM_LANEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_LANConnectivitySegment.ConnectivityType, CIM_LANSegment.LANType")

An indication of the kind 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

Qualifiers: MaxLen (12)

The principal unicast address used in communication with the LANEndpoint. This property is inherited from CIM_LANEndpoint.

MaxDataSize

Data type: uint32

Access type: Read-only

Qualifiers: Units ("Bits")

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

Qualifiers: MaxLen (256)

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

Qualifiers: MaxLen (256)

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

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifOperStatus")

The current statuses of the element. This property is inherited from CIM_ProtocolEndpoint and is always set to 2 (OK).

OK (2)

Full functionality without errors.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.OtherTypeDescription"), ModelCorrespondence ("CIM_LANConnectivitySegment.OtherTypeDescription", "CIM_LANEndpoint.LANType")

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

Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")

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

Qualifiers:

Limited to Layer 2-related and reserved values for this subclass of CIM_ProtocolEndpoint. This property is inherited from CIM_ProtocolEndpoint.

Other (1)

Ethernet CSMA/CD (6)

ISO 802.5 Token Ring (9)

FDDI (15)

IANA Reserved (225..4095)

DMTF Reserved (4301..32767)

Vendor Reserved (32768..)

ProtocolType

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

This property is inherited from CIM_ProtocolEndpoint and is not used.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Status

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and is always set to "OK".

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

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

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

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

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifLastChange")

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_SwitchLANEndpoint 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 R2
Namespace
 Root\Virtualization
MOF
WindowsVirtualization.mof

See also

CIM_LANEndpoint

CIM_LANEndpoint

Networking Classes