CIM_System, ROOT\Hardware

Class | Childs (2) | Methods (1) | Properties (19) | Qualifiers (5) | Instances (1) | Namespaces (15)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

CIM_System represents an entity made up of component parts (defined by the SystemComponent relationship), that operates as a 'functional whole'. Systems are top level objects in the CIM hierarchy, requiring no scoping or weak relationships in order to exist and have context. It should be reasonable to uniquely name and manage a System at an enterprise level. For example, a ComputerSystem is a kind of System that can be uniquely named and independently managed in an enterprise. However, this is not true for the power supply (or the power supply sub-'system') within the computer. Although a System may be viewed as a Collection, this is not the correct model. A Collection is simply a 'bag' that 'holds' its members. A System is a higher level abstraction, built out of its individual components. It is more than a sum of its parts. Note that System is a subclass of EnabledLogicalElement which allows the entire abstraction to be functionally enabled/disabled - at a higher level than enabling/disabling its component parts.

CIM_System - child subclasses in ROOT\Hardware

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_AdminDomain1191-1-
CIM_ComputerSystem1252---

CIM_System methods

CIM_System has 1 methods (1 Derived)

NameOriginReturn
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}

CIM_System properties

CIM_System has 19 properties (5 Local, 14 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
key
CreationClassName
CIM_System8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
Name
CIM_ManagedSystemElement8 [string]
NameFormatCIM_System8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_System8 [string]
PrimaryOwnerNameCIM_System8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
RolesCIM_System8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of CIM_System methods

Derived methods (1) of CIM_System class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535']}
Jobref:CIM_ConcreteJob1-
TimeoutPerioddatetime2-
Description'Requests that the element's state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element's EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost.
If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.'
Values['Completed with No Error', 'Not Supported', 'Unknown/Unspecified Error', 'Can NOT complete within Timeout Period', 'Failed', 'Invalid Parameter', 'In Use', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Invalid State Transition', 'Use of Timeout Parameter Not Supported', 'Busy', 'Method Reserved', 'Vendor Specific']
RequestStateChange method is in 14 classes of ROOT\Hardware and in 15 namespaces

Detailed description of CIM_System properties

Local properties (5) of CIM_System class

CreationClassName property
CIMTYPE'string'
Description'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.'
keyTrue
MaxLen256
CreationClassName property is in 16 classes of ROOT\Hardware and in 20 namespaces
NameFormat property
CIMTYPE'string'
Description'The System object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. A heuristic can be defined in individual System subclasses to attempt to always generate the same System Name Key. The NameFormat property identifies how the System name was generated, using the subclass' heuristic.'
MaxLen64
NameFormat property is in 5 classes of ROOT\Hardware and in 21 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
Description'A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...).'
MappingStrings['MIF.DMTF|General Information|001.4']
MaxLen256
writeTrue
PrimaryOwnerContact property is in 5 classes of ROOT\Hardware and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
Description'The name of the primary system owner. The system owner is the primary user of the system.'
MappingStrings['MIF.DMTF|General Information|001.3']
MaxLen64
writeTrue
PrimaryOwnerName property is in 5 classes of ROOT\Hardware and in 15 namespaces
Roles property
CIMTYPE'string'
Description'An array (bag) of strings that specify 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.
Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/ or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties.'
writeTrue
Roles property is in 5 classes of ROOT\Hardware and in 17 namespaces

Derived properties (14) of CIM_System class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 33 classes of ROOT\Hardware and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 34 classes of ROOT\Hardware and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'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.'
ElementName property is in 33 classes of ROOT\Hardware and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
Description'An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).'
Values['Enabled', 'Disabled', 'Not Applicable', 'Enabled but Offline', 'No Default', 'DMTF Reserved', 'Vendor Reserved']
writeTrue
EnabledDefault property is in 14 classes of ROOT\Hardware and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
Description'EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states:
Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
Shutting Down (4) indicates that the element is in the process of going to a Disabled state.
Not Applicable (5) indicates the element doesn't support being enabled/disabled.
Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests.
Test (7) indicates that the element is in a test state.
Deferred (8) indicates that the element may be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.'
Values['Unknown', 'Other', 'Enabled', 'Disabled', 'Shutting Down', 'Not Applicable', 'Enabled but Offline', 'In Test', 'Deferred', 'Quiesce', 'Starting', 'DMTF Reserved', 'Vendor Reserved']
EnabledState property is in 14 classes of ROOT\Hardware and in 13 namespaces
HealthState property
CIMTYPE'uint16'
Description'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.'
Values['Unknown', 'OK', 'Degraded/Warning', 'Minor failure', 'Major failure', 'Critical failure', 'Non-recoverable error', 'DMTF Reserved']
HealthState property is in 18 classes of ROOT\Hardware and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
Description'A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
InstallDate property is in 18 classes of ROOT\Hardware and in 23 namespaces
Name property
CIMTYPE'string'
Description'The inherited Name serves as key of a System instance in an enterprise environment.'
keyTrue
MaxLen256
Override'Name'
Name property is in 26 classes of ROOT\Hardware and in 142 namespaces
OperationalStatus property
CIMTYPE'uint16'
Description'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.'
Values['Unknown', 'Other', 'OK', 'Degraded', 'Stressed', 'Predictive Failure', 'Error', 'Non-Recoverable Error', 'Starting', 'Stopping', 'Stopped', 'In Service', 'No Contact', 'Lost Communication', 'Aborted', 'Dormant', 'Supporting Entity in Error', 'Completed', 'Power Mode', 'DMTF Reserved', 'Vendor Reserved']
OperationalStatus property is in 18 classes of ROOT\Hardware and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
Description'A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.'
OtherEnabledState property is in 14 classes of ROOT\Hardware and in 11 namespaces
RequestedState property
CIMTYPE'uint16'
Description'RequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration.

It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.

This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.

It is possible that a particular instance of EnabledLogicalElement may not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.'
Values['Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Deferred', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
RequestedState property is in 14 classes of ROOT\Hardware and in 12 namespaces
Status property
CIMTYPE'string'
Description'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.'
Status property is in 18 classes of ROOT\Hardware and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
Description'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.'
StatusDescriptions property is in 18 classes of ROOT\Hardware and in 18 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
Description'The date/time when the element's EnabledState 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.'
TimeOfLastStateChange property is in 14 classes of ROOT\Hardware and in 17 namespaces

CIM_System Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'CIM_System represents an entity made up of component parts (defined by the SystemComponent relationship), that operates as a 'functional whole'. Systems are top level objects in the CIM hierarchy, requiring no scoping or weak relationships in order to exist and have context. It should be reasonable to uniquely name and manage a System at an enterprise level. For example, a ComputerSystem is a kind of System that can be uniquely named and independently managed in an enterprise. However, this is not true for the power supply (or the power supply sub-'system') within the computer.

Although a System may be viewed as a Collection, this is not the correct model. A Collection is simply a 'bag' that 'holds' its members. A System is a higher level abstraction, built out of its individual components. It is more than a sum of its parts. Note that System is a subclass of EnabledLogicalElement which allows the entire abstraction to be functionally enabled/disabled - at a higher level than enabling/disabling its component parts.'
Locale1033
UUID'{7ebb5755-1255-44aa-bd20-25f77b03d064}'
Version'2.7.0'

CIM_System System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Hardware:CIM_System'___SYSTEM8
__NAMESPACE'ROOT\Hardware'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT19___SYSTEM3
__RELPATH'CIM_System'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_EnabledLogicalElement'___SYSTEM8
__CLASS'CIM_System'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_System

Number of classes:8
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
__SystemClass500-4-
__SystemEvent120---
__SystemSecurity0071--
CIM_ComputerSystem1252---
CIM_ManagedSystemElement190-1-
CIM_SystemSpecificCollection140---
ComputerSystem0252----
SystemSpecificCollection040----
comments powered by Disqus
WUtils.com