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

Class AMT_RedirectionService

Used in features: Redirection , General Info , Security Administration
Compatible with the following Intel AMT Releases: 3.0, 3.2, 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_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by AMT_RedirectionService


class AMT_RedirectionService
 extends CIM_Service


General Information:
Represents the redirection service, which 
encompasses the IDER and SOL redirection 
functionalities

Qualifiers:
-------------
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 . . .

  

     boolean 
      
    ListenerEnabled 
      
Describes the listener state of this service . . .

  

     string[16] 
      
    AccessLog 
A list of 
      string elements, describing recent IDE redirection operations . . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . 
.




  
  

    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
    TerminateSession(SessionType) 
      
Terminate an ongoing redirection 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




  
  

    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 Redirection 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_RedirectionService'

Qualifiers:
-------------
Key
MaxLen=25


  

  





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 'Intel(r) 
  AMT'

Qualifiers:
-------------
Key
MaxLen=15
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 Redirection 
  Service'

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


  

  





ListenerEnabled 
public boolean ListenerEnabled



  
General Information:
Describes the listener state of this 
  service. The service is operational only if its EnabledState is set to Enabled 
  (by the Intel(R) AMT Administrator) and the ListenerEnabled is set to TRUE (by 
  a RedirectionRealm user)

Product Specific Usage:
This 
  property is only visible / usable for users of ADMIN_SECURITY_SOLIDER realm. 
  

Additional Notes: 
1) 'ListenerEnabled' is a required property in 
  Intel AMT Release 3.2 and earlier releases.

  

  





AccessLog 
public string[16] AccessLog



  
General Information:
A list of string elements, describing 
  recent IDE redirection operations. The format of each element is: 'Date 
  (MM/DD/YYYY), Time (hh:mm:ss), IP:Port'

Product Specific 
  Usage:
This is a read-only 
  property.

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


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is an integer enumeration that 
  indicates the enabled and disabled states of an element. It can also indicate 
  the transitions between these requested states. For example, shutting down 
  (value=4) and starting (value=10) are transient states between enabled and 
  disabled. The following text briefly summarizes the various enabled and 
  disabled states: 
Enabled (2) indicates that the element is or could be 
  executing commands, will process any queued commands, and queues new requests. 
  
Disabled (3) indicates that the element will not execute commands and will 
  drop any new requests. 
Shutting Down (4) indicates that the element is in 
  the process of going to a Disabled state. 
Not Applicable (5) indicates the 
  element does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might be completing commands, and will drop any 
  new requests. 
Test (7) indicates that the element is in a test state. 
  
Deferred (8) indicates that the element might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode. The behavior of the element is similar to 
  the Enabled state, but it processes only a restricted set of commands. All 
  other requests are queued. 
Starting (10) indicates that the element is in 
  the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
Override=EnabledState
ValueMap={0, 
  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768, 32769, 32770, 32771, 
  32772..65535}
Values={Unknown, Other, Enabled, Disabled, Shutting Down, Not 
  Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF 
  Reserved, IDER and SOL are disabled, IDER is enabled and SOL is disabled, SOL 
  is enabled and IDER is disabled, IDER and SOL are enabled, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  






  
  

    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. 
If 0 is returned, then the 
  task completed successfully and the use of ConcreteJob was not required. If 
  4096 (0x1000) is returned, then the task will take some time to complete, 
  ConcreteJob will be created, and its reference returned in the output 
  parameter Job. Any other return code indicates an error 
  condition.

Product Specific Usage:
Additional Notes: 
1) 
  In Intel AMT Release 5.0 and earlier releases 'datetime' format is simple 
  string. In Intel AMT Release 5.1 and later releases 'datetime' format is as 
  defined in DSP0230 'DMTF WS-CIM Mapping Specification'. 
2) AMT doesn't 
  support the TimeoutPeriod parameter (only value 0 is valid). 
3) The 
  supported values in RequestedState are 
  32768-32771.

Qualifiers:
-------------
Override=RequestStateChange
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'), 3 ('Timeout'), 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, 32769, 32770, 32771, 
    32772..65535}
Values={Enabled, Disabled, Shut Down, Offline, Test, Defer, 
    Quiesce, Reboot, Reset, DMTF Reserved, disable IDER and SOL, enable IDER and 
    disable SOL, enable SOL and disable IDER, enable IDER and SOL, Vendor 
    Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}


    
Job 
    
General Information:
Reference to the job (can be null if the 
    task is 
    completed).

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' must be 
    returned.

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







TerminateSession
public uint32 TerminateSession([IN]uint32 SessionType)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Terminate an ongoing redirection 
  session

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  ..}
Values={SUCCESS, INTERNAL_ERROR, INVALID_PARAMS, INVALID_STATE, 
  Reserved}


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

  

    
SessionType 
    
General Information:
The session type to 
    cancel

Qualifiers:
-------------
IN
ValueMap={0, 1, 
    2..}
Values={IDER, SOL, Reserved}







Put
public  Put([IN]AMT_RedirectionService Instance)



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

Name 
(cannot be modified) 
  
CreationClassName 
(cannot be modified) 
SystemName (cannot be 
  modified) 
SystemCreationClassName (cannot be modified) 
  
ListenerEnabled





Get
public  Get([OUT]AMT_RedirectionService Instance)



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



  
  

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