CIM_VLANEndpointSettingData class
Represents configuration data for a VLAN endpoint.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Note
The configuration data is associated with an endpoint through the CIM_ElementSettingData class.
Syntax
[Experimental, Abstract, Version("2.11.0"), UMLPackagePath("CIM::Network::VLAN")]
class CIM_VLANEndpointSettingData : CIM_SettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 PruneEligibleVLANList[];
uint16 NativeVLAN;
uint16 DefaultVLAN;
uint16 TrunkedVLANList[];
uint16 AccessVLAN;
};
Members
The CIM_VLANEndpointSettingData class has these types of members:
Properties
The CIM_VLANEndpointSettingData class has these properties.
-
AccessVLAN
-
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode")
The access VLAN for the endpoint.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
DefaultVLAN
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode")
The default value for the native VLAN on the trunk endpoint.
Note
This property is only used when the VLAN endpoint is operating in trunking mode, which is specified in the OperationalEndpointMode property.
-
-
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-only
-
Qualifiers: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
- OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
-
-
NativeVLAN
-
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode")
The VLAN ID that is used to tag untagged traffic received on the trunk endpoint.
Note
This property is only used when the VLAN endpoint is operating in trunking mode, which is specified in the SwitchEndpointMode property.
-
-
PruneEligibleVLANList
-
-
Data type: uint16 array
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode")
An array that contains IDs of VLANs that the system may remove from the trunk endpoint.
Note
This property is only used when the VLAN endpoint is operating in trunking mode, which is specified in the OperationalEndpointMode property.
-
-
TrunkedVLANList
-
-
Data type: uint16 array
-
Access type: Read/write
-
Qualifiers: ModelCorrespondence ("CIM_VLANEndpoint.OperationalEndpointMode")
An array that contains IDs of VLAN endpoints with trunking enabled.
Note
This property is only used when the VLAN endpoint is operating in trunking mode, which is specified in the OperationalEndpointMode property.
-
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|