Class CIM_AccountManagementService
Used in features: Simple
Identity
Compatible with the following Intel AMT Releases: 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
CIM_SecurityService
CIM_AccountManagementService
class CIM_AccountManagementService
- extends CIM_SecurityService
General Information:
CIM_AccountManagementService creates, manages,
and if necessary destroys Accounts on behalf of other
SecuritySerices.
Qualifiers:
-------------
Version=2.19.0
UMLPackagePath=CIM::User::Account
Supported Fields
Summary |
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
|
EnabledState
EnabledState is an integer enumeration that indicates the
enabled and disabled states of an element . . .
|
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
SystemCreationClassName The CreationClassName of the scoping
System.
|
string
|
SystemName The Name of the scoping System.
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass that is used in the creation of an instance .
. .
|
string
|
Name The Name property uniquely identifies the
Service and provides an indication of the functionality that is managed .
. .
|
Methods Summary |
uint32 |
CreateAccount(REF System,
AccountTemplate, REF Account, REF Identities) CreateAccount
creates an Account on the specified ComputerSystem . . .
|
|
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
|
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}
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:
In Intel AMT Release 6.0 and
later releases value is "Enabled"
(2)
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}
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 Account Management
Service"
Qualifiers:
-------------
MaxLen=44
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
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
"ManagedSystem"
Qualifiers:
-------------
Key
MaxLen=16
Propagated=CIM_System.Name
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_AccountManagementService"
Qualifiers:
-------------
Key
MaxLen=32
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 Account Management
Service"
Qualifiers:
-------------
Key
Override=Name
MaxLen=44
CreateAccount
public uint32 CreateAccount([IN]REF CIM_ComputerSystem System, [IN]string AccountTemplate, [OUT]REF CIM_Account Account, [OUT]REF CIM_Identity Identities[])
- Permission Information:
Permitted realms:
ADMIN_SECURITY_ADMINISTRATION_REALM
General
Information:
CreateAccount creates an Account on the specified
ComputerSystem. Upon successful completion of the method, there shall be a
newly created instance of CIM_Account associated through the
CIM_AccountOnSystem association with the instance of ComputerSystem identified
by the System parameter such that each property of the CIM_Account instance
has the value of the corresponding property of the template instance specified
by the AccountTemplate parameter and the CIM_Account instance is associated
with this instance of CIM_AccountManagementService through the
CIM_ServiceAffectsElement association.
Instances of CIM_Identity may be
created by the method and associated with the instance of CIM_Account through
CIM_AssignedIdentity. If one or more instances of CIM_Identity are created, a
reference to each shall be returned in the Identities parameter, otherwise the
Identities parameter shall be NULL upon method completion.
Product
Specific Usage:
Additional Notes:
1) The method returns
INTERNAL_ERROR fault in case of Audit Fail, due to DASH compliancy requirement
(DSP1034)
2) "System" parameter must be the EPR of the CIM_ComputerSystem
instance with Name field value of "ManagedSystem"
3) All key values in
"AccountTemplate" parameter are ignored (but must appear). The "Name" and
"UserID" values of the account are determined by the "UserID" input value.
"UserPassword" value is a hexadecimal representation of MD5 Hash of these
parameters concatenated together (Username + ":" + DigestRealm + ":" +
Password).
The DigestRealm is a field in AMT_GeneralSettings.
"UserPasswordEncryptionAlgorithm" value is HTTP Digest MD5(A1) (2).
Qualifiers:
-------------
ValueMap={0, 1, 2, ..,
32768..65535}
Values={Completed with No Error, Not Supported, Failed,
Method Reserved, Vendor
Specific}
Parameters:
--------------
- System
- General Information:
The scoping ComputerSystem in which to
create the
Account.
Qualifiers:
-------------
Required
IN
- AccountTemplate
- General Information:
AccountTemplate is a template for the
desired Account to be
created.
Qualifiers:
-------------
Required
IN
EmbeddedInstance=CIM_Account
- Account
- General Information:
Reference to the instance of CIM_Account
created when the method returns a value of
0.
Qualifiers:
-------------
IN=false
OUT
- Identities
- General Information:
Reference to the instances of
CIM_Identity created when the method returns a value of 0. NULL if no such
instances are
created.
Qualifiers:
-------------
IN=false
OUT
Get
public Get([OUT]CIM_AccountManagementService Instance)
- Permission Information:
This method is accessible from any
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