CIM2.14 Class Declaration
CIM_Account

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_Account --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_EnabledLogicalElement
NAMECIM_Account

Class Qualifiers

Class CIM_Account Qualifiers
NameTypeValueFrom Class
Versionstring2.14.0CIM_Account
UMLPackagePathstringCIM::User::AccountCIM_Account
DescriptionstringCIM_Account is the information held by a SecurityService to track identity and privileges managed by that service. Common examples of an Account are the entries in a UNIX /etc/passwd file. Several kinds of security services use various information from those entries - the /bin/login program uses the account name ('root') and hashed password to authenticate users, and the file service, for instance, uses the UserID field ('0') and GroupID field ('0') to record ownership and determine access control privileges on files in the file system. This class is defined so as to incorporate commonly-used LDAP attributes to permit implementations to easily derive this information from LDAP-accessible directories. The semantics of Account overlap with that of the class, CIM_Identity. However, aspects of Account - such as its specific tie to a System - are valuable and have been widely implemented. For this reason, the Account and Identity classes are associated using a subclass of LogicalIdentity (AccountIdentity), instead of deprecating the Account class in the CIM Schema. When an Account has been authenticated, the corresponding Identity's TrustEstablished Boolean would be set to TRUE. Then, the Identity class can be used as defined for authorization purposes.CIM_Account
UMLPackagePathstringCIM::Core::CoreElementsCIM_EnabledLogicalElement
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint.CIM_EnabledLogicalElement
UMLPackagePathstringCIM::Core::CoreElementsCIM_LogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices.CIM_LogicalElement
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedSystemElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards.CIM_ManagedSystemElement
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_Account
SystemNamestring Key
Propagated
Description
MaxLen
CIM_Account
CreationClassNamestring Key
Description
MaxLen
CIM_Account
Namestring Key
Override
Description
MaxLen
CIM_Account
UserIDstring Description
MaxLen
CIM_Account
ObjectClassstring[] Description CIM_Account
Descriptionsstring[] Description
MaxLen
CIM_Account
Hoststring[] Description CIM_Account
LocalityNamestring[] Description CIM_Account
OrganizationNamestring[] Required
Description
CIM_Account
OUstring[] Description CIM_Account
SeeAlsostring[] Description CIM_Account
UserCertificatestring[] Description
OctetString
CIM_Account
UserPasswordstring[] Description
OctetString
CIM_Account
PasswordHistoryDepthuint16 Experimental
Description
CIM_Account
PasswordExpirationdatetime Experimental
Description
CIM_Account
ComplexPasswordRulesEnforceduint16[] Experimental
Description
ValueMap
Values
CIM_Account
InactivityTimeoutdatetime Experimental
Description
CIM_Account
MaximumSuccessiveLoginFailuresuint16 Experimental
Description
CIM_Account
LastLogindatetime Experimental
Description
CIM_Account
EnabledStateuint165Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_Account
PropagatedstringCIM_System.CreationClassNameCIM_Account
DescriptionstringThe scoping System's CCN.CIM_Account
MaxLenuint32256CIM_Account

Property SystemName Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_Account
PropagatedstringCIM_System.NameCIM_Account
DescriptionstringThe scoping System's Name.CIM_Account
MaxLenuint32256CIM_Account

Property CreationClassName Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_Account
DescriptionstringCreationClassName indicates the name of the class or the subclass 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.CIM_Account
MaxLenuint32256CIM_Account

Property Name Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_Account
DescriptionstringThe Name property defines the label by which the object is known. The value of this property may be set to be the same as that of the UserID property or, in the case of an LDAP-derived instance, the Name property value may be set to the distinguishedName of the LDAP-accessed object instance.CIM_Account
MaxLenuint321024CIM_Account

Property UserID Qualifiers
NameTypeValueFrom Class
DescriptionstringUserID is the value used by the SecurityService to represent identity. For an authentication service, the UserID may be the name of the user, or for an authorization service the value which serves as a handle to a mapping of the identity.CIM_Account
MaxLenuint32256CIM_Account

Property ObjectClass Qualifiers
NameTypeValueFrom Class
DescriptionstringIn the case of an LDAP-derived instance, the ObjectClass property value(s) may be set to the objectClass attribute values.CIM_Account

Property Descriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Descriptions property values may contain human-readable descriptions of the object. In the case of an LDAP-derived instance, the description attribute may have multiple values that, therefore, cannot be placed in the inherited Description property.CIM_Account
MaxLenuint321024CIM_Account

Property Host Qualifiers
NameTypeValueFrom Class
DescriptionstringBased on RFC1274, the host name of the system(s) for which the account applies. The host name may be a fully-qualified DNS name or it may be an unqualified host name.CIM_Account

Property LocalityName Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property contains the name of a locality, such as a city, county or other geographic region.CIM_Account

Property OrganizationName Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_Account
DescriptionstringThe name of the organization related to the account.CIM_Account

Property OU Qualifiers
NameTypeValueFrom Class
DescriptionstringThe name of an organizational unit related to the account.CIM_Account

Property SeeAlso Qualifiers
NameTypeValueFrom Class
DescriptionstringIn the case of an LDAP-derived instance, the SeeAlso property specifies distinguished name of other Directory objects which may be other aspects (in some sense) of the same real world object.CIM_Account

Property UserCertificate Qualifiers
NameTypeValueFrom Class
DescriptionstringBased on inetOrgPerson and for directory compatibility, the UserCertificate property may be used to specify a public key certificate for the person.CIM_Account
OctetStringbooleantrueCIM_Account

Property UserPassword Qualifiers
NameTypeValueFrom Class
DescriptionstringIn the case of an LDAP-derived instance, the UserPassword property may contain an encrypted password used to access the person's resources in a directory.CIM_Account
OctetStringbooleantrueCIM_Account

Property PasswordHistoryDepth Qualifiers
NameTypeValueFrom Class
DescriptionstringPasswordHistoryDepth indicates the number of previous passwords that shall be maintained for the Account. The Account shall preclude the selection of a password if it occurs in the password history. A value of zero shall indicate that a password history is not maintained.CIM_Account

Property PasswordExpiration Qualifiers
NameTypeValueFrom Class
DescriptionstringPasswordExpiration indicates the maximum password age enforced for the Account. The value may be expressed as an absolute date-time as an interval, or may be NULL. An absolute date-time shall indicate the date and time when the password will expire. An interval value shall indicate the time remaining until the password expires. A value of NULL shall indicate the password never expires.CIM_Account

Property ComplexPasswordRulesEnforced Qualifiers
NameTypeValueFrom Class
DescriptionstringComplexPasswordRulesEnforced indicates the rules for constructing a complex password enforced by the Account. Minimum Length a minimum length is enforced for passwords for the account. Preclude User ID inclusion precluding the password from including the user ID is supported. Maximum Repeating Characters a limit will be enforced on the number of times a character can occur consecutively. Lower Case Alpha at least one lower case alpha character is required. Upper Case Alpha at least one upper case alpha character is required. Numeric Character at least one numeric character is required. Special Character at least one special character is required.CIM_Account
ValueMapstring
[See below.]
CIM_Account
ValuesstringMinimum Length
Preclude User ID Inclusion
Maximum Repeating Characters
Lower Case Alpha
Upper Case Alpha
Numeric Character
Special Character
DMTF Reserved
Vendor Reserved
CIM_Account

NameValue
2Minimum Length
3Preclude User ID Inclusion
4Maximum Repeating Characters
5Lower Case Alpha
6Upper Case Alpha
7Numeric Character
8Special Character
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property InactivityTimeout Qualifiers
NameTypeValueFrom Class
DescriptionstringInactivityTimeout specifies the interval after which if an account has been inactive, it shall be Disabled. The value may be expressed in interval format, as an absolute date-time, or be NULL. An absolute date-time shall indicate when the password will be disabled due to inactivity. An interval value shall indicate the time remaining before the password is disabled due to inactivity. A value of NULL shall indicate that the Account will not be disabled due to inactivity.CIM_Account

Property MaximumSuccessiveLoginFailures Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximumSuccessiveLoginFailures indicates the number of successive failed login attempts that shall result in the Account being disabled. A value of zero shall indicate that the Account will not be disabled due to successive failed login attempts.CIM_Account

Property LastLogin Qualifiers
NameTypeValueFrom Class
DescriptionstringLastLogin shall be an absolute date-time that specifies the last successful authentication that occurred for this Account. A value of 99990101000000.000000+000 shall indicate the Account has never been used. A value of NULL shall indicate the last successful login is unknown.CIM_Account

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState 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.CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateCIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateCIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration that indicates the last requested or desired state for the element. 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. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. 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. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateCIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
Quiesce
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
9Quiesce
..DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.CIM_ManagedSystemElement
MaxLenuint321024CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). "Power Mode" indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsCIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.CIM_ManagedSystemElement
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusCIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: "Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. "Critical Failure" (25) - The element is non-functional and recovery might not be possible. "Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. "Minor Failure" (15) - All functionality is available but some might be degraded. "Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. "OK" (5) - The element is fully functional and is operating within normal operational parameters and without error. "Unknown" (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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.CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests 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.CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted 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
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedStateCIM_EnabledLogicalElement

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrueCIM_EnabledLogicalElement
DescriptionstringThe 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.CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedStateCIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrueCIM_EnabledLogicalElement
DescriptionstringA 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.CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_AccountOnSystemCIM_AccountPartComponent
CIM_AccountMapsToAccountCIM_AccountAntecedent
CIM_AccountMapsToAccountCIM_AccountDependent
CIM_SecurityServiceUsesAccountCIM_AccountAntecedent
CIM_UsersAccountCIM_AccountAntecedent
CIM_ManagesAccountCIM_AccountDependent
CIM_AccountIdentityCIM_AccountSystemElement
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_SuppliesPowerCIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_AssociatedSensorCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_AssociatedBatteryCIM_ManagedSystemElementDependent
CIM_AssociatedCoolingCIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement