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

Class AMT_AgentPresenceService

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_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by AMT_AgentPresenceService


class AMT_AgentPresenceService
 extends CIM_Service


General Information:
Represents the Agent Presence Service in the 
Intel(R) AMT subsystem.

Product Specific Usage:
Additional 
Notes: 
1) 'PrimaryStatus' property was removed in Intel AMT Release 5.1. 


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









  
  

    Supported Fields 
      Summary

  

     string 
      
    Name Key  
The Name property uniquely identifies the 
      Service and provides an indication of the functionality that is managed . 
      . .

  

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

  

     string 
      
    SystemName Key  
The Name of the scoping System.

  

     string 
      
    SystemCreationClassName Key  
The CreationClassName of the scoping 
      System.

  

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

	  
	    

     boolean 
      
    Enable Key  
This flag indicates whether the requested operation is enable (TRUE) or disable (FALSE).

  

	  
	  




  
  

    Methods Summary

  

     
    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

	  
	  

     
    EnableHostResetAction([IN] boolean Enable) 
      
This routine is used to enable or disable automatic platform reset.

	  Available from Intel CSME 16.0.

	  

	  
	  




  
  

    Field 
Detail


Name Key 
public string Name



  
General Information:
The Name property uniquely identifies the 
  Service and provides an indication of the functionality that is managed. This 
  functionality is described in more detail in the Description property of the 
  object.

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

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


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
CreationClassName indicates the name of the 
  class or the subclass that is 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_AgentPresenceService'

Qualifiers:
-------------
Key
MaxLen=30


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

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

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

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

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.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.

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

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


  

  






Enable 
public boolean Enable



  
General Information:
This flag indicates whether the requested operation is enable (TRUE) or disable (FALSE).




  

  







  
  

    Method 
Detail


Get
public  Get([OUT]AMT_AgentPresenceService 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






EnableHostResetAction
public  uint32 EnableHostResetAction([IN] boolean Enable)



  
Permission Information:
Permitted realms: ADMIN_SECURITY_AGENT_PRESENCE_REMOTE_REALM

General Information:
This routine is used to enable or disable automatic platform reset.


  Note:Executing this command overrides the value specified in FITC that enables or disables the feature. This by itself is not enough to cause automatic reset: the feature also needs to be configured. See Set the Agent Watchdog Expiration Action.

  

  Qualifiers:
-------------

ValueMap={ "0", "1", "2"}

Values={ "Completed with No Error", "Not Supported", "Failed"}


Parameters
-------------


public boolean Enable



General Information:

This flag indicates whether the requested operation is enable (TRUE) or disable (FALSE).

Available from Intel CSME 16.0.

  
  






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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