Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_DomainMemberCS --> CIM_SystemComponent --> CIM_Component --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SystemComponent NAME CIM_DomainMemberCS
Class CIM_DomainMemberCS Qualifiers Name Type Value From Class Association boolean true CIM_DomainMemberCS Experimental boolean true CIM_DomainMemberCS Aggregation boolean true CIM_DomainMemberCS Composition boolean true CIM_DomainMemberCS Version string 2.17.0 CIM_DomainMemberCS UMLPackagePath string CIM::Core::CoreElements CIM_DomainMemberCS Description string AdminDomain instances can represent the aggregation of computer systems for the purposes of administration of the set as a unit. For example, a use of this class is to collect computer systems that together are a high performance cluster. DomainMemberCS reports the membership in the domain and the status and states of each member. The status of a member from the point of view of a domain can be different than the status as reported for the member itself. CIM_DomainMemberCS Association boolean true CIM_SystemComponent Aggregation boolean true CIM_SystemComponent Version string 2.10.0 CIM_SystemComponent UMLPackagePath string CIM::Core::CoreElements CIM_SystemComponent Description string CIM_SystemComponent is a specialization of the CIM_Component association that establishes 'part of' relationships between a System and any ManagedSystemElements of which it is composed. Use this association with caution when using it instead of a subclass such as SystemDevice or a peer association such as HostedService. This class is very broadly defined, which can lead to erroneous use. For example, Access Points that are dependent on (and hosted on) a System are NOT Components of the System. The System is not made up of any AccessPoint 'parts', which is why a Dependency association, HostedAccessPoint, was defined. Similarly, a PhysicalPackage is not a 'part' of a System, because the physical element exists independently of any internal components, software, and so on. In fact, again, a Dependency relationship is true where a ComputerSystem is Dependent on its packaging, as described by the ComputerSystemPackage association. CIM_SystemComponent Association boolean true CIM_Component Aggregation boolean true CIM_Component UMLPackagePath string CIM::Core::CoreElements CIM_Component Description string CIM_Component is a generic association used to establish 'part of' relationships between Managed Elements. For example, it could be used to define the components or parts of a System. CIM_Component
Properties Name Type Value Qualifiers ClassOrigin GroupComponent CIM_AdminDomain ref Aggregate
Override
Max
Description
KeyCIM_DomainMemberCS PartComponent CIM_ComputerSystem ref Override
Description
KeyCIM_DomainMemberCS PrimaryStatus uint16 Description
ValueMap
Values
ModelCorrespondenceCIM_DomainMemberCS DetailedStatus uint16 Experimental
Description
ValueMap
Values
ModelCorrespondenceCIM_DomainMemberCS OperatingStatus uint16 Description
ValueMap
Values
ModelCorrespondenceCIM_DomainMemberCS CommunicationStatus uint16 Description
ValueMap
ValuesCIM_DomainMemberCS MemberRole uint16[] Description
ValueMap
ValuesCIM_DomainMemberCS MemberState uint16 Description
ValueMap
ValuesCIM_DomainMemberCS Property Qualifiers
Property GroupComponent Qualifiers Name Type Value From Class Aggregate boolean true CIM_DomainMemberCS Max uint32 1 CIM_DomainMemberCS Description string The AdminDomain that contains and/or aggregates other Systems. CIM_DomainMemberCS Key boolean true CIM_DomainMemberCS
Property PartComponent Qualifiers Name Type Value From Class Description string The member ComputerSystem. CIM_DomainMemberCS Key boolean true CIM_DomainMemberCS
Property PrimaryStatus Qualifiers Name Type Value From Class Description string PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. The status from the point of view of the AdminDoman can be different from that of the member. The instrumentation may be different between that for the AdminDomain and that for the ComputerSystem.For example, the AdminDomain instrumentation may not be able to communicate with the ComputerSystem; however, the ComputerSystem is functioning. In this example, the communication problem was neither the AdminDomain nor the ComputerSystem but in the network connecting them. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Unknown
OK
Degraded
Error
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS ModelCorrespondence string CIM_ManagedSystemElement.DetailedStatus
CIM_ManagedSystemElement.HealthStateCIM_DomainMemberCS
Name Value 0 Unknown 1 OK 2 Degraded 3 Error .. DMTF Reserved 0x8000.. Vendor Reserved
Property DetailedStatus Qualifiers Name Type Value From Class Description string DetailedStatus compliments PrimaryStatus with additional status detail. The status from the point of view of the AdminDoman can be different from that of the member. The instrumentation may be different between that for the AdminDomain and that for the ComputerSystem.For example, the AdminDomain instrumentation may not be able to communicate with the ComputerSystem; however, the ComputerSystem is functioning. In this example, the communication problem was neither the AdminDomain nor the ComputerSystem but in the network connecting them. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK". "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 normally but a failure is predicted in the near future. "Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention. "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. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Not Available
No Additional Information
Stressed
Predictive Failure
Non-Recoverable Error
Supporting Entity in Error
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS ModelCorrespondence string CIM_EnabledLogicalElement.PrimaryStatus
CIM_ManagedSystemElement.HealthStateCIM_DomainMemberCS
Name Value 0 Not Available 1 No Additional Information 2 Stressed 3 Predictive Failure 4 Non-Recoverable Error 5 Supporting Entity in Error .. DMTF Reserved 0x8000.. Vendor Reserved
Property OperatingStatus Qualifiers Name Type Value From Class Description string OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. The status from the point of view of the AdminDoman can be different from that of the member. The instrumentation may be different between that for the AdminDomain and that for the ComputerSystem.For example, the AdminDomain instrumentation may not be able to communicate with the ComputerSystem; however, the ComputerSystem is functioning. In this example, the communication problem was neither the AdminDomain nor the ComputerSystem but in the network connecting them. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions. OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "Starting" describes an element being initialized. "Stopping" describes an element being brought to an orderly stop. "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. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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). "Migrating" element is being moved between host elements. "Immigrating" element is being moved to new host element. "Emigrating" element is being moved away from host element. "Shutting Down" describes an element being brought to an abrupt stop. "In Test" element is performing test functions. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Unknown
Not Available
In Service
Starting
Stopping
Stopped
Aborted
Dormant
Completed
Migrating
Emigrating
Immigrating
Snapshotting
Shutting Down
In Test
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_DomainMemberCS
Name Value 0 Unknown 1 Not Available 2 In Service 3 Starting 4 Stopping 5 Stopped 6 Aborted 7 Dormant 8 Completed 9 Migrating 10 Emigrating 11 Immigrating 12 Snapshotting 13 Shutting Down 14 In Test .. DMTF Reserved 0x8000.. Vendor Reserved
Property CommunicationStatus Qualifiers Name Type Value From Class Description string CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. The status from the point of view of the AdminDoman can be different from that of the member. The instrumentation may be different between that for the AdminDomain and that for the ComputerSystem.For example, the AdminDomain instrumentation may not be able to communicate with the ComputerSystem; however, the ComputerSystem is functioning. In this example, the communication problem was neither the AdminDomain nor the ComputerSystem but in the network connecting them. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Communication OK " indicates communication is established with the element, but does not convey any quality of service. "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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Unknown
Not Available
Communication OK
Lost Communication
No Contact
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS
Name Value 0 Unknown 1 Not Available 2 Communication OK 3 Lost Communication 4 No Contact .. DMTF Reserved 0x8000.. Vendor Reserved
Property MemberRole Qualifiers Name Type Value From Class Description string MemberRole indicates what a particular PartComponent ComputerSystem accomplishes for a particular AdminDomain aggregation. For clusters, MemberRole can be: "Unknown" indicates that the role is indetermine because, for example, the member is joining or departing the domain, is paused, and is in error. "Management Hub" indicates that a particular member houses the administrative functions of the domain itself. "Compute Member" indications that the ComputerSystem can participate in the work fulfilled for the domain. For high performance clusters, compute members can processes jobs, depending on the job requirements. "Login Member" indicates that this ComputerSystem gates membership into the domain. "I/O member" indicates that this member is dedicated for to data processing. These members generally do not accept jobs. "Lock Manager" indicates that this member arbitrates access to the shared resources of the domain. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Unknown
Management Hub
Compute Member
Login Member
I/O Member
Lock Manager
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS
Name Value 0 Unknown 2 Management Hub 3 Compute Member 4 Login Member 5 I/O Member 6 Lock Manager .. DMTF Reserved 0x8000.. Vendor Reserved
Property MemberState Qualifiers Name Type Value From Class Description string MemberState indicates state of membership of a particular PartComponent ComputerSystem for a particular AdminDomain aggregation. For clusters, MemberState can be: "Unknown" indicates that the implementation can not determine membership state for other reasons, see status properties of this class. "Member" indicates that PartComponent ComputerSystem is a member of the domain. "Joining" indicates that the request for membership in the domain is accepted and the ComputerSystem is joining the domain. "Paused" indicates that the ComputerSystem is a member of the domain but currently the ComputerSystem can not fulfill the function described by its MemberRole. "Departing" indicates that the request for non-membership in the domain is accepted and the ComputerSystem is departing the domain. CIM_DomainMemberCS ValueMap string [See below.] CIM_DomainMemberCS Values string Unknown
Member
Joining
Paused
Departing
DMTF Reserved
Vendor ReservedCIM_DomainMemberCS
Name Value 0 Unknown 2 Member 3 Joining 4 Paused 5 Departing .. DMTF Reserved 0x8000.. Vendor Reserved
Property GroupComponent Qualifiers Name Type Value From Class Aggregate boolean true CIM_SystemComponent Description string The parent System in the Association. CIM_SystemComponent Key boolean true CIM_SystemComponent
Property PartComponent Qualifiers Name Type Value From Class Description string The child element that is a component of a System. CIM_SystemComponent Key boolean true CIM_SystemComponent
Property GroupComponent Qualifiers Name Type Value From Class Key boolean true CIM_Component Aggregate boolean true CIM_Component Description string The parent element in the association. CIM_Component
Property PartComponent Qualifiers Name Type Value From Class Key boolean true CIM_Component Description string The child element in the association. CIM_Component
Method Qualifiers
Parameters
Parameter Qualifiers