Schemas/CIM225/DMTF/Network/CIM_PreambleFilter.mof

   1 // Copyright (c) 2005 DMTF.  All rights reserved.
   2 // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
   3 // qualifier values to CIM Schema.</change>
   4 // ==================================================================
   5 //  CIM_PreambleFilter
   6 // ==================================================================
   7    [Version ( "2.7.0" ),
   8     UMLPackagePath ( "CIM::Network::Filtering" ),
   9     Description (
  10        "PreambleFilter allows the classification of packets using "
  11        "traffic-conditioning results (where the results are determined "
  12        "by a PreambleMarkerService and stored in a \'packet "
  13        "preamble\'). This permits information about the treatment that "
  14        "a packet receives on an ingress interface to be communicated "
  15        "along with the packet to the egress interface. An instance of "
  16        "PreambleFilter selects packets based on a two-part string "
  17        "(type and value pair) identifying a specific entry in the "
  18        "preamble. The logic for this match is \'at least one.\' That "
  19        "is, a packet with multiple entries/results in its preamble "
  20        "matches a filter if at least one of these matches the filter." )]
  21 class CIM_PreambleFilter : CIM_FilterEntryBase {
  22
  23       [Description (
  24           "To foster interoperability, the basic format of the "
  25           "information captured by a PreambleMarker is specified. "
  26           "That information is contained in the FilterItemList "
  27           "property (an ordered, string array). Each entry in the "
  28           "array takes the form \'type,value\'. When entries are "
  29           "added, they are appended to the end of the list. \n"
  30           "\n"
  31           "A limited set of standardized \'type\'s exist. They are: \n"
  32           "- ConformingFromMeter, NonConformingFromMeter and "
  33           "PartConformingFromMeter to convey metering results "
  34           "(where the \'value\' is the name of the meter) \n"
  35           "- VlanId to describe the traffic\'s VLAN information "
  36           "(where the \'value\' is the VLAN ID). \n"
  37           "An implementation is free to define and use other "
  38           "preamble \'types\'. \n"
  39           "\n"
  40           "Note that a wildcard value of \"any\" is allowed to "
  41           "indicate that the preamble entry matches for any \'value\' "
  42           "of the specified \'type\'. For example, using the "
  43           "wildcard, an administrator can define a filter to select "
  44           "all packets that were found to be conforming (\'type\' = "
  45           "\"ConformingFromMeter\") without having to name each "
  46           "meter individually." ),
  47        ArrayType ( "Ordered" )]
  48    string FilterItemList[];
  49
  50
  51 };