Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Account class

Represents a user account, which stores authentication and authorization data for the IPMI provider.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Dynamic, Provider("IPMIPrv"), AMENDMENT]
class Account : CIM_Account
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   Name;
  string   UserID;
  string   ObjectClass[];
  string   Descriptions[];
  string   Host[];
  string   LocalityName[];
  string   OrganizationName[];
  string   OU[];
  string   SeeAlso[];
  string   UserCertificate[];
  string   UserPassword[];
};

Members

The Account class has these types of members:

Properties

The Account class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

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

This property is inherited from CIM_Account.

Description
Data type: string
Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

Descriptions
Data type: string array
Access type: Read-only
Qualifiers: MaxLen (1024)

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

This property is inherited from CIM_Account.

ElementName
Data type: string
Access type: Read-only

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 ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties.

This property is inherited from CIM_ManagedElement.

HealthState
Data type: uint16
Access type: Read-only
Qualifiers: Experimental

Indicates 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 completed 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 MAY NOT be possible.

"Major Failure" (20) - The element is failing. It is possible the some or all of the functionality of this component is degraded or not working.

"Minor Failure" (15) - All functionality is available but some MAY 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 may not be operating at optimal performance or it may 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 can not report on HealthState at this time.

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (5)
Degraded/Warning (10)
Minor failure (15)
Major failure (20)
Critical failure (25)
Non-recoverable error (30)
DMTF Reserved (31–65535)
Host
Data type: string array
Access type: Read-only

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

This property is inherited from CIM_Account.

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

LocalityName
Data type: string array
Access type: Read-only

This property contains the name of a locality, such as a city, county or other geographic region.

This property is inherited from CIM_Account.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, Override ("Name") , MaxLen (1024)

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

This property is inherited from CIM_Account.

ObjectClass
Data type: string array
Access type: Read-only

In the case of an LDAP-derived instance, the ObjectClass property value(s) may be set to the objectClass attribute values.

This property is inherited from CIM_Account.

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Indicates the current status(es) 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 in more detail.

"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.

"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 element's state and configuration may need to be updated.

"Dormant" indicates that the element is inactive or quiesced.

"Supporting Entity in Error" describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.

"Power Mode" indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Other (1)
OK (2)
Degraded (3)
Stressed (4)
Predictive Failure (5)
Error (6)
Non-Recoverable Error (7)
Starting (8)
Stopping (9)
Stopped (10)
In Service (11)
No Contact (12)
Lost Communication (13)
Aborted (14)
Dormant (15)
Supporting Entity in Error (16)
Completed (17)
Power Mode (18)
DMTF Reserved (19–32767)
Vendor Reserved (32768–65535)
OrganizationName
Data type: string array
Access type: Read-only
Qualifiers: Required

The name of the organization related to the account.

This property is inherited from CIM_Account.

OU
Data type: string array
Access type: Read-only

The name of an organizational unit related to the account.

This property is inherited from CIM_Account.

SeeAlso
Data type: string array
Access type: Read-only

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

This property is inherited from CIM_Account.

Status
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus") , MaxLen (10)

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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
"Stopped"

 

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed") , ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

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

This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName") , MaxLen (256)

The scoping System's CCN.

This property is inherited from CIM_Account.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name") , MaxLen (256)

The scoping System's Name.

This property is inherited from CIM_Account.

UserCertificate
Data type: string array
Access type: Read-only
Qualifiers: OctetString

Based on inetOrgPerson and for directory compatibility, the UserCertificate property may be used to specify a public key certificate for the person.

This property is inherited from CIM_Account.

UserID
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

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

This property is inherited from CIM_Account.

UserPassword
Data type: string array
Access type: Read-only
Qualifiers: OctetString

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

This property is inherited from CIM_Account.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003 R2

Namespace

Root\hardware

MOF

IpmiPrv.mof

DLL

IpmiPrv.dll

See also

CIM_Account
IPMI Provider

 

 

Show:
© 2015 Microsoft