AdminDomain class

Represents a group of ComputerSystem instances.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Dynamic, Provider("IPMIPrv"), UUID("{f0610966-50c3-47ab-8db5-a2f3bccf3cb1}"), AMENDMENT]
class AdminDomain : CIM_AdminDomain
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   CreationClassName;
  string   Name;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   Roles[];
  string   NameFormat;
};

Members

The AdminDomain class has these types of members:

Methods

The AdminDomain class has these methods.

Method Description
RequestStateChange Requests that the state of the element be changed to the specified value.
This method is inherited from CIM_EnabledLogicalElement.

Properties

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

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

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.

EnabledDefault

Data type: uint16

Access type: Read/write

An administrator's default or startup configuration for the EnabledState of an element. By default, the element is Enabled (2).

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

DMTF Reserved

8 32767

Vendor Reserved

32768 65535

This property is inherited from CIM_EnabledLogicalElement.

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

Indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (4) and starting (10) are transient states between enabled and disabled.

Unknown (0)

Other (1)

Enabled (2)

The element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled (3)

The element will not execute commands and will drop any new requests.

Shutting Down (4)

The element is in the process of going to a Disabled state.

Not Applicable (5)

The element does not support being enabled or disabled.

Enabled but Offline (6)

The element might be completing commands, and will drop any new requests.

In Test (7)

The element is in a test state.

Deferred (8)

The element might be completing commands, but will queue any new requests.

Quiesce (9)

The element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled (2) state, but it processes only a restricted set of commands. All other requests are queued.

Starting (10)

The element is in the process of going to an Enabled (2) state. New requests are queued.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

This property is inherited from CIM_EnabledLogicalElement.

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.

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

This property is inherited from CIM_ManagedSystemElement.

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.

Name

Data type: string

Access type: Read-only

Qualifiers: Key, Override ("Name"), MaxLen (256)

Serves as key of a System instance in an enterprise environment.

This property is inherited from CIM_System.

NameFormat

Data type: string

Access type: Read-only

Qualifiers: Override ("NameFormat"), ModelCorrespondence ("CIM_AdminDomain.Name")

How the Name of the admin domain is generated, using the heuristic specified in the CIM V2 System Model specification. It assumes that the documented rules are traversed in order, to determine and assign a Name. The NameFormat values list defines the precedence order for assigning the Name of the admin domain.

The "FC" value is deprecated and replaced by "WWN".

Other ("Other")

Autonomous System ("AS")

Network Access Provider ("NAP")

Network Operations Center ("NOC")

Point of Presence ("POP")

Regional Network Provider ("RNP")

IP ("IP")

IPX ("IPX")

SNA ("SNA")

Dial ("Dial")

WAN ("WAN")

LAN ("LAN")

ISDN ("ISDN")

Frame Relay ("Frame Relay")

ATM ("ATM")

E.164 ("E.164")

Infiniband ("IB")

Fibre Channel ("FC")

Policy Repository ("Policy Repository")

Fibre Channel Worldwide Name ("WWN")

This property is inherited from CIM_AdminDomain.

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.

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

This property is inherited from CIM_ManagedSystemElement.

OtherEnabledState

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is Other (1). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

PrimaryOwnerContact

Data type: string

Access type: Read/write

Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.4")

Information on how the primary system owner can be reached, for example phone number or email address.

This property is inherited from CIM_System.

PrimaryOwnerName

Data type: string

Access type: Read/write

Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.3")

The name of the primary system owner. The system owner is the primary user of the system.

This property is inherited from CIM_System.

RequestedState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 No Change (5). This property is set as the result of a method invocation, such as StartService or StopService on CIM_Service.

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13 32767

Vendor Reserved

32768 65535

This property is inherited from CIM_EnabledLogicalElement.

Roles

Data type: string array

Access type: Read/write

The administrator-defined roles this System plays in the managed environment. Examples might be "Building 8 print server" or "Boise user directories". A single system may perform multiple roles.

This property is inherited from CIM_System.

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.

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

"Stopped"

This property is inherited from CIM_ManagedSystemElement.

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.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

When the enabled state 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.

This property is inherited from CIM_EnabledLogicalElement.

Requirements

Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Namespace
Root\hardware
MOF
IpmiPrv.mof
DLL
IpmiPrv.dll

See also

CIM_AdminDomain

IPMI Provider