Class CIM_RedirectionService
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
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
CIM_RedirectionService
class CIM_RedirectionService
- extends CIM_Service
General Information:
RedirectionService provides the capability to
manage redirection services. Examples of this include any video stream directed
to a Network Port (by the operating system) on a Computer System redirected out
to a remote administrator's console. Similarly this can include input redirected
into the same Network Port. Other examples include the redirection of IO from a
logical element to a remote or local destination. Each redirection stream is
accessible via a SAP. This service can support multiple redirection types via
multiple associated SAPs.
Product Specific Usage:
The class
implementation is required by DSP1076 (KVM Redirection Profile) and it uses to
represent the KVM service of Intel (r) AMT.
Qualifiers:
-------------
Version=2.17.0
UMLPackagePath=CIM::Network::ConsoleProtocols
Supported Fields
Summary |
string
|
Name The Name property uniquely identifies the
Service and provides an indication of the functionality that is managed .
. .
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass that is used in the creation of an instance .
. .
|
string
|
SystemName The Name of the scoping System.
|
string
|
SystemCreationClassName The CreationClassName of the scoping
System.
|
string
|
ElementName A
user-friendly name for the object . . .
|
uint16
|
EnabledState
EnabledState is an integer enumeration that indicates the
enabled and disabled states of an element . . .
|
uint16
|
RequestedState
RequestedState is an integer enumeration that indicates the
last requested or desired state for the element, irrespective of the
mechanism through which it was requested . . .
|
uint16[]
|
RedirectionServiceType
An enumerated array indicating the type(s) of Redirection
supported by this Service . . .
|
uint16
|
MaxCurrentEnabledSAPs
Maximum number of concurrently enabled redirection SAPs . .
.
|
uint16
|
SharingMode An
enumeration specifying the impact of enabling the redirection of the text
console flow on the original destination of the flow . .
.
|
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 . .
.
|
|
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
|
Name
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 KVM Redirection
Service"
Qualifiers:
-------------
Key
Override=Name
MaxLen=40
CreationClassName
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
"CIM_RedirectionService"
Qualifiers:
-------------
Key
MaxLen=256
SystemName
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=20
Propagated=CIM_System.Name
SystemCreationClassName
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) ME KVM Redirection
Service"
Qualifiers:
-------------
MaxLen=40
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.
Product Specific Usage:
Only states 2 (Enabled) or 3
(Disabled) values are applicable.
"Enabled" value means that the feature
is enabled by remoteinterface (network).
"Disabled" value means that the
feature is disabled by remote (network) interface - Remote enablement
modification is controlled via
CIM_KVMRedirectionSAP.RequestStateChange().
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}
RequestedState
public uint16 RequestedState
- General Information:
RequestedState is an integer enumeration
that indicates the last requested or desired state for the element,
irrespective of the mechanism through which it was requested. The actual state
of the element is represented by EnabledState. This property is provided to
compare the last requested and current enabled or disabled states. Note that
when EnabledState is set to 5 ("Not Applicable"), then this property has no
meaning. Refer to the EnabledState property description for explanations of
the values in the RequestedState enumeration.
"Unknown" (0) indicates the
last requested state for the element is unknown.
Note that the value "No
Change" (5) has been deprecated in lieu of indicating the last requested state
is "Unknown" (0). If the last requested or desired state is unknown,
RequestedState should have the value "Unknown" (0), but may have the value "No
Change" (5).Offline (6) indicates that the element has been requested to
transition to the Enabled but Offline EnabledState.
It should be noted
that there are two new values in RequestedState that build on the statuses of
EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing
a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the
element is first "Disabled" and then "Enabled". The distinction between
requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests
an orderly transition to the Disabled state, and might involve removing power,
to completely erase any existing state. The Disabled state requests an
immediate disabling of the element, such that it will not execute or accept
any commands or processing requests.
This property is set as the
result of a method invocation (such as Start or StopService on CIM_Service),
or can be overridden and defined as WRITEable in a subclass. The method
approach is considered superior to a WRITEable property, because it allows an
explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the
EnabledLogicalElement, the property shall be NULL or have the value 12 "Not
Applicable".
Qualifiers:
-------------
ValueMap={0, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled,
Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot,
Reset, Not Applicable, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
RedirectionServiceType
public uint16[] RedirectionServiceType
- General Information:
An enumerated array indicating the type(s)
of Redirection supported by this Service. This value is set to the type of
redirection service that this service represents. A value set to 2 = "Text"
shall indicate a Text Console Redirection service. A value set to 3 = "KVM"
shall indicate a Keyboard, Mouse and Video Console Redirection service. A
value set to 4 = "USB" shall indicate a USB Redirection service. A value set
to 5 = "media" shall indicate a traditional Media Redirection
service.
Product Specific Usage:
In Intel AMT Release 6.0 and
later releases value is 3
(KVM)
Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4,
5, 6..32767, 32768..65535}
Values={Unknown, Other, Text, KVM, USB, Media,
DMTF Reserved, Vendor
Specified}
ModelCorrespondence={CIM_RedirectionService.OtherRedirectionServiceType}
MaxCurrentEnabledSAPs
public uint16 MaxCurrentEnabledSAPs
- General Information:
Maximum number of concurrently enabled
redirection SAPs. The Service may have multiple (more than this number) SAPs
associated with it. However, the number of Active SAPs (EnabledState=Enabled)
associated with this Service instance cannot exceed this number. This
limitation could come from hardware limitations (e.g. one COM port can only
redirect the text to one console), or from any other software resource
limitations.
SharingMode
public uint16 SharingMode
- General Information:
An enumeration specifying the impact of
enabling the redirection of the text console flow on the original destination
of the flow. The original destination is modeled as a concrete subclass of
LogicalDevice and associated to this service using a ServiceAffectsElement
association). If this value is Exclusive, it shall mean that when the element
flow is actively being redirected, then the element being redirected cannot be
accessed at the original destination. If this value is Shared, it shall mean
that when the element flow is actively being redirected, then the element
being redirected can still be accessed at the original
destination.
Product Specific Usage:
In Intel AMT Release 6.0
and later releases value is 3
(Shared)
Qualifiers:
-------------
ValueMap={0, 2,
3}
Values={Unknown, Exclusive, Shared}
RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_ADMINISTRATION_REALM, ADMIN_SECURITY_SOLIDER_REALM,
ADMIN_SECURITY_LOCAL_SYSTEM_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:
Method is not supported - returns value 1 (Not
Supported)
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
Get
public Get([OUT]CIM_RedirectionService 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