CIM_VLANEndpoint, ROOT\virtualization\v2

Class | Childs (1) | Methods (1) | Properties (35) | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

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.

CIM_VLANEndpoint - child subclasses in ROOT\virtualization\v2

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Msvm_VLANEndpoint0361----

CIM_VLANEndpoint methods

CIM_VLANEndpoint has 1 methods (1 Derived)

NameOriginReturn
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}

CIM_VLANEndpoint properties

CIM_VLANEndpoint has 35 properties (7 Local, 28 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_ServiceAccessPoint8 [string]
DescriptionCIM_ManagedElement8 [string]
DesiredEndpointModeCIM_VLANEndpoint18 [uint16]
DesiredVLANTrunkEncapsulationCIM_VLANEndpoint18 [uint16]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
GVRPStatusCIM_VLANEndpoint18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
NameFormatCIM_ProtocolEndpoint8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalEndpointModeCIM_VLANEndpoint18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OperationalVLANTrunkEncapsulationCIM_VLANEndpoint18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherEndpointModeCIM_VLANEndpoint8 [string]
OtherTrunkEncapsulationCIM_VLANEndpoint8 [string]
OtherTypeDescriptionCIM_ProtocolEndpoint8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
ProtocolIFTypeCIM_ProtocolEndpoint18 [uint16]
ProtocolTypeCIM_ProtocolEndpoint18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_ServiceAccessPoint8 [string]
key
SystemName
CIM_ServiceAccessPoint8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of CIM_VLANEndpoint methods

Derived methods (1) of CIM_VLANEndpoint class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces

Detailed description of CIM_VLANEndpoint properties

Local properties (7) of CIM_VLANEndpoint class

DesiredEndpointMode property
CIMTYPE'uint16'
Description'The 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.'
ModelCorrespondence['CIM_VLANEndpoint.OperationalEndpointMode', 'CIM_VLANEndpoint.OtherEndpointMode']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7..32767', '..']
Values['DMTF Reserved', 'Other', 'Access', 'Dynamic Auto', 'Dynamic Desirable', 'Trunk', 'Dot1Q Tunnel', 'DMTF Reserved', 'Vendor Reserved']
writeTrue
DesiredEndpointMode property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace
DesiredVLANTrunkEncapsulation property
CIMTYPE'uint16'
Description'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 '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.'
ModelCorrespondence['CIM_VLANEndpointCapabilities.SupportsTrunkEncapsulationNegotiation', 'CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation', 'CIM_VLANEndpoint.OtherTrunkEncapsulation']
ValueMap['0', '1', '2', '3', '4', '5', '6..32767', '32768..']
Values['DMTF Reserved', 'Other', 'Not Applicable', '802.1q', 'Cisco ISL', 'Negotiate', 'DMTF Reserved', 'Vendor Reserved']
writeTrue
DesiredVLANTrunkEncapsulation property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace
GVRPStatus property
CIMTYPE'uint16'
Description'Indicates 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).'
ModelCorrespondence['CIM_VLANEndpoint.OperationalEndpointMode', 'CIM_VLANEndpointCapabilities.Dot1QTagging']
ValueMap['0', '2', '3', '4']
Values['Unknown', 'Not Applicable', 'Enabled', 'Disabled']
GVRPStatus property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace
OperationalEndpointMode property
CIMTYPE'uint16'
Description'The 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.'
ModelCorrespondence['CIM_VLANEndpoint.DesiredEndpointMode', 'CIM_VLANEndpoint.OtherEndpointMode']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7..32767', '..']
Values['DMTF Reserved', 'Other', 'Access', 'Dynamic Auto', 'Dynamic Desirable', 'Trunk', 'Dot1Q Tunnel', 'DMTF Reserved', 'Vendor Reserved']
OperationalEndpointMode property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace
OperationalVLANTrunkEncapsulation property
CIMTYPE'uint16'
Description'The 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).'
ModelCorrespondence['CIM_VLANEndpoint.OtherTrunkEncapsulation', 'CIM_VLANEndpoint.DesiredVLANTrunkEncapsulation']
ValueMap['0', '1', '2', '3', '4', '5', '6..32767', '32768..']
Values['Unknown', 'Other', 'Not Applicable', '802.1q', 'Cisco ISL', 'Negotiating', 'DMTF Reserved', 'Vendor Reserved']
OperationalVLANTrunkEncapsulation property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace
OtherEndpointMode property
CIMTYPE'string'
Description'A 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.'
ModelCorrespondence['CIM_VLANEndpoint.DesiredEndpointMode', 'CIM_VLANEndpoint.OperationalEndpointMode']
writeTrue
OtherEndpointMode property is in 6 classes of ROOT\virtualization\v2 and in 1 namespace
OtherTrunkEncapsulation property
CIMTYPE'string'
Description'A 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.'
ModelCorrespondence['CIM_VLANEndpoint.DesiredVLANTrunkEncapsulation', 'CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation']
writeTrue
OtherTrunkEncapsulation property is in 2 classes of ROOT\virtualization\v2 and in 1 namespace

Derived properties (28) of CIM_VLANEndpoint class

AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
NameFormat property
CIMTYPE'string'
NameFormat property is in 22 classes of ROOT\virtualization\v2 and in 21 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
OtherTypeDescription property
CIMTYPE'string'
OtherTypeDescription property is in 9 classes of ROOT\virtualization\v2 and in 8 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ProtocolIFType property
CIMTYPE'uint16'
ProtocolIFType property is in 11 classes of ROOT\virtualization\v2 and in 7 namespaces
ProtocolType property
CIMTYPE'uint16'
ProtocolType property is in 13 classes of ROOT\virtualization\v2 and in 8 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

CIM_VLANEndpoint Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'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.'
LOCALE1033
UMLPackagePath'CIM::Network::VLAN'
Version'2.26.0'

CIM_VLANEndpoint System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_VLANEndpoint'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ProtocolEndpoint', 'CIM_ServiceAccessPoint', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT35___SYSTEM3
__RELPATH'CIM_VLANEndpoint'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ProtocolEndpoint'___SYSTEM8
__CLASS'CIM_VLANEndpoint'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_VLANEndpoint

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_VLANEndpointSettingData090---
Msvm_VLANEndpoint0361----
comments powered by Disqus
WUtils.com