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

Class IPS_OptInService


Compatible with the following Intel AMT Releases: 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 IPS_OptInService


class IPS_OptInService
 extends CIM_Service


General Information:
Describes the user consent service. This 
service manages user opt-in options and sends a user consent code for KVM, 
redirection, and set boot 
options.

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

  

     uint32 
      
    OptInCodeTimeout 
      
Indicates the idle timeout, in seconds, after which the opt-in 
      code expires.

  

     uint32 
      
    OptInRequired 
      
Indicates The OptIn (User Consent) Policy for Redirection 
      operations,including KVM and IDER, or setting of boot options . . .

  

     uint8 
      
    OptInState 
Read Only 
      . . .

  

     uint8 
      
    CanModifyOptInPolicy 
      
Read Only: Indicates if Modifying the OptIn Policy via 
      WS-Management is enabled.

  

     uint16 
      
    OptInDisplayTimeout 
      
Defines the maximum time between session request and session 
      establishment (when user discloses the PIN on the Sprite or MEBx screen to 
      the remote operator and the operator enters the PIN) . . 
  .




  
  

    Methods Summary

  

     uint32
    StartOptIn() 
Request 
      an opt-in code . . .

  

     uint32
    CancelOptIn() 
      
Cancel a previous opt-in code request.

  

     uint32
    SendOptInCode(OptInCode) 
Send the 
      opt-in code to Intel(R) AMT.

  

     
    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




  
  

    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.

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


  

  





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.

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


  

  





SystemName Key 
public string SystemName



  
General Information:
The Name of the scoping 
  System.

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


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The CreationClassName of the scoping 
  System.

Qualifiers:
-------------
Key
MaxLen=32
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.

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


  

  





OptInCodeTimeout 
public uint32 OptInCodeTimeout



  
General Information:
Indicates the idle timeout, in seconds, 
  after which the opt-in code expires.

Product Specific 
  Usage:
Setting of this property will fail when OptInState value is 
  "Received" or" In 
  Session".

Qualifiers:
-------------
ValueMap={0..59, 
  60..900, 901..4294967295}
Values={Reserved, Seconds Timeout, 
  Reserved1}


  

  





OptInRequired 
public uint32 OptInRequired



  
General Information:
Indicates The OptIn (User Consent) Policy 
  for Redirection operations,including KVM and IDER, or setting of boot options. 
  This value is Read Only if the system was configured in Client Control Mode 
  and Read-Write in Admin Control Mode and CanModifyOptInPolicy=true. The 
  allowed values in Admin Control Mode are: None (opt-in not required for any of 
  the features), KVM, or All (KVM+IDER+Boot options). Possible values in Client 
  Control Mode: All.

Product Specific Usage:
Additional notes: 
  
Can be changed with ADMINISTRATION_REALM permissions 
  only.

Qualifiers:
-------------
ValueMap={0, 1, 
  2..4294967294, 4294967295}
Values={None, KVM, Reserved, All}


  

  





OptInState 
public uint8 OptInState



  
General Information:
Read Only. Indicates the state of OptIn: 
  Not started: OptIn is required for sessions affected by OptInPolicy. 
  Requested: a console has requested an opt-in code, but it was not displayed to 
  the user yet. Displayed: the opt-in code was displayed to the user. Received: 
  opt-in code was successfully entered by the console operator. opt-in is not 
  required for additional redirection sessions until a timeout occurs. In 
  Session: A session that uses the consent code is currently in 
  progress

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5..255}
Values={Not started, Requested, Displayed, Received, In Session, 
  Reserved}


  

  





CanModifyOptInPolicy 
public uint8 CanModifyOptInPolicy



  
General Information:
Read Only: Indicates if Modifying the OptIn 
  Policy via WS-Management is 
  enabled.

Qualifiers:
-------------
ValueMap={0, 
  1}
Values={FALSE, TRUE}


  

  





OptInDisplayTimeout 
public uint16 OptInDisplayTimeout



  
General Information:
Defines the maximum time between session 
  request and session establishment (when user discloses the PIN on the Sprite 
  or MEBx screen to the remote operator and the operator enters the PIN). When 
  timeout expires, all displays of Sprite notifications or MEBx screens are 
  cancelled. Intel(R) recommends a minimum of 5 minutes (300 seconds). Read Only 
  in Client Control Mode, R/W in Admin Control Mode.

Product Specific 
  Usage:
Additional notes: 
Can be changed with ADMINISTRATION_REALM 
  permissions only. 
Setting of this property will fail when OptInState is 
  Requested or 
  Displayed.

Qualifiers:
-------------
ValueMap={0..9, 
  10..4095, 4096..65536}
Values={Reserved, Seconds timeout, 
Reserved1}


  

  






  
  

    Method 
Detail


StartOptIn
public uint32 StartOptIn()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM

General 
  Information:
Request an opt-in code. Intel(R) AMT generates code 
  internally.

Qualifiers:
-------------
ValueMap={0, 1, 2, 
  3, 4, ..}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_INVALID_STATE, PT_STATUS_BLOCKED, PT_STATUS_FAILED_FFS, 
  Reserved}






CancelOptIn
public uint32 CancelOptIn()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
Cancel 
  a previous opt-in code 
  request.

Qualifiers:
-------------
ValueMap={0, 1, 2, 
  ..}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_INVALID_STATE, Reserved}






SendOptInCode
public uint32 SendOptInCode([IN]uint32 OptInCode)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM

General Information:
Send the 
  opt-in code to Intel(R) 
  AMT.

Qualifiers:
-------------
ValueMap={0, 1, 2, .., 
  2057, .., 2066, ..}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR, 
  PT_STATUS_INVALID_STATE, Reserved, PT_STATUS_DATA_MISSING, Reserved1, 
  PT_STATUS_INVALID_CREDENTIALS, 
  Reserved2}


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

  

    
OptInCode 
    
General Information:
The opt-in code generated by Intel(R) 
    AMT. This code is displayed on the user screen and should be entered by the 
    remote IT 
    technician.

Qualifiers:
-------------
IN
ValueMap={0..999999, 
    1000000..}
Values={Generated Code, Reserved}







Put
public  Put([IN]IPS_OptInService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM

General Information:
Changes 
  properties of the selected instance

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

Name 
CreationClassName 
SystemName 
  
SystemCreationClassName 






Get
public  Get([OUT]IPS_OptInService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_GENERAL_INFO_REALM, ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM, 
  ADMIN_SECURITY_REMOTE_CONTROL_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






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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