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

Class AMT_RemoteAccessPolicyRule

Used in features: Remote Access & User Initiated
Compatible with the following Intel AMT Releases: 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_PolicySet
         extended by CIM_PolicyRule
            extended by AMT_RemoteAccessPolicyRule


class AMT_RemoteAccessPolicyRule
 extends CIM_PolicyRule


General Information:
Represents a Remote Access policy. The policy 
defines a condition that will trigger the establishment of a tunnel between the 
Intel(R) AMT subsystem and a remote MpServer. The policy also defines parameters 
for the connection such as TunnelLifeTime in 
seconds.

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









  
  

    Supported Fields 
      Summary

  

     string 
      
    PolicyRuleName Key  
A user-friendly name of this 
      PolicyRule.

  

     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 System's Name.

  

     string 
      
    SystemCreationClassName Key  
The scoping System's 
      CreationClassName.

  

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

  

     uint16 
      
    Trigger 
The event that 
      will trigger the establishment of the remote connection to the 
      MpServer.

  

     uint32 
      
    TunnelLifeTime 
      
Defines the tunnel lifetime in seconds, 0 means no lifetime- 
      the tunnel should stay open until it is closed by 
      CloseRemoteAccessConnection or when a different policy with higher 
      priority needs to be processed.

  

     uint8[32] 
      
    ExtendedData 
Data 
      associated with the policy, up to 32 bytes . . 
.




  
  

    Methods Summary

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    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


PolicyRuleName Key 
public string PolicyRuleName



  
General Information:
A user-friendly name of this 
  PolicyRule.

Product Specific Usage:
In Intel AMT Release 6.0 
  and later releases value is "%s %d" where %s is the policy type ("User 
  Initiated" / "Alert" / "Periodic") and %d is the policy 
  handle

Qualifiers:
-------------
Key
MaxLen=32


  

  





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_RemoteAccessPolicyRule"

Qualifiers:
-------------
Key
MaxLen=28


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping System's 
  Name.

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 scoping System's 
  CreationClassName.

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 "Inte(r) AMT:Remote Access 
  Policy"

Qualifiers:
-------------
MaxLen=34


  

  





Trigger 
public uint16 Trigger



  
General Information:
The event that will trigger the 
  establishment of the remote connection to the 
  MpServer.

Qualifiers:
-------------
Required
ValueMap={0, 
  1, 2, 3}
Values={User Initiated, Alert, Periodic, Home 
Provisioning}


  

  





TunnelLifeTime 
public uint32 TunnelLifeTime



  
General Information:
Defines the tunnel lifetime in seconds, 0 
  means no lifetime- the tunnel should stay open until it is closed by 
  CloseRemoteAccessConnection or when a different policy with higher priority 
  needs to be 
  processed.

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


  

  





ExtendedData 
public uint8[32] ExtendedData



  
General Information:
Data associated with the policy, up to 32 
  bytes. The data should be in a network order. The extended data for a policy 
  with a periodic trigger contains first a periodic type and after that the data 
  for that type. For periodic type 0 [Interval - The CIRA connection will be 
  established every fixed number of seconds] - the data should include a uint32 
  value that indicates the time period in seconds between tunnel establishments. 
  For periodic type 1 [Daily - The CIRA connection will be established every day 
  in a specific pre-defined time (hour and minutes)] - the data should include 
  two uint32 values which define the wanted hour of the day and minutes of that 
  hour. For the other triggers extended data is not defined and not needed. The 
  length and data should be 
  zero.

Qualifiers:
-------------
Octetstring


  

  






  
  

    Method 
Detail


Put
public  Put([IN]AMT_RemoteAccessPolicyRule Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
Only TunnelLifeTime and 
  ExtendedData properties are writable.





Get
public  Get([OUT]AMT_RemoteAccessPolicyRule Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Deletes an instance

Product Specific 
  Usage:
Removes an instance of AMT_RemoteAccessPolicyRule its 
  CIM_ServiceAffectElement instace as well as any 
  AMT_RemoteAccessPolicyAppliesToMPS that refrence it.





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.