WS-Management > WS-Management Class Reference > IPS Classes > IPS_ScreenConfigurationService
SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class IPS_ScreenConfigurationService

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by IPS_ScreenConfigurationService


class IPS_ScreenConfigurationService
 extends CIM_Service


General Information:
Configures the screen blanking settings in the 
Intel(R) AMT 
subsystem.

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

  

     uint16 
      
    CurrentState 
      
Indicates if currently screen blanking session is open . . 
    .

  

     uint16 
      
    EnabledState 
      
Indicates if currently screen blanking is enabled, i.e . . 
    .

  

     uint16 
      
    RemainingConsecutiveRebootsNum 
      
number of remaining conscutive reboots that will end the screen 
      blanking session . . .




  
  

    Methods Summary

  

     uint32
    RequestStateChange(RequestedState, REF 
      Job, TimeoutPeriod) 
Requests that the state of the element be 
      changed to the value specified in the RequestedState parameter . . 
.

  

     uint32
    SetSessionState(SessionState, 
      ConsecutiveRebootsNum) 
AMT will start a screen blanking session 
      and require the GFX to blank all the screens connected to the iGFX 
      simultaneously.

  

     
    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.

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


  

  





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=40


  

  





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=30
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


  

  





CurrentState 
public uint16 CurrentState



  
General Information:
Indicates if currently screen blanking 
  session is open. This property is read 
  only.

Qualifiers:
-------------
ValueMap={0, 1, 
  2..}
Values={Close, Open, Reserved}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
Indicates if currently screen blanking is 
  enabled, i.e. screen blanking session can be opened.

  

  





RemainingConsecutiveRebootsNum 
public uint16 RemainingConsecutiveRebootsNum



  
General Information:
number of remaining conscutive reboots that 
  will end the screen blanking session. If the value is 0 AMT will not blank the 
  screen after a reboot.Only a warm reset should be counted as a reboot. Global 
  reset or a power cycle reset will not survive the screen blanking session.This 
  property is read 
  only.

Qualifiers:
-------------
ValueMap={0..3, 
  4..}
Values={Number of screen blanking reboots, Reserved}


  

  






  
  

    Method 
Detail


RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Requests that the state of the element be changed to the 
  value specified in the RequestedState parameter. When the requested state 
  change takes place, the EnabledState and RequestedState of the element will be 
  the same. Invoking the RequestStateChange method multiple times could result 
  in earlier requests being overwritten or lost. 
A return code of 0 shall 
  indicate the state change was successfully initiated. 
A return code of 3 
  shall indicate that the state transition cannot complete within the interval 
  specified by the TimeoutPeriod parameter. 
A return code of 4096 (0x1000) 
  shall indicate the state change was successfully initiated, a ConcreteJob has 
  been created, and its reference returned in the output parameter Job. Any 
  other return code indicates an error 
  condition.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 
  32768..65535}
Values={Completed with No Error, Not Supported, Unknown or 
  Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid 
  Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, 
  Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method 
  Reserved, Vendor 
  Specific}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


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

  

    
RequestedState 
    
General Information:
The state requested for the element. This 
    information will be placed into the RequestedState property of the instance 
    if the return code of the RequestStateChange method is 0 ('Completed with No 
    Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the 
    EnabledState and RequestedState properties for the detailed explanations of 
    the RequestedState 
    values.

Qualifiers:
-------------
IN
ValueMap={2, 3, 
    4, 6, 7, 8, 9, 10, 11, .., 32768..65535}
Values={Enabled, Disabled, Shut 
    Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
Job 
    
General Information:
May contain a reference to the 
    ConcreteJob created to track the state transition initiated by the method 
    invocation.

Qualifiers:
-------------
IN=false
OUT


    
TimeoutPeriod 
    
General Information:
A timeout period that specifies the 
    maximum amount of time that the client expects the transition to the new 
    state to take. The interval format must be used to specify the 
    TimeoutPeriod. A value of 0 or a null parameter indicates that the client 
    has no time requirements for the transition. 
If this property does not 
    contain 0 or null and the implementation does not support this parameter, a 
    return code of 'Use Of Timeout Parameter Not Supported' shall be 
    returned.

Qualifiers:
-------------
IN







SetSessionState
public uint32 SetSessionState([IN]uint8 SessionState, [IN]uint8 ConsecutiveRebootsNum)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, 
  ADMIN_SECURITY_SOLIDER_REALM

General Information:
AMT will 
  start a screen blanking session and require the GFX to blank all the screens 
  connected to the iGFX 
  simultaneously.

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


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

  

    
SessionState 
    
General Information:
Open if required to open session blanking 
    session, Otherwise, (close session) the parameter is 
    Close.

Qualifiers:
-------------
In
ValueMap={0, 1, 
    2..}
Values={Close, Open, Reserved}


    
ConsecutiveRebootsNum 
    
General Information:
If SessionState is Open, reflects number 
    of reboots session should 
    survive.

Qualifiers:
-------------
In
ValueMap={0..3, 
    4..}
Values={Number of screen blanking reboots, 
  Reserved}







Put
public  Put([IN]IPS_ScreenConfigurationService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Changes properties of the selected 
  instance

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

Name 
CreationClassName 
SystemName 
SystemCreationClassName 
  






Get
public  Get([OUT]IPS_ScreenConfigurationService Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_SOLIDER_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





See Also:


Class 
CIM_OpaqueManagementDataService



  
  

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