Msvm_VLANEndpoint class

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

class Msvm_VLANEndpoint : CIM_VLANEndpoint
{
  String   Caption;
  String   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[] = { "The service is running normally" };
  string   Status;
  uint16   HealthState = 5;
  String   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   SystemCreationClassName = "Msvm_VirtualSwitch";
  string   SystemName;
  String   CreationClassName = "Msvm_VLANEndpoint";
  String   Description;
  uint16   OperationalStatus[] = { 2 };
  uint16   EnabledState = 5;
  datetime TimeOfLastStateChange;
  String   Name;
  String   NameFormat;
  uint16   ProtocolType;
  uint16   ProtocolIFType = 1;
  String   OtherTypeDescription = "Virtual Ethernet";
  boolean  BroadcastResetSupported = False;
  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

The Msvm_VLANEndpoint class has these methods.

MethodDescription
BroadcastReset

This method is not supported.

RequestStateChange

This method is not supported.

 

Properties

The Msvm_VLANEndpoint class has these properties.

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.

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

Description
Data type: String
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ProtocolEndpoint.

DesiredEndpointMode
Data type: uint16
Access type: Write-only

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

ValueMeaning
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. (Note that the encapsulation currently in use is given by the OperationalVLANTrunkEncapsulation property.) Note that 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. Refer to the associated CIM_VLANEndpointCapabilities.doesTrunkEncapsulationNegotiation property to validate whether a particular endpoint (port) supports encapsulation negotiation. 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)
ElementName
Data type: String
Access type: Read-only

A user-friendly 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_ProtocolEndpoint and 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 is indicated in the Capabilities property, CIM_VLANEndpointCapabilities class Dot1QTagging property. This property is applicable only when the endpoint is operating in trunking mode (determined by examining the SwitchEndpointMode property). 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 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. This property is inherited from CIM_ManagedSystemElement and is not used.

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

OperationalEndpointMode
Data type: uint16
Access type: Read-only

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

ValueMeaning
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 element. This property is inherited from CIM_ProtocolEndpoint and 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). Note that 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

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.

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

ProtocolIFType
Data type: uint16
Access type: Read-only

The IANA ifType MIB. This property is inherited from CIM_ProtocolEndpoint and 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 is always set to 12 (Not Applicable).

Status
Data type: string
Access type: Read-only

The current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates whether an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

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

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

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

The endpoint mode supported by this port. This is generated dynamically.

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_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 or time when the enabled state of the element last changed. This property is inherited from CIM_ProtocolEndpoint and is not used.

Remarks

The Msvm_NetworkElementSettingData class is used to hold the association between the Msvm_VLANEndpoint and Msvm_VLANEndpointSettingData classes.

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

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_VLANEndpoint
Networking Classes

 

 

Community Additions

ADD
Show: