1 karl 1.1 // ===================================================================
2 // Title: Network Filtering 2.7
3 // Filename: Network27_Filtering.mof
4 // Version: 2.7.0
5 // Status: Preliminary
6 // Date: 07/31/2002
7 // ===================================================================
8 // Copyright 1998-2002 Distributed Management Task Force, Inc. (DMTF).
9 // All rights reserved.
10 // DMTF is a not-for-profit association of industry members dedicated
11 // to promoting enterprise and systems management and interoperability.
12 // DMTF specifications and documents may be reproduced for uses
13 // consistent with this purpose by members and non-members,
14 // provided that correct attribution is given.
15 // As DMTF specifications may be revised from time to time,
16 // the particular version and release date should always be noted.
17 //
18 // Implementation of certain elements of this standard or proposed
19 // standard may be subject to third party patent rights, including
20 // provisional patent rights (herein "patent rights"). DMTF makes
21 // no representations to users of the standard as to the existence
22 karl 1.1 // of such rights, and is not responsible to recognize, disclose, or
23 // identify any or all such third party patent right, owners or
24 // claimants, nor for any incomplete or inaccurate identification or
25 // disclosure of such rights, owners or claimants. DMTF shall have no
26 // liability to any party, in any manner or circumstance, under any
27 // legal theory whatsoever, for failure to recognize, disclose, or
28 // identify any such third party patent rights, or for such party's
29 // reliance on the standard or incorporation thereof in its product,
30 // protocols or testing procedures. DMTF shall have no liability to
31 // any party implementing such standard, whether such implementation
32 // is foreseeable or not, nor to any patent owner or claimant, and shall
33 // have no liability or responsibility for costs or losses incurred if
34 // a standard is withdrawn or modified after publication, and shall be
35 // indemnified and held harmless by any party implementing the
36 // standard from any and all claims of infringement by a patent owner
37 // for such implementations.
38 //
39 // For information about patents held by third-parties which have
40 // notified the DMTF that, in their opinion, such patent may relate to
41 // or impact implementations of DMTF standards, visit
42 // http://www.dmtf.org/about/policies/disclosures.php.
43 karl 1.1 // ===================================================================
44 // Description: The Network Model extends the management concepts to
45 // represent protocol interfaces and network/protocol
46 // services. This file defines filtering - filter lists
47 // and filter entries.
48 //
49 // The object classes below are listed in an order that
50 // avoids forward references. Required objects, defined
51 // by other working groups, are omitted.
52 // ==================================================================
53 // Change Log for v2.7
54 // CR793 - Add the Abstract qualifier to FilterEntryBase and update
55 // the description
56 // - Update the description for EntriesInFilterList.EntrySequence
57 // - Deprecate FilterEntriesInSystem and FilterListInSystem
58 // - Add HostedFilterEntryBase and HostedFilterList
59 // - Add 8021Filter and PreambleFilter
60 // - FilterEntry.TrafficType needs an Other value in its
61 // enumerated list, and an OtherTrafficType property should be
62 // defined
63 // CR800 - Remove FilterEntry.TrafficClass' ModelCorrespondence
64 karl 1.1 // CR849 - 8021Filter property names must be changed from 8021HdrXXX to
65 // HdrXXX8021 to comply with the CIM Spec
66 // CR867 - Add Override qualifier to FilterEntryBase and
67 // FilterList.Name
68 // ===================================================================
69
70 #pragma Locale ("en_US")
71
72
73 // ===================================================================
74 // FilterEntryBase
75 // ===================================================================
76 [Abstract, Version ("2.7.0"), Description (
77 "A FilterList aggregates instances of (subclasses of) "
78 "FilterEntryBase via the aggregation EntriesInFilterList. "
79 "The filter entries are always ANDed together when grouped "
80 "by the FilterList. Note that it is possible to aggregate "
81 "different types of filters into a single FilterList - "
82 "for example, packet header filters (represented by the "
83 "IpHeadersFilter class) and IPsec security filters. \n"
84 "\n"
85 karl 1.1 "A FilterList is weak to the network device (e.g., the "
86 "ComputerSystem) that contains it. Hence, the ComputerSystem "
87 "keys are propagated to this class.") ]
88 class CIM_FilterEntryBase : CIM_LogicalElement {
89
90 [Propagated ("CIM_ComputerSystem.CreationClassName"), Key,
91 MaxLen (256),
92 Description (
93 "The scoping ComputerSystem's CreationClassName.") ]
94 string SystemCreationClassName;
95
96 [Propagated ("CIM_ComputerSystem.Name"), Key, MaxLen (256),
97 Description (
98 "The scoping ComputerSystem's Name.") ]
99 string SystemName;
100
101 [Key, MaxLen (256),
102 Description (
103 "CreationClassName indicates the name of the class or the "
104 "subclass used in the creation of an instance. When used "
105 "with the other key properties of this class, this property "
106 karl 1.1 "allows all instances of this class and its subclasses to "
107 "be uniquely identified.") ]
108 string CreationClassName;
109
110 [Override ("Name"), Key, MaxLen (256),
111 Description (
112 "The Name property defines the label by which the Filter"
113 "Entry is known and uniquely identified.") ]
114 string Name;
115
116 [Description (
117 "Boolean indicating that the match condition described "
118 "in the properties of the FilterEntryBase subclass "
119 "should be negated.") ]
120 boolean IsNegated;
121 };
122
123
124 // ==================================================================
125 // FilterEntry
126 // ==================================================================
127 karl 1.1 [Version ("2.7.0"), Description (
128 "A FilterEntry is used by network devices to identify "
129 "traffic and either forward it (with possibly further "
130 "processing) to its destination, or to deny its "
131 "forwarding. It is one of the building block of "
132 "FilterLists. \n"
133 "\n"
134 "This class is oriented towards packet filtering. Other "
135 "subclasses of FilterEntryBase can be defined to do other "
136 "types of filtering. \n"
137 "\n"
138 "A FilterEntry is weak to the network device (i.e., the "
139 "ComputerSystem) that contains it. Hence, the ComputerSystem "
140 "keys are propagated to this class.") ]
141 class CIM_FilterEntry : CIM_FilterEntryBase {
142
143 [Description (
144 "This defines the type of traffic that is being filtered. "
145 "This will affect the filtering rules in the MatchCondition "
146 "property of this class."),
147 ValueMap {"0", "1", "2", "3", "4", "5"},
148 karl 1.1 Values {"Unknown", "IPv4", "IPX", "IPv6", "Any", "Other"},
149 ModelCorrespondence {"CIM_FilterEntry.OtherTrafficType"} ]
150 uint16 TrafficType;
151
152 [Description (
153 "If the value of the TrafficType property in this "
154 "class is 5 (i.e., \"Other\"), then the specific type of "
155 "traffic is specified in this property."),
156 ModelCorrespondence {"CIM_FilterEntry.TrafficType"} ]
157 string OtherTrafficType;
158
159 [Description (
160 "This specifies one of a set of ways to identify traffic. "
161 "If the value is 1 (i.e., \"Other\"), then the specific "
162 "type of filtering is specified in the "
163 "OtherMatchConditionType property of this class."),
164 ValueMap {"1", "2", "3", "4", "5", "6", "7", "8", "9",
165 "10", "11", "12", "13"},
166 Values {"Other", "Source Address and Mask",
167 "Destination Address and Mask", "Source Port",
168 "Source Port Range", "Destination Port",
169 karl 1.1 "Destination Port Range", "Protocol Type",
170 "Protocol Type and Option", "DSCP", "ToS Value",
171 "802.1P Priority Value", "Any"},
172 ModelCorrespondence {
173 "CIM_FilterEntry.OtherMatchConditionType"} ]
174 uint16 MatchConditionType;
175
176 [Description (
177 "If the value of the MatchConditionType property in this "
178 "class is 1 (i.e., \"Other\"), then the specific type of "
179 "filtering is specified in this property."),
180 ModelCorrespondence {
181 "CIM_FilterEntry.MatchConditionType"} ]
182 string OtherMatchConditionType;
183
184 [Description (
185 "This is the value of the condition that filters the "
186 "traffic. It corresponds to the condition specified in the "
187 "MatchConditionType property. If, however, the value of the "
188 "MatchConditionProperty is 1, then it corresponds to the "
189 "condition specified in the OtherMatchConditionType "
190 karl 1.1 "property.") ]
191 string MatchConditionValue;
192
193 [Description (
194 "This defines whether the action should be to forward or "
195 "deny traffic meeting the match condition specified in "
196 "this filter."),
197 ValueMap {"1", "2"},
198 Values {"Permit", "Deny"} ]
199 uint16 Action;
200
201 [Description (
202 "This defines whether this FilterEntry is the default "
203 "entry to use by its FilterList.") ]
204 boolean DefaultFilter;
205
206 [Description (
207 "This defines the traffic class that is being matched by "
208 "this FilterEntry. Note that FilterEntries are aggregated "
209 "into FilterLists by the EntriesInFilterList "
210 "relationship. If the EntrySequence property of the "
211 karl 1.1 "aggregation is set to 0, this means that all the Filter"
212 "Entries should be ANDed together. Consequently, the "
213 "TrafficClass property of each of the aggregated Entries "
214 "should be set to the same value.") ]
215 string TrafficClass;
216 };
217
218
219 // ===================================================================
220 // IPHeadersFilter
221 // ===================================================================
222 [Version ("2.6.0"), Description (
223 "IPHeadersFilter contains the most commonly "
224 "required properties for performing filtering on IP, TCP or "
225 "UDP headers. Properties not present in an instance of the "
226 "IPHeadersFilter are treated as 'all values'.") ]
227 class CIM_IPHeadersFilter : CIM_FilterEntryBase {
228
229 [Description (
230 "HdrIPVersion identifies the version of the IP "
231 "addresses for IP header filters. It is also used to "
232 karl 1.1 "determine the sizes of the OctetStrings in the six "
233 "properties HdrSrcAddress, HdrSrcAddressEndOfRange, "
234 "HdrSrcMask, HdrDestAddress, HdrDestAddressEndOfRange "
235 "and HdrDestMask, as follows: \n"
236 "ipv4(4): OctetString(SIZE (4)) \n"
237 "ipv6(6): OctetString(SIZE (16|20)), \n"
238 "depending on whether a scope identifier is present. \n"
239 "\n"
240 "If a value for this property is not provided, then the "
241 "filter does not consider IP version in selecting matching "
242 "packets, i.e., IP version matches for all values. In this "
243 "case, the HdrSrcAddress, HdrSrcAddressEndOfRange, "
244 "HdrSrcMask, HdrDestAddress, HdrDestAddressEndOfRange and "
245 "HdrDestMask must also be not present."),
246 ValueMap {"4", "6"},
247 Values {"IPv4", "IPv6"},
248 ModelCorrespondence {"CIM_IPHeadersFilter.HdrSrcAddress",
249 "CIM_IPHeadersFilter.HdrSrcAddressEndOfRange",
250 "CIM_IPHeadersFilter.HdrSrcMask",
251 "CIM_IPHeadersFilter.HdrDestAddress",
252 "CIM_IPHeadersFilter.HdrDestAddressEndOfRange",
253 karl 1.1 "CIM_IPHeadersFilter.HdrDestMask"} ]
254 uint8 HdrIPVersion;
255
256 [OctetString, Description (
257 "HdrSrcAddress is an OctetString, of a size "
258 "determined by the value of the HdrIPVersion property, "
259 "representing a source IP address. When there is no "
260 "HdrSrcAddressEndOfRange value, this value is compared to "
261 "the source address in the IP header, subject to the mask "
262 "represented in the HdrSrcMask property. (Note that the "
263 "mask is ANDed with the address.) When there is a "
264 "HdrSrcAddressEndOfRange value, this value is the start of "
265 "the specified range (i.e., the HdrSrcAddress is lower than "
266 "the HdrSrcAddressEndOfRange) that is compared to the source "
267 "address in the IP header and matches on any value in the "
268 "range. \n"
269 "\n"
270 "If a value for this property is not provided, then the "
271 "filter does not consider HdrSrcAddress in selecting "
272 "matching packets, i.e., HdrSrcAddress matches for all "
273 "values."),
274 karl 1.1 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
275 uint8 HdrSrcAddress[];
276
277 [OctetString, Description (
278 "HdrSrcAddressEndOfRange is an OctetString, of "
279 "a size determined by the value of the HdrIPVersion property, "
280 "representing the end of a range of source IP addresses "
281 "(inclusive), where the start of the range is the "
282 "HdrSrcAddress property value. \n"
283 "\n"
284 "If a value for HdrSrcAddress is not provided, then this "
285 "property also MUST NOT be provided. If a value for this "
286 "property is provided, then HdrSrcMask MUST NOT be provided."),
287 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
288 uint8 HdrSrcAddressEndOfRange[];
289
290 [OctetString, Description (
291 "HdrSrcMask is an OctetString, of a size "
292 "determined by the value of the HdrIPVersion property, "
293 "representing a mask to be used in comparing the source "
294 "address in the IP header with the value represented in "
295 karl 1.1 "the HdrSrcAddress property. \n"
296 "\n"
297 "If a value for this property is not provided, then the "
298 "filter does not consider HdrSrcMask in selecting "
299 "matching packets, i.e., the value of the HdrSrcAddress or "
300 "the source address range must match the source address "
301 "in the packet exactly. If a value for this "
302 "property is provided, then HdrSrcAddressEndOfRange "
303 "MUST NOT be provided."),
304 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
305 uint8 HdrSrcMask[];
306
307 [OctetString, Description (
308 "HdrDestAddress is an OctetString, of a size "
309 "determined by the value of the HdrIPVersion property, "
310 "representing a destination IP address. When there is no "
311 "HdrDestAddressEndOfRange value, this value is compared to "
312 "the destination address in the IP header, subject to the "
313 "mask represented in the HdrDestMask property. (Note that "
314 "the mask is ANDed with the address.) When there is a "
315 "HdrDestAddressEndOfRange value, this value is the start of "
316 karl 1.1 "the specified range (i.e., the HdrDestAddress is lower than "
317 "the HdrDestAddressEndOfRange) that is compared to the source "
318 "address in the IP header and matches on any value in the "
319 "range. \n"
320 "\n"
321 "If a value for this property is not provided, then the "
322 "filter does not consider HdrDestAddress in selecting "
323 "matching packets, i.e., HdrDestAddress matches for all "
324 "values."),
325 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
326 uint8 HdrDestAddress[];
327
328 [OctetString, Description (
329 "HdrDestAddressEndOfRange is an OctetString, of "
330 "a size determined by the value of the HdrIPVersion property, "
331 "representing the end of a range of destination IP addresses "
332 "(inclusive), where the start of the range is the "
333 "HdrDestAddress property value. \n"
334 "\n"
335 "If a value for HdrDestAddress is not provided, then this "
336 "property also MUST NOT be provided. If a value for this "
337 karl 1.1 "property is provided, then HdrDestMask MUST NOT be provided."),
338 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
339 uint8 HdrDestAddressEndOfRange[];
340
341 [OctetString, Description (
342 "HdrDestMask is an OctetString, of a size "
343 "determined by the value of the HdrIPVersion property, "
344 "representing a mask to be used in comparing the destination "
345 "address in the IP header with the value represented in the "
346 "HdrDestAddress property. \n"
347 "\n"
348 "If a value for this property is not provided, then the "
349 "filter does not consider HdrDestMask in selecting "
350 "matching packets, i.e., the value of the HdrDestAddress or "
351 "the destination address range must match the destination "
352 "address in the packet exactly. If a value for this "
353 "property is provided, then HdrDestAddressEndOfRange "
354 "MUST NOT be provided."),
355 ModelCorrespondence {"CIM_IPHeadersFilter.HdrIPVersion"} ]
356 uint8 HdrDestMask[];
357
358 karl 1.1 [Description (
359 "HdrProtocolID is an 8-bit unsigned integer, "
360 "representing an IP protocol type. This value is compared "
361 "to the Protocol field in the IP header. \n"
362 "\n"
363 "If a value for this property is not provided, then the "
364 "filter does not consider HdrProtocolID in selecting "
365 "matching packets, i.e., HdrProtocolID matches for all "
366 "values.") ]
367 uint8 HdrProtocolID;
368
369 [Description (
370 "HdrSrcPortStart represents the lower end of "
371 "a range of UDP or TCP source ports. The upper end of the "
372 "range is represented by the HdrSrcPortEnd property. "
373 "The value of HdrSrcPortStart MUST be no greater than the "
374 "value of HdrSrcPortEnd. \n"
375 "\n"
376 "A source port filter is evaluated by testing whether the "
377 "source port identified in the IP header falls within the "
378 "range of values between HdrSrcPortStart and HdrSrcPortEnd, "
379 karl 1.1 "INCLUDING these two end points. \n"
380 "\n"
381 "If a value for this property is not provided, then the "
382 "filter does not consider HdrSrcPortStart in selecting "
383 "matching packets, i.e., there is no lower bound in "
384 "matching source port values.") ]
385 uint16 HdrSrcPortStart;
386
387 [Description (
388 "HdrSrcPortEnd represents the upper end of a "
389 "range of UDP or TCP source ports. The lower end of the "
390 "range is represented by the HdrSrcPortStart property. The "
391 "value of HdrSrcPortEnd MUST be no less than the value of "
392 "HdrSrcPortStart. A single port is indicated by equal values "
393 "for HdrSrcPortStart and HdrSrcPortEnd. \n"
394 "\n"
395 "A source port filter is evaluated by testing whether the "
396 "source port identified in the IP header falls within the "
397 "range of values between HdrSrcPortStart and HdrSrcPortEnd, "
398 "INCLUDING these two end points. \n"
399 "\n"
400 karl 1.1 "If a value for this property is not provided, then the "
401 "filter does not consider HdrSrcPortEnd in selecting "
402 "matching packets, i.e., there is no upper bound in "
403 "matching source port values.") ]
404 uint16 HdrSrcPortEnd;
405
406 [Description (
407 "HdrDestPortStart represents the lower end of "
408 "a range of UDP or TCP destination ports. The upper end of "
409 "the range is represented by the HdrDestPortEnd property. "
410 "The value of HdrDestPortStart MUST be no greater than the "
411 "value of HdrDestPortEnd. A single port is indicated by "
412 "equal values for HdrDestPortStart and HdrDestPortEnd. \n"
413 "\n"
414 "A destination port filter is evaluated by testing whether "
415 "the destination port identified in the IP header falls "
416 "within the range of values between HdrDestPortStart and "
417 "HdrDestPortEnd, INCLUDING these two end points. \n"
418 "\n"
419 "If a value for this property is not provided, then the "
420 "filter does not consider HdrDestPortStart in selecting "
421 karl 1.1 "matching packets, i.e., there is no lower bound in "
422 "matching destination port values.") ]
423 uint16 HdrDestPortStart;
424
425 [Description (
426 "HdrDestPortEnd represents the upper end of a "
427 "range of UDP or TCP destination ports. The lower end of the "
428 "range is represented by the HdrDestPortStart property. The "
429 "value of HdrDestPortEnd MUST be no less than the value of "
430 "HdrDestPortStart. A single port is indicated by equal "
431 "values for HdrDestPortStart and HdrDestPortEnd. \n"
432 "\n"
433 "A destination port filter is evaluated by testing whether "
434 "the destination port identified in the IP header falls "
435 "within the range of values between HdrDestPortStart and "
436 "HdrDestPortEnd, INCLUDING these two end points. \n"
437 "\n"
438 "If a value for this property is not provided, then the "
439 "filter does not consider HdrDestPortEnd in selecting "
440 "matching packets, i.e., there is no upper bound in "
441 "matching destination port values.") ]
442 karl 1.1 uint16 HdrDestPortEnd;
443
444 [MaxValue (63), Description (
445 "HdrDSCP is defined as a set of discrete "
446 "DiffServ code points, with no inherent structure. There "
447 "is no semantically significant relationship between "
448 "different HdrDSCPs. Consequently, there is no "
449 "provision for specifying a range of HdrDSCPs. \n"
450 "\n"
451 "Since, in IPv4, the HdrDSCP field may contain bits "
452 "to be interpreted as the TOS IP Precedence, this "
453 "property is also used to filter on IP Precedence. "
454 "Similarly, the IPv6 Traffic Class field is also "
455 "filtered using the value(s) in this property. \n"
456 "\n"
457 "HdrDSCP is defined as an array, to provide the "
458 "ability to specify several discrete DSCPs in a single "
459 "instance of IPHeadersFilter, that would be OR'ed "
460 "together to define the filter criteria. \n"
461 "\n"
462 "If a value for this property is not provided, then the "
463 karl 1.1 "filter does not consider HdrDSCP in selecting matching "
464 "packets, i.e., HdrDSCP matches for all values.") ]
465 uint8 HdrDSCP[];
466
467 [OctetString, Description (
468 "The 20-bit Flow Label field in the IPv6 header "
469 "may be used by a source to label sequences of packets for "
470 "which it requests special handling by the IPv6 devices, such "
471 "as non-default quality of service or 'real-time' service. "
472 "In the filter, this 20-bit string is encoded in a 24-bit "
473 "octetstring by right-adjusting the value and padding on "
474 "the left with b'0000'. \n"
475 "\n"
476 "If a value for this property is not provided, then the "
477 "filter does not consider HdrFlowLabel in selecting matching "
478 "packets, i.e., HdrFlowLabel matches for all values.") ]
479 uint8 HdrFlowLabel[];
480 };
481
482
483 // ==================================================================
484 karl 1.1 // 8021Filter
485 // ==================================================================
486 [Experimental, Version ("2.7.0"), Description (
487 "8021Filter allows 802.1.source and destination MAC addresses, "
488 "as well as the 802.1 protocol ID, priority, and VLAN "
489 "identifier fields, to be expressed in a single object to "
490 "classify and identify traffic.") ]
491 class CIM_8021Filter : CIM_FilterEntryBase {
492
493 [OctetString, Description (
494 "This property is an OctetString of size 6, representing "
495 "a 48-bit source MAC address in canonical format. This "
496 "value is compared to the SourceAddress field in the "
497 "MAC header, subject to the mask represented in the "
498 "8021HdrSrcMACMask property. If a value for this "
499 "property is not provided, then the filter does not "
500 "consider 8021HdrSrcMACAddr in selecting matching packets, "
501 "i.e., 8021HdrSrcMACAddr matches for all values.") ]
502 uint8 HdrSrcMACAddr8021[6];
503
504 [OctetString, Description (
505 karl 1.1 "This property is an OctetString of size 6, representing "
506 "a 48-bit mask to be used in comparing the SourceAddress "
507 "field in the MAC header with the value represented in "
508 "the 8021HdrSrcMACAddr property. If a value for this "
509 "property is not provided, then the filter does not "
510 "consider 8021HdrSrcMACMask in selecting matching packets, "
511 "i.e., the value of 8021HdrSrcMACAddr must match the source "
512 "MAC address in the packet exactly.") ]
513 uint8 HdrSrcMACMask8021[6];
514
515 [OctetString, Description (
516 "This property is an OctetString of size 6, representing "
517 "a 48-bit destination MAC address in canonical format. This "
518 "value is compared to the DestinationAddress field in the "
519 "MAC header, subject to the mask represented in the "
520 "8021HdrDestMACMask property. If a value for this "
521 "property is not provided, then the filter does not "
522 "consider 8021HdrDestMACAddr in selecting matching packets, "
523 "i.e., 8021HdrDestMACAddr matches for all values.") ]
524 uint8 HdrDestMACAddr8021[6];
525
526 karl 1.1 [OctetString, Description (
527 "This property is an OctetString of size 6, representing "
528 "a 48-bit mask to be used in comparing the DestinationAddress "
529 "field in the MAC header with the value represented in "
530 "the 8021HdrDestMACAddr property. If a value for this "
531 "property is not provided, then the filter does not "
532 "consider 8021HdrDestMACMask in selecting matching packets, "
533 "i.e., the value of 8021HdrDestMACAddr must match the "
534 "destination MAC address in the packet exactly.") ]
535 uint8 HdrDestMACMask8021[6];
536
537 [Description (
538 "This property is a 16-bit unsigned integer, representing "
539 "an Ethernet protocol type. This value is compared to the "
540 "Ethernet Type field in the 802.3 MAC header. If a value "
541 "for this property is not provided, then the filter does not "
542 "consider 8021HdrProtocolID in selecting matching packets, "
543 "i.e., 8021HdrProtocolID matches for all values.") ]
544 uint16 HdrProtocolID8021;
545
546 [MinValue (0), MaxValue (7), Description (
547 karl 1.1 "This property is an 8-bit unsigned integer, representing "
548 "an 802.1Q priority. This value is compared to the Priority "
549 "field in the 802.1Q header. Since the 802.1Q Priority field "
550 "consists of 3 bits, the values for this property are "
551 "limited to the range 0..7. If a value for this property "
552 "is not provided, then the filter does not consider "
553 "8021HdrPriorityValue in selecting matching packets, i.e., "
554 "8021HdrPriorityValue matches for all values.") ]
555 uint8 HdrPriorityValue8021;
556
557 [MinValue (0), MaxValue (4095), Description (
558 "This property is an 32-bit unsigned integer, representing an "
559 "802.1Q VLAN Identifier. This value is compared to the VLAN "
560 "ID field in the 802.1Q header. Since the 802.1Q VLAN ID field "
561 "consists of 12 bits, the values for this property are limited "
562 "to the range 0..4095. If a value for this property is not "
563 "provided, then the filter does not consider 8021HdrVLANID in "
564 "selecting matching packets, i.e., 8021HdrVLANID matches for "
565 "all values.") ]
566 uint32 HdrVLANID8021;
567 };
568 karl 1.1
569
570 // ==================================================================
571 // PreambleFilter
572 // ==================================================================
573 [Experimental, Version ("2.7.0"), Description (
574 "PreambleFilter allows the classification of packets "
575 "using traffic-conditioning results (where the results are "
576 "determined by a PreambleMarkerService and stored in a "
577 "'packet preamble'). This permits information "
578 "about the treatment that a packet receives on an ingress "
579 "interface to be communicated along with the packet to the "
580 "egress interface. An instance of PreambleFilter selects "
581 "packets based on a two-part string (type and value pair) "
582 "identifying a specific entry in the preamble. The logic "
583 "for this match is 'at least one.' That is, a packet with "
584 "multiple entries/results in its preamble matches "
585 "a filter if at least one of these matches the filter.") ]
586 class CIM_PreambleFilter : CIM_FilterEntryBase {
587
588 [Description (
589 karl 1.1 "To foster interoperability, the basic format of the "
590 "information captured by a PreambleMarker is specified. "
591 "That information is contained in the FilterItemList "
592 "property (an ordered, string array). Each entry in the "
593 "array takes the form 'type,value'. When entries are added, "
594 "they are appended to the end of the list. \n"
595 "\n"
596 "A limited set of standardized 'type's exist. They are: \n"
597 " - ConformingFromMeter, NonConformingFromMeter and "
598 "PartConformingFromMeter to convey metering results "
599 "(where the 'value' is the name of the meter) \n"
600 " - VlanId to describe the traffic's VLAN information "
601 "(where the 'value' is the VLAN ID). \n"
602 " An implementation is free to define and use other "
603 "preamble 'types'. \n"
604 "\n"
605 "Note that a wildcard value of \"any\" is allowed to "
606 "indicate that the preamble entry matches for any 'value' "
607 "of the specified 'type'. For example, using the wildcard, "
608 "an administrator can define a filter to select all "
609 "packets that were found to be conforming ('type' = "
610 karl 1.1 "\"ConformingFromMeter\") without having to name each "
611 "meter individually."),
612 ArrayType ("Ordered") ]
613 string FilterItemList[];
614 };
615
616
617 // ==================================================================
618 // FilterList
619 // ==================================================================
620 [Version ("2.7.0"), Description (
621 "A FilterList is used by network devices to identify routes "
622 "by aggregating a set of FilterEntries into a unit, called a "
623 "FilterList. FilterLists can also be used to accept or deny "
624 "routing updates. \n"
625 "\n"
626 "A FilterList is weak to the network device (i.e., the "
627 "ComputerSystem) that contains it. Hence, the ComputerSystem "
628 "keys are propagated to this class.") ]
629 class CIM_FilterList : CIM_LogicalElement {
630
631 karl 1.1 [Propagated ("CIM_ComputerSystem.CreationClassName"), Key,
632 MaxLen (256), Description (
633 "The scoping ComputerSystem's CreationClassName.") ]
634 string SystemCreationClassName;
635
636 [Propagated ("CIM_ComputerSystem.Name"), Key, MaxLen (256),
637 Description ("The scoping ComputerSystem's Name.") ]
638 string SystemName;
639
640 [Key, Description (
641 "The type of class that this instance is.") ]
642 string CreationClassName;
643
644 [Override ("Name"), Key, MaxLen(256), Description (
645 "This is the name of the FilterList.") ]
646 string Name;
647
648 [Description (
649 "This defines whether the FilterList is used "
650 "for input, output, or both input and output "
651 "filtering. All values are used with respect to "
652 karl 1.1 "the interface for which the FilterList applies. \n"
653 "\n"
654 "\"Not Applicable\" (0) is used when there is no "
655 "direction applicable to the FilterList. "
656 "\"Input\" (1) is used when the FilterList applies "
657 "to packets that are inbound on the related "
658 "interface. "
659 "\"Output\" (2) is used when the FilterList applies "
660 "to packets that are outbound on the related "
661 "interface. "
662 "\"Both\" (3) is used to indicate that "
663 "the direction is immaterial, e.g., to filter on "
664 "a source subnet regardless of whether the flow is "
665 "inbound or outbound. "
666 "\"Mirrored\" (4) is also applicable to "
667 "both inbound and outbound flow processing, but "
668 "indicates that the filter criteria are applied "
669 "asymmetrically to traffic in both directions "
670 "and, thus, specifies the reversal of source and "
671 "destination criteria (as opposed to the equality "
672 "of these criteria as indicated by \"Both\"). "
673 karl 1.1 "The match conditions in the aggregated "
674 "FilterEntryBase subclass instances are defined "
675 "from the perspective of outbound flows and applied "
676 "to inbound flows as well by reversing the source "
677 "and destination criteria. So, for example, "
678 "consider a FilterList with 3 FilterEntries "
679 "indicating destination port = 80, and source and "
680 "destination addresses of a and b, respectively. "
681 "Then, for the outbound direction, the filter "
682 "entries match as specified and the 'mirror' (for "
683 "the inbound direction) matches on source "
684 "port = 80 and source and destination addresses "
685 "of b and a, respectively."),
686 ValueMap {"0", "1", "2", "3", "4"},
687 Values {"Not Applicable", "Input", "Output",
688 "Both", "Mirrored"} ]
689 uint16 Direction;
690 };
691
692
693 // ==================================================================
694 karl 1.1 // FilterEntryInSystem
695 // ==================================================================
696 [Association, Aggregation, Version ("2.7.0"),
697 Deprecated {"CIM_HostedFilterEntryBase"},
698 Description (
699 "All filter entries (FilterEntryBase and its subclasses) "
700 "are defined in the context of a ComputerSystem/network "
701 "device, where they are used to identify and act on network "
702 "traffic. Note that this class is deprecated since its "
703 "subclassing is not correct. It subclasses from System"
704 "Component, but a FilterEntryBase is NOT a Component of a "
705 "System. Instead, it is hosted/scoped by the System. "
706 "In versions up to CIM 2.6, FilterEntryInSystem was a "
707 "mandatory, Weak relationship. This is no longer true, "
708 "beginning with CIM V2.7.") ]
709 class CIM_FilterEntryInSystem : CIM_SystemComponent {
710
711 [Override ("GroupComponent"), Aggregate, Max (1),
712 Deprecated {"CIM_HostedFilterEntryBase.Antecedent"},
713 Description (
714 "The ComputerSystem/network device that scopes the "
715 karl 1.1 "FilterEntryBase.") ]
716 CIM_ComputerSystem REF GroupComponent;
717
718 [Override ("PartComponent"),
719 Deprecated {"CIM_HostedFilterEntryBase.Dependent"},
720 Description (
721 "The FilterEntryBase on the System.") ]
722 CIM_FilterEntryBase REF PartComponent;
723 };
724
725
726 // ==================================================================
727 // FilterListInSystem
728 // ==================================================================
729 [Association, Aggregation, Version ("2.7.0"),
730 Deprecated {"CIM_HostedFilterList"},
731 Description (
732 "FilterLists are defined in the context of a ComputerSystem "
733 "(e.g., a router, firewall or host). Note that this class is "
734 "deprecated since its subclassing is not correct. It "
735 "subclasses from SystemComponent, but a FilterList is "
736 karl 1.1 "NOT a Component of a System. Instead, it is hosted/scoped "
737 "by the System. In versions up to CIM 2.6, FilterListInSystem "
738 "was a mandatory, Weak relationship. This is no longer true, "
739 "beginning with CIM V2.7.") ]
740 class CIM_FilterListInSystem : CIM_SystemComponent {
741
742 [Override ("GroupComponent"), Aggregate, Max (1),
743 Deprecated {"CIM_HostedFilterList.Antecedent"},
744 Description (
745 "The ComputerSystem/network device that scopes the "
746 "FilterList and administers it.") ]
747 CIM_ComputerSystem REF GroupComponent;
748
749 [Override ("PartComponent"),
750 Deprecated {"CIM_HostedFilterList.Dependent"},
751 Description (
752 "The FilterList on the System.") ]
753 CIM_FilterList REF PartComponent;
754 };
755
756
757 karl 1.1 // ==================================================================
758 // HostedFilterEntryBase
759 // ==================================================================
760 [Association, Experimental, Version ("2.7.0"),
761 Description (
762 "All filter entries (FilterEntryBase and its subclasses) "
763 "are defined in the context of a ComputerSystem/network "
764 "device, where the filter entries are used and administered.") ]
765 class CIM_HostedFilterEntryBase : CIM_Dependency {
766
767 [Override ("Antecedent"), Min (1), Max (1),
768 Description (
769 "The ComputerSystem/network device that scopes the "
770 "FilterEntryBase.") ]
771 CIM_ComputerSystem REF Antecedent;
772
773 [Override ("Dependent"), Weak, Description (
774 "The FilterEntryBase on the System.") ]
775 CIM_FilterEntryBase REF Dependent;
776 };
777
778 karl 1.1
779 // ==================================================================
780 // HostedFilterList
781 // ==================================================================
782 [Association, Experimental, Version ("2.7.0"),
783 Description (
784 "FilterLists are defined in the context of a ComputerSystem/"
785 "network device, where the list is used and administered.") ]
786 class CIM_HostedFilterList : CIM_Dependency {
787
788 [Override ("Antecedent"), Min (1), Max (1),
789 Description (
790 "The ComputerSystem/network device that scopes the "
791 "FilterList.") ]
792 CIM_ComputerSystem REF Antecedent;
793
794 [Override ("Dependent"), Weak, Description (
795 "The FilterList on the System.") ]
796 CIM_FilterList REF Dependent;
797 };
798
799 karl 1.1
800 // ==================================================================
801 // EntriesInFilterList
802 // ==================================================================
803 [Association, Aggregation, Version ("2.7.0"),
804 Description (
805 "This is a specialization of the CIM_Component aggregation "
806 "which is used to define a set of filter entries (subclasses "
807 "of FilterEntryBase) that are aggregated by a particular "
808 "FilterList.") ]
809 class CIM_EntriesInFilterList : CIM_Component {
810
811 [Override ("GroupComponent"), Aggregate, Max (1),
812 Description (
813 "The FilterList, which aggregates the set "
814 "of FilterEntries.") ]
815 CIM_FilterList REF GroupComponent;
816
817 [Override ("PartComponent"),
818 Description (
819 "Any subclass of FilterEntryBase which is a part of "
820 karl 1.1 "the FilterList.") ]
821 CIM_FilterEntryBase REF PartComponent;
822
823 [ValueMap {"0"}, Description (
824 "The order of the Entry relative to all others in the "
825 "FilterList. The only permissible value is zero - "
826 "indicating that all the Entries are ANDed together.") ]
827 uint16 EntrySequence = 0;
828 };
829
830
831 // ===================================================================
832 // end of file
833 // ===================================================================
|
Return to
Network27_Filtering.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim271