Class CIM_VLANEndpoint
extends CIM_ProtocolEndpoint

An endpoint on a switch or endstation which is assigned to a given VLAN or accepts traffic from one or more VLANs. As defined by the property, OperationalEndpointMode, the endpoint may be configured as trunking or nontrunking. Note that an endpoint may dynamically be converted to/from a trunking mode. When this occurs, simply update the OperationalEndpointMode property. This class is associated with a DataLink or IPProtocol Endpoint - as another aspect of that endpoint - using the LogicalIdentity relationship. In this case, the VLANEndpoint takes the role of SameElement.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_ServiceAccessPoint
   |
   +--CIM_ProtocolEndpoint
   |
   +--CIM_VLANEndpoint

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringAn endpoint on a switch or endstation which is assigned to a given VLAN or accepts traffic from one or more VLANs. As defined by the property, OperationalEndpointMode, the endpoint may be configured as trunking or nontrunking. Note that an endpoint may dynamically be converted to/from a trunking mode. When this occurs, simply update the OperationalEndpointMode property. This class is associated with a DataLink or IPProtocol Endpoint - as another aspect of that endpoint - using the LogicalIdentity relationship. In this case, the VLANEndpoint takes the role of SameElement.
UMLPackagePathstringCIM::Network::VLAN
Versionstring2.26.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
DesiredEndpointModeuint16
DescriptionstringThe desired VLAN mode that is requested for use. (Note that the current mode is given by the OperationalEndpointMode property.) The following values are defined: - Access: 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: 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: 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: 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: 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.
ModelCorrespondencestringCIM_VLANEndpoint.OperationalEndpointMode, CIM_VLANEndpoint.OtherEndpointMode
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, ..
ValuesstringDMTF Reserved, Other, Access, Dynamic Auto, Dynamic Desirable, Trunk, Dot1Q Tunnel, DMTF Reserved, Vendor Reserved
Writebooleantrue
DesiredVLANTrunkEncapsulationuint16
DescriptionstringThe 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 'not applicable' (i.e., the endpoint will never be placed in a trunking mode), a particular type (802.1q or Cisco ISL), or 'negotiate' (i.e., the result of the negotiation between this interface and its neighbor). The value, 'Negotiate' is not allowed if the endpoint does not support negotiation. This capability is hardware and vendor dependent. Refer to the associated VLANEndpointCapabilities.doesTrunkEncapsulationNegotiation property to validate whether a particular endpoint (port) supports encapsulation negotiation.
ModelCorrespondencestringCIM_VLANEndpointCapabilities.SupportsTrunkEncapsulationNegotiation, CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation, CIM_VLANEndpoint.OtherTrunkEncapsulation
ValueMapstring0, 1, 2, 3, 4, 5, 6..32767, 32768..
ValuesstringDMTF Reserved, Other, Not Applicable, 802.1q, Cisco ISL, Negotiate, DMTF Reserved, Vendor Reserved
Writebooleantrue
GVRPStatusuint16
DescriptionstringIndicates whether GARP VLAN Registration Protocol (GVRP) is enabled or disabled on the trunk endpoint/port. This property is 'not applicable' unless GVRP is supported by the endpoint. This is indicated in the Capabilities property, VLANEndpointCapabilities.Dot1QTagging. This property is applicable only when the endpoint is operating in trunking mode (determined by examining the SwitchEndpointMode property).
ModelCorrespondencestringCIM_VLANEndpoint.OperationalEndpointMode, CIM_VLANEndpointCapabilities.Dot1QTagging
ValueMapstring0, 2, 3, 4
ValuesstringUnknown, Not Applicable, Enabled, Disabled
OperationalEndpointModeuint16
DescriptionstringThe configuration mode for the VLAN endpoint. The following values are defined: /n - Unknown: If the endpoint is not VLAN aware. /n - Access: 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: 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: 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: 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: 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.
ModelCorrespondencestringCIM_VLANEndpoint.DesiredEndpointMode, CIM_VLANEndpoint.OtherEndpointMode
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, ..
ValuesstringDMTF Reserved, Other, Access, Dynamic Auto, Dynamic Desirable, Trunk, Dot1Q Tunnel, DMTF Reserved, Vendor Reserved
OperationalVLANTrunkEncapsulationuint16
DescriptionstringThe type of VLAN encapsulation in use on a trunk endpoint/port. This property is either 'not applicable' (i.e., the endpoint is not operating in trunking mode), a particular type (802.1q or Cisco ISL), 'negotiating' (i.e., 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).
ModelCorrespondencestringCIM_VLANEndpoint.OtherTrunkEncapsulation, CIM_VLANEndpoint.DesiredVLANTrunkEncapsulation
ValueMapstring0, 1, 2, 3, 4, 5, 6..32767, 32768..
ValuesstringUnknown, Other, Not Applicable, 802.1q, Cisco ISL, Negotiating, DMTF Reserved, Vendor Reserved
OtherEndpointModestring
DescriptionstringA string describing the type of VLAN endpoint model that is supported by this VLANEndpoint, when the value of the mode property is set to 1 (i.e., "Other"). This property should be set to NULL when the mode property is any value other than 1.
ModelCorrespondencestringCIM_VLANEndpoint.DesiredEndpointMode, CIM_VLANEndpoint.OperationalEndpointMode
Writebooleantrue
OtherTrunkEncapsulationstring
DescriptionstringA string describing the type of VLAN encapsulation that is supported by this VLANEndpoint, when the value of the encapsulation property is set to 1 (i.e., "Other"). This property should be set to NULL when the desired encapsulation property is any value other than 1.
ModelCorrespondencestringCIM_VLANEndpoint.DesiredVLANTrunkEncapsulation, CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation
Writebooleantrue

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_ServiceAccessPoint
DescriptionstringCIM_ProtocolEndpoint
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_ProtocolEndpoint
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_ProtocolEndpoint
NameFormatstringCIM_ProtocolEndpoint
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherTypeDescriptionstringCIM_ProtocolEndpoint
PrimaryStatusuint16CIM_ManagedSystemElement
ProtocolIFTypeuint16CIM_ProtocolEndpoint
ProtocolTypeuint16CIM_ProtocolEndpoint
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_ServiceAccessPoint
SystemNamestringCIM_ServiceAccessPoint
TimeOfLastStateChangedatetimeCIM_ProtocolEndpoint
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ProtocolEndpoint
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement