Msvm_VLANEndpointSettingData class

Represents the settings for a VLAN endpoint of a switch port. The configuration of this setting 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_VLANEndpointSettingData : CIM_VLANEndpointSettingData
{
  string Caption;
  string Description;
  string ElementName;
  string InstanceID = "Microsoft:GUID\Root";
  uint16 PruneEligibleVLANList[];
  uint16 NativeVLAN;
  uint16 DefaultVLAN;
  uint16 TrunkedVLANList[];
  uint16 AccessVLAN;
};

Members

The Msvm_VLANEndpointSettingData class has these types of members:

Properties

The Msvm_VLANEndpointSettingData class has these properties.

AccessVLAN
Data type: uint16
Access type: Read/write

The access VLAN for the referenced VLANEndpoint. This property is inherited from CIM_VLANEndpointSettingData.

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.

DefaultVLAN
Data type: uint16
Access type: Read-only

The default value for the native VLAN on this trunk endpoint/port. This property is applicable only when the endpoint is operating in trunking mode (determined by examining the OperationalEndpointMode property). This property is inherited from CIM_VLANEndpointSettingData.

Description
Data type: string
Access type: Read-only

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

ElementName
Data type: string
Access type: Read/write

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. Note that the Name property of the CIM_ManagedSystemElement class is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. This property is inherited from CIM_ManagedElement.

InstanceID
Data type: string
Access type: Read-only

A unique identifier for this resource pool. This property is inherited from CIM_ResourcePool and it is always set to "Microsoft:GUID\Root".

NativeVLAN
Data type: uint16
Access type: Read/write

The VLAN Id that is used to tag untagged traffic received on this trunk endpoint/port. 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_VLANEndpointSettingData.

PruneEligibleVLANList
Data type: uint16 array
Access type: Read/write

If a VLAN ID is part of this array, then the system MAY prune that VLAN on the related trunk endpoint/port. This property is applicable only when the endpoint is operating in trunking mode (determined by examining the OperationalEndpointMode property). This property is inherited from CIM_VLANEndpointSettingData.

TrunkedVLANList
Data type: uint16 array
Access type: Read/write

If a VLAN Id is part of this array, then the system MAY trunk the traffic on the related endpoint/port. This property is applicable only when the endpoint is operating in trunking mode (determined by examining the OperationalEndpointMode property). This property is inherited from CIM_VLANEndpointSettingData.

Remarks

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

Access to the Msvm_VLANEndpointSettingData 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_VLANEndpointSettingData
Networking Classes

 

 

Community Additions

ADD
Show: