Msvm_VLANEndpoint class

Article
01/07/2021

Represents the VLAN endpoint of a switch port. The configuration of this endpoint will change the way the switch port sends VLAN packets through the switch.

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_VLANEndpoint : CIM_VLANEndpoint
{
  string   InstanceID;
  String   Caption = "VLAN Endpoint";
  string   Description = "Microsoft VLAN 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 = 5;
  String   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_VirtualSwitch";
  string   SystemName;
  String   CreationClassName = "Msvm_VLANEndpoint";
  String   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType = 1;
  String   OtherTypeDescription = "Virtual Ethernet";
  uint16   DesiredEndpointMode;
  string   OtherEndpointMode;
  uint16   OperationalEndpointMode;
  uint16   DesiredVLANTrunkEncapsulation;
  string   OtherTrunkEncapsulation;
  uint16   OperationalVLANTrunkEncapsulation;
  uint16   GVRPStatus;
  uint16   SupportedEndpointModes[];
};

Members

The Msvm_VLANEndpoint class has these types of members:

Methods
Properties

Methods

The Msvm_VLANEndpoint class has these methods.

Method	Description
RequestStateChange	Requests a state change.

Properties

The Msvm_VLANEndpoint class has these properties.

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

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 it is always set to "Msvm_VLANEndpoint".

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 VLAN Endpoint".

DesiredEndpointMode

Data type: uint16
Access type: Write-only

The desired VLAN mode that is requested for use. The current mode is given by the OperationalEndpointMode property. This property is inherited from CIM_VLANEndpoint.

Value	Meaning
DMTF Reserved 0
Other 1
Access 2	Puts the endpoint/switch port into permanent nontrunking mode and negotiates to convert the link into a nontrunk link. The endpoint becomes a nontrunk interface.
Dynamic Auto 3	Makes the endpoint able to convert the link to a trunk link. The endpoint becomes a trunk interface if the neighboring interface is set to trunk or desirable mode.
Dynamic Desirable 4	Makes the endpoint actively attempt to convert the link to a trunk link. The endpoint becomes a trunk interface if the neighboring interface is set to trunk, desirable, or auto mode. The default switch-port mode for all Ethernet interfaces is dynamic desirable.
Trunk 5	Puts the endpoint into permanent trunking mode and negotiates to convert the link into a trunk link. The endpoint becomes a trunk interface even if the neighboring interface is not a trunk interface.
Dot1Q Tunnel 6	Configures the interface as a tunnel (nontrunking) endpoint/port to be connected in an asymmetric link with an 802.1Q trunk port. 802.1Q tunneling is used to maintain customer VLAN integrity across a service provider network.
DMTF Reserved 7 32767
Vendor Reserved 32768 65535

DesiredVLANTrunkEncapsulation

Data type: uint16
Access type: Read-only

The type of VLAN encapsulation that is requested for use. The encapsulation currently in use is given by the OperationalVLANTrunkEncapsulation property. This property is only applicable when the endpoint is operating in a trunking mode (see the OperationalEndpointMode property for additional details). This property is either 2 (Not Applicable) (that is, the endpoint will never be placed in a trunking mode), a particular type (802.1Q or Cisco ISL), or 5 (Negotiate) (that is, the result of the negotiation between this interface and its neighbor). The value, 5 (Negotiate) is not allowed if the endpoint does not support negotiation. This capability is hardware and vendor dependent. This property is inherited from CIM_VLANEndpoint.

DMTF Reserved (0)
Other (1)
Not Applicable (2)
802.1Q (3)
Cisco ISL (4)
Negotiate (5)
DMTF Reserved (6 32767)
Vendor Reserved (32768 65535)

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

GVRPStatus

Data type: uint16
Access type: Read-only

Indicates whether GARP VLAN Registration Protocol (GVRP) is enabled or disabled on the trunk endpoint/port. This property is 2 (Not Applicable) unless GVRP is supported by the endpoint. This property is applicable only when the endpoint is operating in trunking mode (see the OperationalEndpointMode property for additional details). This property is inherited from CIM_VLANEndpoint.

Unknown (0)
Not Applicable (2)
Enabled (3)
Disabled (4 )

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

InstallDate

Data type: datetime
Access type: Read-only

The date and time when the object was installed. This property is inherited from CIM_ManagedSystemElement, and it is not used.

InstanceID

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

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

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

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

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.

OperationalEndpointMode

Data type: uint16
Access type: Read-only

The configuration mode for the VLAN endpoint. This property is inherited from CIM_VLANEndpoint.

Value	Meaning
DMTF Reserved 0
Other 1	The endpoint is not VLAN aware.
Access 2	Puts the endpoint into permanent nontrunking mode and negotiates to convert the link into a nontrunk link. The endpoint becomes a nontrunk interface.
Dynamic Auto 3	Makes the endpoint able to convert the link to a trunk link. The endpoint becomes a trunk interface if the neighboring interface is set to trunk or desirable mode.
Dynamic Desirable 4	Makes the endpoint actively attempt to convert the link to a trunk link. The endpoint becomes a trunk interface if the neighboring interface is set to trunk, desirable, or auto mode. This is the default switch-port mode for all Ethernet interfaces.
Trunk 5	Puts the endpoint into permanent trunking mode and negotiates to convert the link into a trunk link. The endpoint becomes a trunk interface even if the neighboring interface is not a trunk interface.
Dot1Q Tunnel 6	Configures the interface as a tunnel (nontrunking) endpoint/port to be connected in an asymmetric link with an 802.1Q trunk port. 802.1Q tunneling is used to maintain customer VLAN integrity across a service provider network.
DMTF Reserved 7 32767
Vendor Reserved 32768 65535

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

OperationalVLANTrunkEncapsulation

Data type: uint16
Access type: Read-only

The type of VLAN encapsulation in use on a trunk endpoint/port. This property is either 2 (Not Applicable) (that is, the endpoint is not operating in trunking mode), a particular type (3 - 802.1Q or 4 - Cisco ISL), 5 (Negotiate) (that is, the endpoints are negotiating the encapsulation type). This property is only applicable when the endpoint is operating in a trunking mode (see the OperationalEndpointMode property for additional details). This property is inherited from CIM_VLANEndpoint.

Unknown (0)
Other (1)
Not Applicable (2)
802.1Q (3)
Cisco ISL (4)
Negotiating (5)
DMTF Reserved (6 32767)
Vendor Reserved (32768 65535)

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.

OtherEndpointMode

Data type: string
Access type: Read-only

The type of VLAN endpoint model that is supported by this VLAN endpoint, when the value of the OperationalEndpointMode property is set to 1 (Other). This property should be set to Null when the OperationalEndpointMode property is any value other than 1. This property is inherited from CIM_VLANEndpoint.

OtherTrunkEncapsulation

Data type: string
Access type: Read-only

The type of VLAN encapsulation that is supported by this VLAN endpoint, when the value of the OperationalVLANTrunkEncapsulation property is set to 1 (Other). This property should be set to Null when the desired encapsulation property is any value other than 1. This property is inherited from CIM_VLANEndpoint.

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 it is always set to "Virtual Ethernet".

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 IANA ifType MIB. This property is inherited from CIM_ProtocolEndpoint, and it is always set to 1 (Other).

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

SupportedEndpointModes

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

The endpoint modes supported by this port.

SystemCreationClassName

Data type: string
Access type: Read-only

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

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

Remarks

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

Examples

See Querying networking objects.

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