SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class AMT_Hdr8021Filter

Used in features: System Defense & Heuristics
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by AMT_FilterEntryBase
            extended by AMT_ComplexFilterEntryBase
               extended by AMT_Hdr8021Filter
Also see:
AMT_Hdr8021Filter
AMT_IPHeadersFilter
AMT_NetworkFilter
class AMT_Hdr8021Filter
 extends AMT_ComplexFilterEntryBase


General Information:
8021Filter allows 802.1.source and destination 
MAC addresses, as well as the 802.1 protocol ID, priority, and VLAN identifier 
fields, to be expressed in a single object to classify and identify 
traffic.

Product Specific Usage:
Current implementation 
supports filtering by 802.1 protocol ID 
only

Qualifiers:
-------------
Version=3.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    InstanceID Key  
The creation handle for this filter.

  

     string 
      
    Name Key  
The Name property defines the label by which the 
      Filter Entry is known and uniquely identified.

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    SystemName Key  
The scoping ComputerSystem's Name.

  

     string 
      
    SystemCreationClassName Key  
The scoping ComputerSystem's 
      CreationClassName.

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     uint16 
      
    HdrProtocolID8021 
      
This property is a 16-bit unsigned integer, representing an 
      Ethernet protocol type . . .

  

     uint16 
      
    FilterProfile 
      
Specifies the type of behavior exhibited by the filter.

  

     uint16 
      
    FilterDirection 
      
Specifies the traffic direction (transmit or receive) that the 
      filter governs.

  

     boolean 
      
    ActionEventOnMatch 
      
Specifies whether an Event should be created in the Event 
      Manager when this filter is matched.

  

     uint32 
      
    FilterProfileData 
      
An extra data parameter which is used depending on the 
      FilterProfile: It is left blank for Drop/Pass/Statistics filters, but is 
      required for Rate Limit filters . . .




  
  

    Methods Summary

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


InstanceID Key 
public string InstanceID



  
General Information:
The creation handle for this 
  filter.

Product Specific Usage:
Corresponds to EOI filter 
  creation 
  handle

Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=8


  

  





Name Key 
public string Name



  
General Information:
The Name property defines the label by 
  which the Filter Entry is known and uniquely identified.

Product 
  Specific Usage:
This represents the Filter name. This field is 
  required. 
If the filter was created via another interface with an empty 
  name, this property will show 
  'none'.

Qualifiers:
-------------
Key
Override=Name
MaxLen=16


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass used in the creation of an instance. When used with the 
  other key properties of this class, this property allows all instances of this 
  class and its subclasses to be uniquely 
  identified.

Qualifiers:
-------------
Key
MaxLen=20


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping ComputerSystem's 
  Name.

Qualifiers:
-------------
Key
MaxLen=15
Propagated=CIM_ComputerSystem.Name


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The scoping ComputerSystem's 
  CreationClassName.

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_ComputerSystem.CreationClassName


  

  





ElementName 
public string ElementName



  
General Information:
A user-friendly name for the object. This 
  property allows each instance to define a user-friendly name in addition to 
  its key properties, identity data, and description information. 
Note that 
  the Name property of ManagedSystemElement is also defined as a user-friendly 
  name. But, it is often subclassed to be a Key. It is not reasonable that the 
  same property can convey both identity and a user-friendly name, without 
  inconsistencies. Where Name exists and is not a Key (such as for instances of 
  LogicalDevice), the same information can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that class.

Qualifiers:
-------------
MaxLen=40


  

  





HdrProtocolID8021 
public uint16 HdrProtocolID8021



  
General Information:
This property is a 16-bit unsigned integer, 
  representing an Ethernet protocol type. This value is compared to the Ethernet 
  Type field in the 802.3 MAC header.

Product Specific 
  Usage:
Additional Notes: 
1) 'HdrProtocolID8021' is a required 
  property in Intel AMT Release 3.2 and earlier 
  releases.

Qualifiers:
-------------
Required


  

  





FilterProfile 
public uint16 FilterProfile



  
General Information:
Specifies the type of behavior exhibited by 
  the 
  filter.

Qualifiers:
-------------
Required
ValueMap={0, 
  1, 2, 3, 4}
Values={Statistics + Pass, Statistics + Drop, Rate Limit, Pass, 
  Drop}


  

  





FilterDirection 
public uint16 FilterDirection



  
General Information:
Specifies the traffic direction (transmit 
  or receive) that the filter 
  governs.

Qualifiers:
-------------
Required
ValueMap={0, 
  1}
Values={Transmit filter, Receive filter}


  

  





ActionEventOnMatch 
public boolean ActionEventOnMatch



  
General Information:
Specifies whether an Event should be 
  created in the Event Manager when this filter is 
  matched.

Qualifiers:
-------------
Required


  

  





FilterProfileData 
public uint32 FilterProfileData



  
General Information:
An extra data parameter which is used 
  depending on the FilterProfile: It is left blank for Drop/Pass/Statistics 
  filters, but is required for Rate Limit filters. It indicates the maximum 
  number of events per second (should be greater than 0). Rate limits are not 
  exact. Typically several more packets than the number in the rate limit will 
  be allowed to pass before traffic is blocked. If the boundary is critical, set 
  the maximum number of events to a lower value

  

  






  
  

    Method 
Detail


Create
public  Create([IN]AMT_Hdr8021Filter Instance, [OUT] REF AMT_Hdr8021Filter ResourceCreated)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_CIRCUIT_BREAKER_REALM

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of AMT_Hdr8021Filter: 

InstanceID 
Name 
  
CreationClassName 
SystemName 
SystemCreationClassName 
  
HdrProtocolID8021 
FilterProfile 
FilterDirection 
  
ActionEventOnMatch 

API is blocked in client control mode 
  






Get
public  Get([OUT]AMT_Hdr8021Filter Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_CIRCUIT_BREAKER_REALM

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_CIRCUIT_BREAKER_REALM

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.