WS-Management > WS-Management Class Reference > AMT Classes > AMT_HeuristicPacketFilterStatistics

Class AMT_HeuristicPacketFilterStatistics

Used in features: System Defense & Heuristics
Compatible with the following Intel AMT Releases: 3.0, 3.2, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5
CIM_ManagedElement
   extended by CIM_StatisticalData
      extended by AMT_HeuristicPacketFilterStatistics


class AMT_HeuristicPacketFilterStatistics
extends CIM_StatisticalData

General Information:
Represents the state of the Heuristics System Defense feature

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


Supported Fields Summary
 string ElementName
The user friendly name for this instance of StatisticalData . . .
 string InstanceID Key
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class . . .
 uint16 State
The state of the Heuristics Packet Filter.
 boolean BlockedAll
Indicates whether all transmit traffic has been blocked due to one of the conditions being met.
 datetime TimeStamp
A time stamp of last transition to the current state . . .
 uint16 TriggerReason
Contains the reason that caused the last transition from Running state . . .
 uint16 BlockedOffensivePort
Identifies the offensive TX port blocked due to one of the conditions being met . . .
 uint16 BlockedOffensivePortProtocol
Indicates the protocol type at the offensive TX port blocked.
 boolean EnabledPolicy
Indicates whether the associated System Defense policy was applied due to one of the conditions being met.

Methods Summary
 uint32 ResetSelectedStats(SelectedStatistics)
Method to reset one or more of the instance's statistics . . .
  Get(Instance)
Gets the representation of the 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

ElementName

public string ElementName
General Information:
The user friendly name for this instance of StatisticalData. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is "Intel(r) AMT Heuristic System Defense Statistics"

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=50


InstanceID Key

public string InstanceID
General Information:
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is "Intel(r) AMT NetworkPort %d Heuristic Packet Filter Statistics" where %d is the network interface handle

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


State

public uint16 State
General Information:
The state of the Heuristics Packet Filter.

Product Specific Usage:
Timed Encounter- this state might not be restored after power outage
Permanent encounter - this state will be restored after power loss
Disabled - this state will be restored after power loss


Qualifiers:
-------------
ValueMap={0, 1, 2, 3}
Values={Running, Timed Encounter, Permanent Encounter, Disabled}


BlockedAll

public boolean BlockedAll
General Information:
Indicates whether all transmit traffic has been blocked due to one of the conditions being met.


TimeStamp

public datetime TimeStamp
General Information:
A time stamp of last transition to the current state. This property is Null when the current state is Running.

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 5.0 and earlier releases 'datetime' format is simple string. Intel AMT Release 5.1 and later releases 'datetime' format is as defined in DSP0230 'DMTF WS-CIM Mapping Specification'.


TriggerReason

public uint16 TriggerReason
General Information:
Contains the reason that caused the last transition from Running state. This property is Null when the current state is Running.

Qualifiers:
-------------
ValueMap={0, 1, 2}
Values={Slow Worm Detection, Fast Worm Detection, DoS Detection}


BlockedOffensivePort

public uint16 BlockedOffensivePort
General Information:
Identifies the offensive TX port blocked due to one of the conditions being met. A 16-bit port number.


BlockedOffensivePortProtocol

public uint16 BlockedOffensivePortProtocol
General Information:
Indicates the protocol type at the offensive TX port blocked.

Qualifiers:
-------------
ValueMap={.., 6, .., 17, ..}
Values={Reserved1, TCP, Reserved2, UDP, Reserved3}


EnabledPolicy

public boolean EnabledPolicy
General Information:
Indicates whether the associated System Defense policy was applied due to one of the conditions being met.


Method Detail

ResetSelectedStats

public uint32 ResetSelectedStats([IN]string SelectedStatistics[])
Permission Information:
Permitted realms: ADMIN_SECURITY_CIRCUIT_BREAKER_REALM

General Information:
Method to reset one or more of the instance's statistics. The method takes one parameter as input - an array of strings indicating which statistics to reset. If all the statistics in the instance should be reset, the first element of the array MUST be set to "All" or "ALL". If one or more individual statistics should be reset, the corresponding property names are entered into the elements of the array.
The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. A method is specified so that the StatisticalInformation's provider/ instrumentation, which calculates the statistics, can reset its internal processing, counters, etc.
In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

Product Specific Usage:
In current implementation SelectedStatistics parameter is ignored.

Parameters:
--------------
SelectedStatistics
General Information:
Array of strings indicating which statistics to reset.

Qualifiers:
-------------
IN



Get

public  Get([OUT]AMT_HeuristicPacketFilterStatistics Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_CIRCUIT_BREAKER_REALM

General Information:
Gets the representation of the 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

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