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

Class IPS_KVMRedirectionSettingData

Used in features: KVM
Compatible with the following Intel AMT Releases: 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_SettingData
      extended by IPS_KVMRedirectionSettingData


class IPS_KVMRedirectionSettingData
 extends CIM_SettingData


General Information:
The IPS_KVMRedirectionSettingData class 
represents configuration-related and operational parameters for the KVM 
redirection service in the Intel(R) 
AMT.

Qualifiers:
-------------
Version=6.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
The 
      user-friendly name for this instance of SettingData . . .

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     boolean 
      
    EnabledByMEBx 
      
Indicates whether the KVM feature is disabled by the BIOS's 
      MEBx settings.If the KVM feature is disabled, it cannot be enabled by any 
      other means.

  

     boolean 
      
    BackToBackFbMode 
      
Indicates whether the KVM feature is working in Back-to-Back 
      Framebuffer mode so that the next Framebuffer is sent without waiting for 
      the request from the KVM Viewer

  

     boolean 
      
    Is5900PortEnabled 
      
Port 5900 is used for interoperability with the RFB 
      protocol.Ports 16994/16995 are used to transport RFB over Intel rediection 
      protocol and includes various authentication modes which are supported by 
      the Intel redirection protocol . . .

  

     boolean 
      
    OptInPolicy 
Is opt 
      in (user consent for KVM session) enabled/disabled.

  

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

  

     uint16 
      
    SessionTimeout 
      
Session timeout for TCP session close.

  

     string 
      
    RFBPassword 
User 
      defined password for native RFB Authentication.This is a write-only field, 
      an empty string is returned when instance is read . . .

  

     uint8 
      
    DefaultScreen 
      
Default screen to use on KVM 
session




     uint8 
      
    InitialDecimationModeForLowRes 
      
Initial Decimation mode when opening a KVM session




     boolean 
      
    GreyscalePixelFormatSupported 
      
Indicates whether greyscale pixel format is supported by Intel AMT.




     boolean 
      
    ZlibControlSupported 
      
Indicates whether Intel AMT supports allowing the KVM viewer to turn the ZLIB on or off.




     boolean 
      
    DoubleBufferMode 
      
Allows enabling and disabling the double buffer capture mode




     boolean 
      
    DoubleBufferState 
      
Indicates whether double buffer capture is in use







  
  

    Methods Summary

  

     uint32
    TerminateSession() 
      
This API terminates an active KVM session . . .

  

     
    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

	  
 

     
    DataChannelRead([OUT] uint8 DataMessage[], [OUT] uint32 MessageId, 
[OUT] uint32 RealmsBitmap, [OUT] string  Username
); 
      
Allows the software in-band KVM server running on the operating system to read data from the data channel
	

 

     
    DataChannelWrite ([IN] uint8 DataMessage[]); 
      
Allows the software in-band KVM server running on the host to send (write) data to the data channel for Intel AMT to forward to the KVM viewer
	
	  
	  
	  




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
The user-friendly name for this instance of 
  SettingData. In addition, the user-friendly name can be used as an index 
  property for a search or query. (Note: The name does not have to be unique 
  within a namespace.)

Product Specific Usage:
In Intel AMT 
  Release 6.0 and later releases value is "Intel(r) KVM Redirection Settings" 
  and can't be 
  modified

Qualifiers:
-------------
Required
Override=ElementName
MaxLen=50


  

  





InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. To ensure uniqueness within the NameSpace, the value of InstanceID 
  should be constructed using the following "preferred" algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon (:), and where <OrgID> must include a 
  copyrighted, trademarked, or otherwise unique name that is owned by the 
  business entity that is creating or defining the InstanceID or that is a 
  registered ID assigned to the business entity by a recognized global 
  authority. (This requirement is similar to the <Schema Name>_<Class 
  Name> structure of Schema class names.) In addition, to ensure uniqueness, 
  <OrgID> must not contain a colon (:). When using this algorithm, the 
  first colon to appear in InstanceID must appear between <OrgID> and 
  <LocalID>. 
<LocalID> is chosen by the business entity and 
  should not be reused to identify different underlying (real-world) elements. 
  If the above "preferred" algorithm is not used, the defining entity must 
  assure that the resulting InstanceID is not reused across any InstanceIDs 
  produced by this or other providers for the NameSpace of this instance. 
  
For DMTF-defined instances, the "preferred" algorithm must be used with 
  the <OrgID> set to CIM.

Product Specific Usage:
In 
  Intel AMT Release 6.0 and later releases value is "Intel(r) KVM Redirection 
  Settings" and can't be 
  modified

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


  

  





EnabledByMEBx 
public boolean EnabledByMEBx



  
General Information:
Indicates whether the KVM feature is 
  disabled by the BIOS's MEBx settings.If the KVM feature is disabled, it cannot 
  be enabled by any other means.

Product Specific Usage:
This 
  is a read-only attribute

  

  





BackToBackFbMode 
public boolean BackToBackFbMode



  
General Information:
Indicates whether the KVM feature is 
  working in Back-to-Back Framebuffer mode so that the next Framebuffer is sent 
  without waiting for the request from the KVM Viewer. 

  

  





Is5900PortEnabled 
public boolean Is5900PortEnabled



  
General Information:
Port 5900 is used for interoperability with 
  the RFB protocol.Ports 16994/16995 are used to transport RFB over Intel 
  rediection protocol and includes various authentication modes which are 
  supported by the Intel redirection protocol. This attribute states if 5900 
  port is open, and allowed to communicate with the service.

Product 
  Specific Usage:
Can be modified only if RFBPassword is already set or 
  is set in same Put request


  End of Support Note: Port 5900 is no longer supported. For details of impact and affected releases, see Working with Port 5900.

  

  





OptInPolicy 
public boolean OptInPolicy



  
General Information:
Is opt in (user consent for KVM session) 
  enabled/disabled.

Product Specific Usage:
Can be modified 
  only by user with ADMIN_SECURITY_ADMINISTRATION_REALM permission, and only if 
  MEBx 
interface allows this setting to be modified from remote (network). 
  
Read only in Client Control Mode configuration. 
Reflects the status of 
  IPS_OptInService.OptInRequired: 
If IPS_OptInService.OptInRequired is “KVM” 
  or “All”, the value of this field is “enabled”. 
Otherwise the value of 
  this field is “disabled”. 


  

  





OptInPolicyTimeout 
public uint16 OptInPolicyTimeout



  
General Information:
Defines the maximum time between session 
  request and session establishment (when user discloses the PIN on the Sprite 
  to the remote operator and the operator enters the PIN). When timeout expires, 
  all displays of Sprite notifications are cancelled. Intel(R) recommends a 
  minimum of 5 minutes (300 seconds)

Product Specific 
  Usage:
Can be modified only by user with 
  ADMIN_SECURITY_ADMINISTRATION_REALM permission 
Reflected from the 
  IPS_OptInService.OptInDisplayTimeout

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


  

  





SessionTimeout 
public uint16 SessionTimeout



  
General Information:
Session timeout for TCP session 
  close.

Product Specific Usage:
Additional Notes: 
1) 
  maximum value is 255 
  minutes

Qualifiers:
-------------
ValueMap={0, 1..255, 
  256..65535}
Values={Infinite, Minutes timeout, Reserved}


  

  





RFBPassword 
public string RFBPassword



  
General Information:
User defined password for native RFB 
  Authentication.This is a write-only field, an empty string is returned when 
  instance is read. When writing, an empty string or lack of field will be 
  ignored. The password must be 8 characters long and contain at least 1 capital 
  letter, regular letter, digit and special character. RFB password can't accept 
  the characters: '"' ',' 
  ':'

Qualifiers:
-------------
MaxLen=8


  End of Support Note: RFB Password is no longer supported. For details of impact and affected releases, see Working with Port 5900.
  

  





DefaultScreen 
public uint8 DefaultScreen



  
General Information:
Default screen to use on KVM 
  session

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4..255}
Values={Primary screen, Secondary screen, Third screen, Fourth 
  screen, Reserved}


  

  






InitialDecimationModeForLowRes 
public uint8 InitialDecimationModeForLowRes



  
General Information:
Initial decimation mode when opening a KVM session. Decimation allows Intel AMT to request the graphics hardware to reduce the horizontal and vertical resolutions of the captured frame by 50%, thereby reducing the number of pixels in the captured frame by 75%).

  Note: This setting is relevant only when capturing from displays with resolutions of 4K and less. On resolutions above 4K, decimation is automatic and cannot be disabled.


  Available starting Intel CSME 16.0 firmware on platforms with Intel Integrated Graphics generation 13 and later.
  

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

Valid Values:

• 0: Decimation is not supported by the platform. 

• 1: Initial decimation mode is disabled for low resolutions (4K and below).

• 2: Initial decimation mode is automatic. Intel AMT activates decimation when capturing from a display with resolution 4K (3840*2160 pixels) and above.

• 3: Initial decimation mode is enabled for all resolutions of 4K and less.


Default: 2 (automatic)

  

  

  






GreyscalePixelFormatSupported 
public boolean GreyscalePixelFormatSupported



  
General Information:
Indicates whether pixel formats of 4-bit greyscale (16 shades of grey) and 8-bit greyscale (256 shades of grey) are supported by Intel AMT.

  

  Available starting Intel CSME 16.0 firmware on platforms with Intel Integrated Graphics generation 13 and later.
  

  
  
Qualifiers:
-------------
Values:

• FALSE: Greyscale pixel format is not supported by the platform's graphics hardware.

• TRUE: Greyscale pixel format is supported by the platform's graphics hardware.

Note: If Intel AMT does not return the GreyscalePixelFormatSupported field in IPS_KVMRedirectionSettingData.GET, Intel AMT does not support greyscale pixel format.
  


  

  






ZlibControlSupported 
public boolean ZlibControlSupported



  
General Information:
Indicates whether Intel AMT supports allowing the KVM viewer to turn the ZLIB on or off.

Qualifiers:
-------------
Values:

• FALSE: Zlib cannot be turned on or off by the KVM viewer.

• TRUE: Zlib can be turned on or off by the KVM viewer.
  
  

  Note: If Intel AMT does not return the ZlibControlSupported field in IPS_KVMRedirectionSettingData.GET, Intel AMT does not support Zlib control. This happens when using older firmware versions that do not support this feature.

  

  

  
About Zlib

  Zlib is software-based compression that can be used by Intel AMT KVM to further compress the captured frame. It can improve the user experience on slow networks or  minimize the amount of data transmitted over the network for users who pay according to the amount of data transmitted.
More information about Zlib 

  When Zlib control is supported, KVM by default does not use Zlib. If Intel AMT returns False as the value of ZlibControlSupported, or the ZlibControlSupported field is not returned, Intel AMT uses Zlib when the KVM session is opened over a CIRA connection.

  
  

  






DoubleBufferMode 
public boolean DoubleBufferMode



  
General Information:
Allows enabling and disabling the double buffer capture mode. 

 In double buffer capture mode, the graphics hardware captures another frame while the frame captured earlier (and stored in a separate buffer) is being analyzed. This results in a faster display during KVM sessions. 
  
  
Qualifiers:
-------------
Values:

• FALSE: Double buffer capture mode is disabled.

• TRUE: Double buffer capture mode is enabled.
 

Default: FALSE
  

  

  






DoubleBufferState 
public boolean DoubleBufferState



  
General Information:
Indicates whether double buffer capture is in use

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

 • FALSE: Double buffer capture is not in use.

• TRUE: Double buffer capture is in use.
  
  

  







  
  

    Method 
Detail


TerminateSession
public uint32 TerminateSession()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
This 
  API terminates an active KVM session. it may be issues by a local tool acting 
  on behalf of the local user which desires to terminate a remote session due to 
  privacy concerns.

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






Put
public  Put([IN]IPS_KVMRedirectionSettingData Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_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_KVMRedirectionSettingData: 

ElementName 
InstanceID 
  






Get
public  Get([OUT]IPS_KVMRedirectionSettingData Instance)



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






DataChannelRead 
public uint32 DataChannelRead  ([OUT] uint8 DataMessage[], [OUT] uint32 MessageId, 
[OUT] uint32 RealmsBitmap, [OUT] string  Username);




  
Permission Information:
Permitted realms: ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
This API allows the software in-band KVM server running on the operating system to read data from the data channel.

 
Information on data channel


Note: The software KVM server must use Intel AMT’s local admin username ($$OSAdmin) and password to invoke this method. Information on this Intel AMT user.


Qualifiers:
-------------
ValueMap={0, 1, 2, 2057, 2066}
Values={SUCCESS, INTERNAL_ERROR, NOT_READY, DATA_MISSING, UNSUPPORTED}



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

DataMessage
 

    
General Information:
The data channel message
 
	
Qualifiers:
-------------
Required
OUT

	OctetString, MaxLen = 4096



 
MessageId 


    
General Information:
ID of the received data message (incremented for each new message, can be used by the software KVM server for flow control).


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

	




RealmsBitmap 


    
General Information:
Bitmap of the realms of the Intel AMT user
 
	
Qualifiers:
-------------
Required
OUT

	

Username 


    
General Information:
Username of the Intel AMT user
 
	
Qualifiers:
-------------
Required
OUT
String, MaxLen = 32

	
	
	















DataChannelWrite 
public uint32 DataChannelWrite([IN] uint8 DataMessage[]);




  
Permission Information:
Permitted realms: ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General Information:
This API allows the software in-band KVM server running on the host to send (write) data to the data channel for Intel AMT to forward to the KVM viewer.

Information on data channel

Note: The software KVM server must use Intel AMT’s local admin username ($$OSAdmin) and password to invoke this method. Information on this Intel AMT user.


Qualifiers:
-------------
ValueMap={0, 1, 2, 2066}
Values={SUCCESS, INTERNAL_ERROR, NOT_READY, UNSUPPORTED}



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


 

    
DataMessage
 

    
General Information:
The data channel message to send
 
	
Qualifiers:
-------------
Required
IN

	OctetString, MaxLen = 4096




	
	















  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

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