Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSFTSM_System class

Represents an entity that consists of component parts. The entity operates as a functional whole. Systems are top-level objects in the CIM hierarchy.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class MSFTSM_System : CIM_System
{
  string   CreationClassName;
  string   Name;
  string   NameFormat;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   Roles[];
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  datetime InstallDate;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   Caption;
  string   Description;
  string   ElementName;
  string   InstanceID;
};

Members

The MSFTSM_System class has these types of members:

Methods

The MSFTSM_System class has these methods.

MethodDescription
RequestStateChange

Requests that the state of the element be changed to the specified value.

This method is inherited from the CIM_EnabledLogicalElement class.

 

Properties

The MSFTSM_System class has these properties.

AvailableRequestedStates
Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method.

The listed values must be a subset of the values that are contained in the RequestedStatesSupported property of the associated CIM_EnabledLogicalElementCapabilities instance. This property is NULL if the implementation cannot determine the set of possible values for the current state of the element.

The possible values are.

Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (12 ≤ value )

This property is inherited from the CIM_EnabledLogicalElement class.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates a short textual description of the object.

This property is inherited from the CIM_ManagedElement class.

CommunicationStatus
Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.

ValuesMeaning
Unknown
0

Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.

Not Available
1

Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.

Communication OK
2

Indicates only that communication is established with the element.

Lost Communication
3

Indicates that the element has been contacted in the past, but is currently unreachable.

No Contact
4

Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.

DMTF Reserved
5–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

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

Indicates the name of the class that is used in the creation of an instance. When this property is used with the other key properties of this class, this property enables all instances of this class and its subclasses to be uniquely identified.

This property is inherited from the CIM_System class.

Description
Data type: string
Access type: Read-only

Indicates a textual description of the object.

This property is inherited from the CIM_ManagedElement class.

DetailedStatus
Data type: uint16
Access type: Read-only

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

ValuesMeaning
Not Available
0

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

No Additional Information
1

Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.

Stressed
2

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure
3

Indicates that an element functions nominally, but predicts a failure in the near future.

Non-Recoverable Error
4

Indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

DMTF Reserved
6–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

ElementName
Data type: string
Access type: Read-only

Indicates a user-friendly name for the object. This property enables each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from the CIM_ManagedElement class.

EnabledDefault
Data type: uint16
Access type: Read/write

Indicates an administrator's default or startup configuration for the enabled state of an element. The default value is Enabled (2).

The possible values are.

Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved (10–32767)
Vendor Reserved (32768–65535)

This property is inherited from the CIM_EnabledLogicalElement class.

EnabledState
Data type: uint16
Access type: Read-only

Indicates the enabled and disabled states of an element and the transitions between states. For example, Shutting Down (0) and Starting (10) are transient states between Enabled and Disabled.

ValuesMeaning
Unknown
0

Indicates that the state of the element is unknown.

Other
1

Indicates that the state of the element is described in the OtherEnabledState property.

Enabled
2

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled
3

Indicates that the element does not execute commands and that it drops 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 does not support to be enabled or disabled.

Enabled but Offline
6

Indicates that the element might be completing commands and that it drops any new requests.

In Test
7

Indicates that the element is in a test state.

Deferred
8

Indicates that the element might be completing commands, but queues any new requests.

Quiesce
9

Indicates that the element is enabled but in a restricted mode.

Starting
10

Indicates that the element is in the process of going to an Enabled state. New requests are queued.

DMTF Reserved
11–32767

Reserved.

Vendor Reserved
32768–65535

Reserved.

 

This property is inherited from the CIM_EnabledLogicalElement class.

HealthState
Data type: uint16
Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.

ValuesMeaning
Unknown
0

The implementation cannot report on HealthState at this time.

OK
5

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

Degraded/Warning
10

The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Minor failure
15

All functionality is available but some functionality might be degraded.

Major failure
20

The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.

Critical failure
25

The element is nonfunctional, and recovery might not be possible.

Nonrecoverable error
30

The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.

DMTF Reserved
31 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

IdentifyingDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType (Indexed)

Lists explanations and details that relate to the corresponding entries in the OtherIdentifyingInfo array.

This property is inherited from the CIM_System class.

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

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

Note  Values are mapped to a Management Information Format (MIF) file that is maintained by the Distributed Management Task Force (DMTF). For more information, see the DMTF website at http://dmtf.org/standards.

This property is inherited from the CIM_ManagedSystemElement class.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

Important  In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from the CIM_ManagedElement class.

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

Indicates the name that is used as a key identifier of this instance in an enterprise environment.

This property is inherited from the CIM_System class.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates how the Name property is generated.

Each MSFTSM_System instance is a top-level object that provides scope for numerous components. It must be uniquely identified by its Key properties. You can describe a heuristic process in MSFTSM_System subclasses to attempt to always generate the same NameKey for that subclass.

This property is inherited from the CIM_System class.

OperatingStatus
Data type: uint16
Access type: Read-only

Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.

ValuesMeaning
Unknown
0

Indicates that the instrumentation cannot report on the OperatingStatus property at this time.

Not Available
1

Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.

Servicing
2

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

Starting
3

Indicates that the element is being initialized.

Stopping
4

Indicates that the element is being brought to an orderly stop.

Stopped
5

Indicates that the element is intentionally stopped.

Aborted
6

Indicates that the element stopped in an unexpected way.

Dormant
7

Indicates that the element is inactive or quiesced.

Completed
8

Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.

Migrating
9

Indicates that the element is being moved between host elements.

Emigrating
10

Indicates that the element is being moved away from the host element.

Immigrating
11

Indicates that the element is being moved to a new host element.

Snapshotting
12

Indicates that a snapshot copy of the element is being created.

Shutting Down
13

Indicates that the element is being brought to an abrupt stop.

In Test
14

Indicates that the element is performing test functions.

Transitioning
15

Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.

In Service
16

Indicates that the element is in service and operational.

DMTF Reserved
17–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

OperationalStatus
Data type: uint16 array
Access type: Read-only

Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.

Note  OperationalStatus replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is single-valued property, should also provide the primary status of the element.

ValuesMeaning
Unknown
0

Indicates that the implementation cannot report on the OperationalStatus property at this time.

Other
1

Indicates an undefined state.

OK
2

Indicates full functionality without errors.

Degraded
3

Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Stressed
4

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure
5

Indicates that an element functions nominally, but predicts a failure in the near future.

Error
6

Indicates that an error has occurred.

Non-Recoverable Error
7

Indicates that a nonrecoverable error has occurred.

Starting
8

Indicates that the job is starting.

Stopping
9

Indicates that the job is stopping.

Stopped
10

Indicates that the element has been intentionally stopped.

In Service
11

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

No Contact
12

Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.

Lost Communication
13

Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.

Aborted
14

Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.

Dormant
15

Indicates that the job is inactive.

Supporting Entity in Error
16

Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed
17

Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.

Power Mode
18

Indicates that the element has additional power model information that is contained in the associated power management service instance.

DMTF Reserved
19–0x7FFF

Reserved.

Vendor Reserved
0x8000 ≤ value

Reserved.

 

This property is inherited from the CIM_ManagedSystemElement class.

OtherEnabledState
Data type: string
Access type: Read-only

Describes the state of the element when the value of the EnabledState property is Other. Must be NULL when EnabledState is not Other.

This property is inherited from the CIM_EnabledLogicalElement class.

OtherIdentifyingInfo
Data type: string array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , Key, MaxLen (256)

Indicates additional data beyond the Name property that can be used to identify a system.

This property is inherited from the CIM_System class.

PrimaryOwnerContact
Data type: string
Access type: Read/write
Qualifiers: MaxLen (256)

Specifies how to contact the primary system owner.

This property is inherited from the CIM_System class.

PrimaryOwnerName
Data type: string
Access type: Read/write
Qualifiers: MaxLen (64)

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

This property is inherited from the CIM_System class.

PrimaryStatus
Data type: uint16
Access type: Read-only

Indicates a high-level status value.

The possible values are.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (4–0x7FFF)
Vendor Reserved (0x8000 ≤ value )

This property is inherited from the CIM_ManagedSystemElement class.

RequestedState
Data type: uint16
Access type: Read-only

Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.

Note  When the value of the EnabledState property is Not Applicable, this property has no meaning.

ValuesMeaning
Enabled
2

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled
3

Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.

Shut Down
4

Indicates a request for an orderly transition to the Disabled state and might involve removing power to completely erase any existing state.

No Change
5

Indicates that no state change has been requested. This is the default value if the RequestStateChange method is supported.

Offline
6

Indicates a request to transition to the Enabled but Offline state.

Test
7

Indicates that the element is in a test state.

Deferred
8

Indicates that the element might be completing commands, but queues any new requests.

Quiesce
9

Indicates that the element is enabled but in a restricted mode.

Reboot
10

Indicates a request to shut down and then change to an Enabled state.

Reset
11

Indicates a request to change to a Disabled state and then to an Enabled state.

Not Applicable
12

Indicates that this instance does not support the RequestedState property.

DMTF Reserved
13–32767

Reserved.

Vendor Reserved
32768–65535

Reserved.

 

This property is inherited from the CIM_EnabledLogicalElement class.

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

Specifies the administrator-defined roles that this system performs in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system can perform multiple roles.

This property is inherited from the CIM_System class.

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

Indicates the primary status of the object.

Note  This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.

The possible values are.

OK
Error
Degraded
Unknown
Pred Fail
Starting
Stopping
Service
Stressed
NonRecover
No Contact
Lost Comm
Stopped

This property is inherited from the CIM_ManagedSystemElement class.

StatusDescriptions
Data type: string array
Access type: Read-only

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

This property is inherited from the CIM_ManagedSystemElement class.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.

This property is inherited from the CIM_EnabledLogicalElement class.

TransitioningToState
Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning.

A value of No Change indicates that no transition is in progress. A value of Not Applicable indicates that the implementation does not report ongoing transitions.

The possible values are.

Unknown (0)
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved (13 ≤ value )

This property is inherited from the CIM_EnabledLogicalElement class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

\\.\root\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

See also

iSCSI Target Server Reference

 

 

Show:
© 2014 Microsoft