Class IPS_SecIOService

Used in features: Secured IO
Compatible with the following Intel AMT Releases: 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_Service
               extended by IPS_SecIOService


class IPS_SecIOService
extends CIM_Service

General Information:
Represents the Secured IO service

Product Specific Usage:
SecuredIO is a feature that allows the ME control over a Sprite screen on the local display, and/or secured input operations.
This class allows control over the Secured IO service's settings and operational status.

Qualifiers:
-------------
Version=8.0.0


Supported Fields Summary
 boolean Started
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
 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 Status
A string indicating the current status of the object . . .
 uint16 EnabledState
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element . . .
 uint16 language
The current language to be used for Secured IO
 uint16 RequestedLanguage
The requested language to be used for Secured IO
 uint16 zoom
The zoom level to apply
 uint8 DefaultScreen
Default screen to use when using SecIO

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

Started

public boolean Started
General Information:
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).


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


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=16
Propagated=CIM_System.Name


SystemCreationClassName Key

public string SystemCreationClassName
General Information:
The CreationClassName of the scoping System.

Qualifiers:
-------------
Key
MaxLen=20
Propagated=CIM_System.CreationClassName


Status

public string Status
General Information:
A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons:
1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10


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.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


language

public uint16 language
General Information:
The current language to be used for Secured IO

Product Specific Usage:
Additional Notes:
1) Intel(r) AMT 6.0 release supports only the following languages: English, French, German, Chinese Traditional, Japanese, Russian, Italian, Spanish, Portuguese Brazil, Korean, Chinese Simplified.
2)Will also apply to the MEBx UI method, it will indicate the list of supported languages with MEBx.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 65535, ..}
Values={English, French, German, Chinese Traditional, Japanese, Russian, Italian, Spanish, Portuguese Brazil, Korean, Chinese Simplified, Arabic, Czech, Danish, Greek, Finnish, Hebrew, Hungarian, Dutch, Norwegian, Polish, Portuguese Portugal, Slovak, Slovenian, Swedish, Thai, Turkish, English (backup), Reserved}


RequestedLanguage

public uint16 RequestedLanguage
General Information:
The requested language to be used for Secured IO

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, ..}
Values={English, French, German, Chinese Traditional, Japanese, Russian, Italian, Spanish, Portuguese Brazil, Korean, Chinese Simplified, Arabic, Czech, Danish, Greek, Finnish, Hebrew, Hungarian, Dutch, Norwegian, Polish, Portuguese Portugal, Slovak, Slovenian, Swedish, Thai, Turkish, Reserved}


zoom

public uint16 zoom
General Information:
The zoom level to apply

Product Specific Usage:
Ignore when MEBx UI is used

Qualifiers:
-------------
ValueMap={1, 2, ..}
Values={No zoom, Zoom x2, Reserved}


DefaultScreen

public uint8 DefaultScreen
General Information:
Default screen to use when using SecIO

Product Specific Usage:
Additional notes:
1) DefaultScreen is supported only in Intel AMT release 6.1 and later releases.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3..255}
Values={Primary screen, Secondary screen, Third screen, 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.

Product Specific Usage:
Enables or disables Secured IO support of the system.
This operation cannot be accomplished while the SecuredIO module is active. All components that rely on SecuredIO will either fail their operation, or default to not using Secured IO, as per their design.

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



Put

public  Put([IN]IPS_SecIOService Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM, ADMIN_SECURITY_SOLIDER_REALM

General Information:
Changes properties of the selected instance

Product Specific Usage:
This method should be used to change Secured IO settings, such as the language setting and the zoom option

Get

public  Get([OUT]IPS_SecIOService Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_LOCAL_APPS_REALM, ADMIN_SECURITY_SOLIDER_REALM, 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

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