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

Class AMT_AgentPresenceWatchdogAction

Used in features: Agent Presence
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_Policy
      extended by CIM_PolicyAction
         extended by AMT_AgentPresenceWatchdogAction


class AMT_AgentPresenceWatchdogAction
extends CIM_PolicyAction

General Information:
Represents an action which is triggered on an application watchdog state transition.

Product Specific Usage:
An instance of this class is automatically created while calling to AMT_AgentPresenceWatchdog.AddAction.

Qualifiers:
-------------
Version=4.0.0


Supported Fields Summary
 string PolicyActionName Key
A user-friendly name of this PolicyAction.
 string CreationClassName Key
CreationClassName indicates the name of the class or the subclass used in the creation of an instance . . .
 string PolicyRuleName Key
For a rule-specific PolicyAction, the name of the PolicyRule object with which this Action is associated . . .
 string PolicyRuleCreationClassName Key
For a rule-specific PolicyAction, the CreationClassName of the PolicyRule object with which this Action is associated . . .
 string SystemName Key
The name of the System object in whose scope this PolicyAction is defined . . .
 string SystemCreationClassName Key
The name of the class or the subclass used in the creation of the System object in whose scope this PolicyAction is defined . . .
 string ElementName
A user-friendly name for the object . . .
 boolean EventOnTransition
Specifies whether an Event should be created in the Event Manager on the application watchdog transition.
 uint16 ActionSd
A System Defense Action which may be applied, on the application watchdog transition . . .

Methods Summary
 uint32 GetActionEac(ActionEac)
This method allows to determine if this action is defined as an EAC action . . .
  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

PolicyActionName Key

public string PolicyActionName
General Information:
A user-friendly name of this PolicyAction.

Qualifiers:
-------------
Key
MaxLen=256


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.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'AMT_AgentPresenceWatchdogAction'

Qualifiers:
-------------
Key
MaxLen=35


PolicyRuleName Key

public string PolicyRuleName
General Information:
For a rule-specific PolicyAction, the name of the PolicyRule object with which this Action is associated. For a reusable PolicyAction, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single PolicyRule.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'NO RULE'

Qualifiers:
-------------
Key
MaxLen=10


PolicyRuleCreationClassName Key

public string PolicyRuleCreationClassName
General Information:
For a rule-specific PolicyAction, the CreationClassName of the PolicyRule object with which this Action is associated. For a reusable PolicyAction, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single PolicyRule.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'NO RULE'

Qualifiers:
-------------
Key
MaxLen=10


SystemName Key

public string SystemName
General Information:
The name of the System object in whose scope this PolicyAction is defined.

This property completes the identification of the System object in whose scope this instance of PolicyAction exists. For a rule-specific PolicyAction, this is the System in whose context the PolicyRule is defined. For a reusable PolicyAction, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'Intel(r) AMT'

Qualifiers:
-------------
Key
MaxLen=256


SystemCreationClassName Key

public string SystemCreationClassName
General Information:
The name of the class or the subclass used in the creation of the System object in whose scope this PolicyAction is defined.

This property helps to identify the System object in whose scope this instance of PolicyAction exists. For a rule-specific PolicyAction, this is the System in whose context the PolicyRule is defined. For a reusable PolicyAction, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action.

Note that this property, and the analogous property SystemName, do not represent propagated keys from an instance of the class System. Instead, they are properties defined in the context of this class, which repeat the values from the instance of System to which this PolicyAction is related, either directly via the PolicyActionInPolicyRepository association or indirectly via the PolicyActionInPolicyRule aggregation.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'CIM_ComputerSystem'

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


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.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is 'Intel(r) Agent Presence Watchdog Action'

Qualifiers:
-------------
MaxLen=45


EventOnTransition

public boolean EventOnTransition
General Information:
Specifies whether an Event should be created in the Event Manager on the application watchdog transition.


ActionSd

public uint16 ActionSd
General Information:
A System Defense Action which may be applied, on the application watchdog transition. Note that all Agent Presence instances share the same list of policies, which can be activated.

Product Specific Usage:
The System Defense policy that will be activated/deactivated is defined by AMT_AgentPresenceInterfacePolicy instances that exist in the system.

Qualifiers:
-------------
ValueMap={0, 1}
Values={ActivatePolicy, DeactivatePolicy}


Method Detail

GetActionEac

public uint32 GetActionEac([OUT]boolean ActionEac)
Permission Information:
Permitted realms: ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General Information:
This method allows to determine if this action is defined as an EAC action. If this method returns TRUE: 1. Information about this agent is included in an Intel(R) AMT EAC posture. This happens if at least one transition is defined as TRUE for this agent. Posture information includes current state and state counters showing how many times each state was entered. 2. When this specific state transition occurs, an avent is generated to indicate that Intel(R) AMT posture has changed.

Product Specific Usage:
Additional Notes:
1) 'GetActionEac' method is supported in Intel AMT Release 4.0 and later releases.

Parameters:
--------------
ActionEac
General Information:
A boolean flag indicating whether this action is defined as an EAC action.

Qualifiers:
-------------
OUT



Get

public  Get([OUT]AMT_AgentPresenceWatchdogAction Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_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-2022, Intel Corporation. All rights reserved.