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)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class 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

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)

Human-readable descriptions of the object.

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.

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.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

The implementation can not report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

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.

Minor failure (15)

All functionality is available but some may be degraded.

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.

Critical failure (25)

The element is non-functional and recovery may not be possible.

Non-recoverable error (30)

The element has completed failed and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

Host

Data type: string array

Access type: Read-only

The host names of the systems to which the account applies. A 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

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 label by which the object is known. This property may be set to the same as the UserID property. In the case of an LDAP-derived instance, this property may be set to the distinguishedName of the LDAP-accessed object.

This property is inherited from CIM_Account.

ObjectClass

Data type: string array

Access type: Read-only

In the case of an LDAP-derived instance, 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 of the element. Various operational statuses are defined. Many of the enumeration's values are self- explanatory.

OperationalStatus replaces the Status property 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. 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 should also provide the primary status of the element since it is single-valued.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

The element is functioning, but needs attention. Examples of Stressed states are overload and overheated.

Predictive Failure (5)

The element is functioning nominally but predicting a failure in the near future.

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

Implies a clean and orderly stop

In Service (11)

The element is being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

The element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

Implies an abrupt stop where the element's state and configuration may need to be updated.

Dormant (15)

The element is inactive or quiesced.

Supporting Entity in Error (16)

This element may be OK but 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 (17)

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 succeeded or not. Completed with Degraded would imply the operation finished, but did not complete OK or report an error.

Power Mode (18)

The element has additional power model information contained in the Associated PowerManagementService association.

DMTF Reserved

Vendor Reserved

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 distinguished names of other Directory objects which are, in some sense, other aspects 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. This property is deprecated in favor of OperationalStatus, which includes the same semantics in its enumeration.

This property is inherited from CIM_ManagedSystemElement.

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

This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The name of the class used in the creation of the scoping system

This property is inherited from CIM_Account.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The name of the scoping system

This property is inherited from CIM_Account.

UserCertificate

Data type: string array

Access type: Read-only

Qualifiers: OctetString

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)

The value used by the security service 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 the identity.

This property is inherited from CIM_Account.

UserPassword

Data type: string array

Access type: Read-only

Qualifiers: OctetString

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 2008
Namespace
 Root\hardware
MOF
IpmiPrv.mof
DLL
IpmiPrv.dll

See also

CIM_Account

IPMI Provider