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

Class AMT_AlarmClockService

Used in features: Remote Control
Compatible with the following Intel AMT Releases: 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_AlarmClockService


class AMT_AlarmClockService
 extends CIM_Service


General Information:
AMT Alarm Clock Service derived from Service 
and provides the ability to set an alarm time to turn the host computer system 
on. Setting an alarm time is done by calling "AddAlarm" 
method."NextAMTAlarmTime" and "AMTAlarmClockInterval" properties are deprecated 
and "AddAlarm" should be used instead. 


Qualifiers:
-------------
Version=8.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 . . .

  

     datetime 
      
    NextAMTAlarmTime 
      
Specifies the next AMT alarm time . . .

  

     datetime 
      
    AMTAlarmClockInterval 
      
Specifies the alarm time interval . . 
.




  
  

    Methods Summary

  

     uint32
    AddAlarm(AlarmTemplate, REF 
      AlarmClock) 
This method creates an alarm that would wake the 
      system at a given time.The method receives as input an embedded instance 
      of type IPS_AlarmClockOccurrence, with the following fields set: 
      StartTime, Interval, InstanceID, DeleteOnCompletion . . .

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    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


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 Alarm Clock 
  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_AlarmClockService"

Qualifiers:
-------------
Key
MaxLen=23


  

  





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

Qualifiers:
-------------
Key
MaxLen=16
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 Alarm Clock 
  Service"

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


  

  





NextAMTAlarmTime 
public datetime NextAMTAlarmTime



  
General Information:
Specifies the next AMT alarm time. 
  "NextAMTAlarmTime" must be in Datetime format.This property is deprecated, you 
  should use the AddAlarm() method 
  instead.

Qualifiers:
-------------
Deprecated={AddAlarm}


  

  





AMTAlarmClockInterval 
public datetime AMTAlarmClockInterval



  
General Information:
Specifies the alarm time interval. 
  "AMTAlarmClockInterval" must be in Interval format.This property is 
  deprecated, you should use the AddAlarm() method 
  instead.

Qualifiers:
-------------
Deprecated={AddAlarm}


  

  






  
  

    Method 
Detail


AddAlarm
public uint32 AddAlarm([IN]string AlarmTemplate, [OUT]REF IPS_AlarmClockOccurrence AlarmClock)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
This 
  method creates an alarm that would wake the system at a given time.The method 
  receives as input an embedded instance of type IPS_AlarmClockOccurrence, with 
  the following fields set: StartTime, Interval, InstanceID, DeleteOnCompletion. 
  Upon success, the method creates an instance of IPS_AlarmClockOccurrence which 
  is associated with AlarmClockService.The method would fail if 5 instances or 
  more of IPS_AlarmClockOccurrence already exist in the 
  system.

Parameters:
--------------

  

    
AlarmTemplate 
    
General Information:
A template for creating a new alarm of 
    type 
    IPS_AlarmClockOccurrence.

Qualifiers:
-------------
IN
Required
EmbeddedInstance=IPS_AlarmClockOccurrence


    
AlarmClock 
    
General Information:
A reference to the created instance of 
    IPS_AlarmClockOccurrence.

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







Put
public  Put([IN]AMT_AlarmClockService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Changes properties of the selected 
  instance

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

Name 
  
CreationClassName 
SystemName 
SystemCreationClassName 







Get
public  Get([OUT]AMT_AlarmClockService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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