Class AMT_TimeSynchronizationService
Used in features: Network
Administration , Event Manager & User Notification
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
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
AMT_TimeSynchronizationService
class AMT_TimeSynchronizationService
- extends CIM_Service
General Information:
Exposes Intel(R) AMT time synchronization
services to management
clients.
Qualifiers:
-------------
Version=3.0.0
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 . . .
|
uint32
|
LocalTimeSyncEnabled
Determines if user with LOCAL_SYSTEM_REALM permission can set
the time.The values are: DEFAULT_TRUE - Time sync is enabled by default .
. .
|
uint32
|
TimeSource
Determines if RTC was set to UTC by any configuration
SW.
|
Methods Summary |
uint32 |
GetLowAccuracyTimeSynch(Ta0)
This method is used for reading the Intel(R) AMT device's internal
clock.
|
uint32 |
SetHighAccuracyTimeSynch(Ta0,
Tm1, Tm2) This method is used to synchronize the Intel(R) AMT
device's internal clock with an external clock . . .
|
uint32 |
EnableLocalTimeSync(Enable)
This method sets the LocalTimeSyncEnabled property.
|
|
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 Time Synchronization
Service"
Qualifiers:
-------------
Key
Override=Name
MaxLen=45
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
"AMT_TimeSynchronizationService"
Qualifiers:
-------------
Key
MaxLen=35
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=256
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) AMT Time Synchronization
Service"
Qualifiers:
-------------
MaxLen=45
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}
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}
LocalTimeSyncEnabled
public uint32 LocalTimeSyncEnabled
- General Information:
Determines if user with LOCAL_SYSTEM_REALM
permission can set the time.The values are: DEFAULT_TRUE - Time sync is
enabled by default. Was not configured to enabled or disabled by the
configuration SW.CONFIGURED_TRUE - Time Sync is enabled and configured by
configuration SW to TRUE. This option is required in order to differentiate
between legacy configuration SW that do not support this setting and new SW
that can configure it to TRUE.FALSE - Time Sync is
disabled.
Qualifiers:
-------------
ValueMap={0, 1, 2,
3..}
Values={DEFAULT_TRUE, CONFIGURED_TRUE, FALSE, RESERVED}
TimeSource
public uint32 TimeSource
- General Information:
Determines if RTC was set to UTC by any
configuration SW.
Qualifiers:
-------------
ValueMap={0,
1, 2..}
Values={BIOS_RTC, CONFIGURED, RESERVED}
GetLowAccuracyTimeSynch
public uint32 GetLowAccuracyTimeSynch([OUT]uint32 Ta0)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_NETWORK_TIME_REALM, ADMIN_SECURITY_EVENT_MANAGER_REALM,
ADMIN_SECURITY_EVENT_LOG_READER_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM,
ADMIN_SECURITY_LOCAL_SYSTEM_REALM
General Information:
This
method is used for reading the Intel(R) AMT device's internal
clock.
Qualifiers:
-------------
ValueMap={0,
1}
Values={PT_STATUS_SUCCESS,
PT_STATUS_INTERNAL_ERROR}
Parameters:
--------------
- Ta0
- General Information:
An unsigned 32-bit value representing the
local time as the number of seconds from 00:00:00, January 1, 1970 UTC. This
format is sufficient to maintain time stamps with one-second resolution past
the year 2100. This is based on a longstanding UNIX-based standard for
timekeeping, which represents time as the number of seconds from 00:00:00,
January 1, 1970 UTC. Similar time formats are used in ANSI
C.
Qualifiers:
-------------
OUT
SetHighAccuracyTimeSynch
public uint32 SetHighAccuracyTimeSynch([IN]uint32 Ta0, [IN]uint32 Tm1, [IN]uint32 Tm2)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_NETWORK_TIME_REALM,
ADMIN_SECURITY_LOCAL_SYSTEM_REALM
General Information:
This
method is used to synchronize the Intel(R) AMT device's internal clock with an
external clock.
Qualifiers:
-------------
ValueMap={0, 1, 36,
38}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
PT_STATUS_INVALID_PARAMETER,
PT_STATUS_FLASH_WRITE_LIMIT_EXCEEDED}
Parameters:
--------------
- Ta0
- General Information:
The time value received from invoking
GetLowAccuracyTimeSynch().
Qualifiers:
-------------
Required
IN
- Tm1
- General Information:
The remote client timestamp after getting
a response from GetLowAccuracyTimeSynch().
Qualifiers:
-------------
Required
IN
- Tm2
- General Information:
The remote client timestamp obtained
immediately prior to invoking this method.
Qualifiers:
-------------
Required
IN
EnableLocalTimeSync
public uint32 EnableLocalTimeSync([IN]boolean Enable)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_ADMINISTRATION_REALM,
ADMIN_SECURITY_NETWORK_TIME_REALM
General Information:
This
method sets the LocalTimeSyncEnabled
property.
Qualifiers:
-------------
ValueMap={0, 1,
2..}
Values={PT_STATUS_SUCCESS, PT_STATUS_INTERNAL_ERROR,
RESERVED}
Parameters:
--------------
- Enable
- General Information:
Determines if user with
LOCAL_SYSTEM_REALM permission can set the
time.
Qualifiers:
-------------
Required
IN
Get
public Get([OUT]AMT_TimeSynchronizationService Instance)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_NETWORK_TIME_REALM, ADMIN_SECURITY_EVENT_MANAGER_REALM,
ADMIN_SECURITY_EVENT_LOG_READER_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