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

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

[Provider("IPMIPrv"), Dynamic, 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;
  string   OtherEnabledState;
  uint16   RequestedState;
  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.

MethodDescription
RequestStateChange

Initiates a requests to change the state of an admin domain.

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) , Dynamic

The short description of the admin domain. Fixed value: "MAP Addressing Root".

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 to create the AdminDomain instance.

Fixed value: "AdminDomain". This property is inherited from CIM_System.

Description
Data type: string
Access type: Read-only

The description of the admin domain. Fixed value: "DMTF WBEM/CIM SMA Management Access Point (MAP) Addressing Root".

This property is inherited from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only

The user-friendly name of the admin domain. Fixed value: "Management Access Point (MAP) Addressing Root".

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Read/write

Indicates the default startup configuration for the EnabledState property.

Default value: "2". This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

5

Not Applicable

6

Enabled but Offline

7

No Default

8–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

EnabledState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.OtherEnabledState)

Indicates whether the admin domain is enabled, or in a related state. Default value: "5" (not applicable).

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

1

Other

2

Enabled

3

Disabled

4

Shutting Down

5

Not Applicable

6

Enabled but Offline

7

In Test

8

Deferred

9

Quiesce

10

Starting

11–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

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

Indicates the current health of the admin domain.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

5

OK

10

Degraded/Warning

15

Minor failure

20

Major failure

25

Critical failure

30

Non-recoverable error

31–65535

DMTF Reserved

 

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

The datetime value that indicates when the admin domain was installed.

This property is inherited from CIM_ManagedSystemElement.

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

The user-friendly name of the admin domain. This property contains the same value as the ElementName property.

Fixed value: "Management Access Point (MAP) Addressing Root". This property is inherited from CIM_System.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: Override (NameFormat) , ModelCorrespondence (CIM_AdminDomain.Name)

A string that defines of how the Name property is generated.

Fixed value: "AS". This property is inherited from CIM_AdminDomain.

This property contains one of the following values:

ValueMeaning
Other

Other

AS

Autonomous System

NAP

Network Access Provider

NOC

Network Operations Center

POP

Point of Presence

RNP

Regional Network Provider

IP

IP

IPX

IPX

SNA

SNA

Dial

Dial

WAN

WAN

LAN

LAN

ISDN

ISDN

Frame Relay

Frame Relay

ATM

ATM

E.164

E.164

IB

Infiniband

FC

Fibre Channel

Policy Repository

Policy Repository

WWN

Fibre Channel Worldwide Name

 

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

An array that contains the status of the admin domain.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Other

2

OK

3

Degraded

4

Stressed

5

Predictive Failure

6

Error

7

Non-Recoverable Error

8

Starting

9

Stopping

10

Stopped

11

In Service

12

No Contact

13

Lost Communication

14

Aborted

15

Dormant

16

Supporting Entity in Error

17

Completed

18

Power Mode

19–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

OtherEnabledState
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.EnabledState)

Describes the value of the EnabledState property when it is set to "1" (other).

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)

A set of contact information of the primary system owner.

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

Indicates the last requested state of the admin domain. The actual state of the admin domain is represented by the EnabledState property.

Default value: "12".

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

4

Shut Down

5

No Change

6

Offline

7

Test

8

Deferred

9

Quiesce

10

Reboot

11

Reset

12

Not Applicable

13–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

Roles
Data type: string array
Access type: Read/write

An array of strings that contains the administrator defined roles of the admin domain in a managed environment.

Fixed value: "Management Access Point (MAP) Addressing Root". This property is inherited from CIM_System.

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

Note  This property is deprecated. Instead, use OperationalStatus.

The status of the admin domain.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
OK

The admin domain is functioning without errors.

Error

The admin domain experienced an error.

Degraded

The admin domain is functioning but some features are turned off.

Unknown

The status of the admin domain is unknown.

Pred Fail

The admin domain experienced a predictive failure.

Starting

The admin domain is being started.

Stopping

The admin domain is being shut down.

Service

The admin domain is being serviced.

Stressed

The admin domain is having performance issues.

NonRecover

The admin domain has an error and cannot recover.

No Contact

There is no contact with the admin domain.

Lost Comm

Communication with the admin domain has been lost.

Stopped

The admin domain is not running, however, it might be possible to restart the admin domain.

 

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

An array of strings that describe the details of the corresponding array values in the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date and time of the last change to the value of the EnabledState property.

This property is inherited from CIM_EnabledLogicalElement.

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_AdminDomain
IPMI Provider

 

 

Show:
© 2015 Microsoft