1 krisbash 1.1 // Copyright (c) 2010 DMTF.  All rights reserved.
  2                 [Version ( "2.26.0" ), 
  3                  UMLPackagePath ( "CIM::Network::VLAN" ), 
  4                  Description ( 
  5                     "An endpoint on a switch or endstation which is assigned to a "
  6                     "given VLAN or accepts traffic from one or more VLANs. As "
  7                     "defined by the property, OperationalEndpointMode, the endpoint "
  8                     "may be configured as trunking or nontrunking. Note that an "
  9                     "endpoint may dynamically be converted to/from a trunking mode. "
 10                     "When this occurs, simply update the OperationalEndpointMode "
 11                     "property. This class is associated with a DataLink or "
 12                     "IPProtocol Endpoint - as another aspect of that endpoint - "
 13                     "using the LogicalIdentity relationship. In this case, the "
 14                     "VLANEndpoint takes the role of SameElement." )]
 15              class CIM_VLANEndpoint : CIM_ProtocolEndpoint {
 16              
 17                    [Write, Description ( 
 18                        "The desired VLAN mode that is requested for use. (Note "
 19                        "that the current mode is given by the "
 20                        "OperationalEndpointMode property.) The following values "
 21                        "are defined: \n"
 22 krisbash 1.1           "- Access: Puts the endpoint/switch port into permanent "
 23                        "nontrunking mode and negotiates to convert the link into "
 24                        "a nontrunk link. The endpoint becomes a nontrunk "
 25                        "interface. \n"
 26                        "- Dynamic Auto: Makes the endpoint able to convert the "
 27                        "link to a trunk link. The endpoint becomes a trunk "
 28                        "interface if the neighboring interface is set to trunk "
 29                        "or desirable mode. \n"
 30                        "- Dynamic Desirable: Makes the endpoint actively attempt "
 31                        "to convert the link to a trunk link. The endpoint "
 32                        "becomes a trunk interface if the neighboring interface "
 33                        "is set to trunk, desirable, or auto mode. The default "
 34                        "switch-port mode for all Ethernet interfaces is \'dynamic "
 35                        "desirable.\' \n"
 36                        "- Trunk: Puts the endpoint into permanent trunking mode "
 37                        "and negotiates to convert the link into a trunk link. "
 38                        "The endpoint becomes a trunk interface even if the "
 39                        "neighboring interface is not a trunk interface. \n"
 40                        "- Dot1Q Tunnel: Configures the interface as a tunnel "
 41                        "(nontrunking) endpoint/port to be connected in an "
 42                        "asymmetric link with an 802.1Q trunk port. 802.1Q "
 43 krisbash 1.1           "tunneling is used to maintain customer VLAN integrity "
 44                        "across a service provider network." ), 
 45                     ValueMap { "0", "1", "2", "3", "4", "5", "6", "7..32767", ".." }, 
 46                     Values { "DMTF Reserved", "Other", "Access", "Dynamic Auto", 
 47                        "Dynamic Desirable", "Trunk", "Dot1Q Tunnel", 
 48                        "DMTF Reserved", "Vendor Reserved" }, 
 49                     ModelCorrespondence { 
 50                        "CIM_VLANEndpoint.OperationalEndpointMode", 
 51                        "CIM_VLANEndpoint.OtherEndpointMode" }]
 52                 uint16 DesiredEndpointMode;
 53              
 54                    [Write, Description ( 
 55                        "A string describing the type of VLAN endpoint model that "
 56                        "is supported by this VLANEndpoint, when the value of the "
 57                        "mode property is set to 1 (i.e., \"Other\"). This "
 58                        "property should be set to NULL when the mode property is "
 59                        "any value other than 1." ), 
 60                     ModelCorrespondence { "CIM_VLANEndpoint.DesiredEndpointMode", 
 61                        "CIM_VLANEndpoint.OperationalEndpointMode" }]
 62                 string OtherEndpointMode;
 63              
 64 krisbash 1.1       [Description ( 
 65                        "The configuration mode for the VLAN endpoint. The "
 66                        "following values are defined: /n - Unknown: If the "
 67                        "endpoint is not VLAN aware. /n - Access: Puts the "
 68                        "endpoint into permanent nontrunking mode and negotiates "
 69                        "to convert the link into a nontrunk link. The endpoint "
 70                        "becomes a nontrunk interface. \n"
 71                        "- Dynamic Auto: Makes the endpoint able to convert the "
 72                        "link to a trunk link. The endpoint becomes a trunk "
 73                        "interface if the neighboring interface is set to trunk "
 74                        "or desirable mode. \n"
 75                        "- Dynamic Desirable: Makes the endpoint actively attempt "
 76                        "to convert the link to a trunk link. The endpoint "
 77                        "becomes a trunk interface if the neighboring interface "
 78                        "is set to trunk, desirable, or auto mode. The default "
 79                        "switch-port mode for all Ethernet interfaces is \'dynamic "
 80                        "desirable.\' \n"
 81                        "- Trunk: Puts the endpoint into permanent trunking mode "
 82                        "and negotiates to convert the link into a trunk link. "
 83                        "The endpoint becomes a trunk interface even if the "
 84                        "neighboring interface is not a trunk interface. \n"
 85 krisbash 1.1           "- Dot1Q Tunnel: Configures the interface as a tunnel "
 86                        "(nontrunking) endpoint/port to be connected in an "
 87                        "asymmetric link with an 802.1Q trunk port. 802.1Q "
 88                        "tunneling is used to maintain customer VLAN integrity "
 89                        "across a service provider network." ), 
 90                     ValueMap { "0", "1", "2", "3", "4", "5", "6", "7..32767", ".." }, 
 91                     Values { "DMTF Reserved", "Other", "Access", "Dynamic Auto", 
 92                        "Dynamic Desirable", "Trunk", "Dot1Q Tunnel", 
 93                        "DMTF Reserved", "Vendor Reserved" }, 
 94                     ModelCorrespondence { "CIM_VLANEndpoint.DesiredEndpointMode", 
 95                        "CIM_VLANEndpoint.OtherEndpointMode" }]
 96                 uint16 OperationalEndpointMode;
 97              
 98                    [Write, Description ( 
 99                        "The type of VLAN encapsulation that is requested for "
100                        "use. (Note that the encapsulation currently in use is "
101                        "given by the OperationalVLANTrunkEncapsulation "
102                        "property.) Note that this property is only applicable "
103                        "when the endpoint is operating in a trunking mode (see "
104                        "the OperationalEndpointMode property for additional "
105                        "details). This property is either \'not applicable\' "
106 krisbash 1.1           "(i.e., the endpoint will never be placed in a trunking "
107                        "mode), a particular type (802.1q or Cisco ISL), or "
108                        "\'negotiate\' (i.e., the result of the negotiation "
109                        "between this interface and its neighbor). The value, "
110                        "\'Negotiate\' is not allowed if the endpoint does not "
111                        "support negotiation. This capability is hardware and "
112                        "vendor dependent. Refer to the associated "
113                        "VLANEndpointCapabilities.doesTrunkEncapsulationNegotiation "
114                        "property to validate whether a particular endpoint "
115                        "(port) supports encapsulation negotiation." ), 
116                     ValueMap { "0", "1", "2", "3", "4", "5", "6..32767", "32768.." }, 
117                     Values { "DMTF Reserved", "Other", "Not Applicable", 
118                        "802.1q", "Cisco ISL", "Negotiate", "DMTF Reserved", 
119                        "Vendor Reserved" }, 
120                     ModelCorrespondence { 
121                        "CIM_VLANEndpointCapabilities.SupportsTrunkEncapsulationNegotiation", 
122                        "CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation", 
123                        "CIM_VLANEndpoint.OtherTrunkEncapsulation" }]
124                 uint16 DesiredVLANTrunkEncapsulation;
125              
126                    [Write, Description ( 
127 krisbash 1.1           "A string describing the type of VLAN encapsulation that "
128                        "is supported by this VLANEndpoint, when the value of the "
129                        "encapsulation property is set to 1 (i.e., \"Other\"). "
130                        "This property should be set to NULL when the desired "
131                        "encapsulation property is any value other than 1." ), 
132                     ModelCorrespondence { 
133                        "CIM_VLANEndpoint.DesiredVLANTrunkEncapsulation", 
134                        "CIM_VLANEndpoint.OperationalVLANTrunkEncapsulation" }]
135                 string OtherTrunkEncapsulation;
136              
137                    [Description ( 
138                        "The type of VLAN encapsulation in use on a trunk "
139                        "endpoint/port. This property is either \'not applicable\' "
140                        "(i.e., the endpoint is not operating in trunking mode), "
141                        "a particular type (802.1q or Cisco ISL), \'negotiating\' "
142                        "(i.e., the endpoints are negotiating the encapsulation "
143                        "type). Note that this property is only applicable when "
144                        "the endpoint is operating in a trunking mode (see the "
145                        "OperationalEndpointMode property for additional "
146                        "details)." ), 
147                     ValueMap { "0", "1", "2", "3", "4", "5", "6..32767", "32768.." }, 
148 krisbash 1.1        Values { "Unknown", "Other", "Not Applicable", "802.1q", 
149                        "Cisco ISL", "Negotiating", "DMTF Reserved", 
150                        "Vendor Reserved" }, 
151                     ModelCorrespondence { 
152                        "CIM_VLANEndpoint.OtherTrunkEncapsulation", 
153                        "CIM_VLANEndpoint.DesiredVLANTrunkEncapsulation" }]
154                 uint16 OperationalVLANTrunkEncapsulation;
155              
156                    [Description ( 
157                        "Indicates whether GARP VLAN Registration Protocol (GVRP) "
158                        "is enabled or disabled on the trunk endpoint/port. This "
159                        "property is \'not applicable\' unless GVRP is supported "
160                        "by the endpoint. This is indicated in the Capabilities "
161                        "property, VLANEndpointCapabilities.Dot1QTagging. This "
162                        "property is applicable only when the endpoint is "
163                        "operating in trunking mode (determined by examining the "
164                        "SwitchEndpointMode property)." ), 
165                     ValueMap { "0", "2", "3", "4" }, 
166                     Values { "Unknown", "Not Applicable", "Enabled", "Disabled" }, 
167                     ModelCorrespondence { 
168                        "CIM_VLANEndpoint.OperationalEndpointMode", 
169 krisbash 1.1           "CIM_VLANEndpointCapabilities.Dot1QTagging" }]
170                 uint16 GVRPStatus;
171              
172              
173              };