MSFTSM_WSManCommunicationMechanism class
Describes an access mechanism for a MSFTSM_ObjectManager instance. It describes a protocol and data encoding that can be used for communication.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Dynamic, Version("1.0.0"), provider("MSiSCSITargetProv")]
class MSFTSM_WSManCommunicationMechanism : CIM_ObjectManagerCommunicationMechanism
{
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 SystemCreationClassName;
string SystemName;
string CreationClassName;
string Name;
uint16 CommunicationMechanism;
string OtherCommunicationMechanismDescription;
uint16 FunctionalProfilesSupported[];
string FunctionalProfileDescriptions[];
boolean MultipleOperationsSupported;
uint16 AuthenticationMechanismsSupported[];
string AuthenticationMechanismDescriptions[];
string Version;
uint16 AdvertiseTypes[];
string AdvertiseTypeDescriptions[];
};
Members
The MSFTSM_WSManCommunicationMechanism class has these types of members:
Methods
The MSFTSM_WSManCommunicationMechanism 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 the CIM_EnabledLogicalElement class. |
Properties
The MSFTSM_WSManCommunicationMechanism class has these properties.
-
AdvertiseTypeDescriptions
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.AdvertiseTypes")
A free-form string providing additional information related to the AdvertiseType. A description MUST be provided when the AdvertiseType is 1, "Other". An entry in this array corresponds to the entry in the AdvertiseTypes array at the same index. It is not expected that additional descriptions are needed if the Type is set to "Not Advertised" or "SLP". However, as the SLP template expands, or as other advertisement mechanisms are defined, support for additional descriptions may be needed. This array is defined to support this.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
-
-
AdvertiseTypes
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Required, ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.AdvertiseTypeDescriptions")
This property signifies the advertisement for this access point. . It is used by the advertising services of the WBEM infrastructure to determine what should be advertised, via what mechanisms. The property is an array so that the communicationMechansim MAY be advertised using several mechanisms. Note: If this property is null/uninitialized, this is equivalent to specifying the value 2, "Not Advertised".
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
-
-
Other (1)
-
Not Advertised (2)
-
SLP (3)
AuthenticationMechanismDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.AuthenticationMechanismsSupported")
Free-form strings providing descriptions of the supported mechanisms. Entries in this array are correlated with those in the AuthenticationMechanismsSupported array. An entry in this Descriptions array MUST be provided when 1, "Other", is specified in AuthenticationMechanismsSupported.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
AuthenticationMechanismsSupported
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Required, ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.AuthenticationMechanismDescriptions")
Enumerated array describing the types of authentication supported by the ObjectManager, using the encoding/protocol. specified in the property, CommunicationMechanism. The defined values represent the authentication defined in the DMTF document, Specification for CIM Operations over HTTP.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
Unknown (0)
Other (1)
None (2)
Basic (3)
Digest (4)
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
CommunicationMechanism
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Required, ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.OtherCommunicationMechanismDescription")
CommunicationMechanism describes an encoding and protocol which can be used to communicate with the server. ObjectManager, the specified string should be indicated. If Other is used, the value for OtherCommunicationMechanismDescription must not be null.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
Unknown (0)
Other (1)
CIM-XML (2)
SM-CLP (3)
WS-Management (4)
WSDM (5)
CreationClassName
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.
This property is inherited from CIM_ServiceAccessPoint.
Description
-
Data type: string
-
Access type: Read-only
Contains a textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
Contains 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 enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).
This property is inherited from CIM_EnabledLogicalElement.
Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved
Vendor Reserved
EnabledState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
EnabledState is an integer enumeration that indicates the enabled and 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 and disabled states: Enabled (2) indicates that the element is or 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 does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might 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 might be completing commands, but will queue 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.
This property is inherited from CIM_EnabledLogicalElement.
Unknown (0)
Other (1)
Enabled (2)
Disabled (3)
Shutting Down (4)
Not Applicable (5)
Enabled but Offline (6)
In Test (7)
Deferred (8)
Quiesce (9)
Starting (10)
DMTF Reserved
Vendor Reserved
FunctionalProfileDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.FunctionalProfilesSupported")
Free-form strings providing descriptions of the supported operations of the object manager. Entries in the array are correlated with those in the ProfilesSupported array. An entry in this Descriptions array MUST be provided when 1, "Other", is specified in the FunctionalProfilesSupported array.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
FunctionalProfilesSupported
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Required, ArrayType ("Indexed"), ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.FunctionalProfileDescriptions")
Enumerated array describing the types of operations supported by the ObjectManager, using this encoding/protocol. The enumeration is based on the Functional Profiles defined for conformance in the DMTF document, Specification for CIM Operations over HTTP.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
Unknown (0)
Other (1)
Basic Read (2)
Basic Write (3)
Schema Manipulation (4)
Instance Manipulation (5)
Association Traversal (6)
Query Execution (7)
Qualifier Declaration (8)
Indications (9)
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 that of its sub-components.
This property is inherited from CIM_ManagedSystemElement.
The following values have been defined:
Unknown (0)
The implementation cannot 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 might not be operating at optimal performance or it might be reporting recoverable errors
Minor failure (15)
All functionality is available but some 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 not working.
Critical failure (25)
The element is non-functional and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
DMTF Reserved
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
MultipleOperationsSupported
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Required
Boolean indicating whether the ObjectManager supports multiple operation requests (TRUE) or only simple requests (FALSE).
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
Name
The Name property uniquely identifies the ServiceAccessPoint and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
This property is inherited from CIM_ServiceAccessPoint.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of OperationalStatus 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, Microsoft strongly recommends that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.
This property is inherited from CIM_ManagedSystemElement.
The following values have been defined:
Unknown (0)
Indicates the implementation cannot report on OperationalStatus at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates the element is working and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors
Stressed (4)
Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element is functioning nominally but predicting a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
A non-recoverable error has occurred.
Starting (8)
The job is starting.
Stopping (9)
The job is stopping.
Stopped (10)
The element has been intentionally stopped.
In Service (11)
Indicates the element is being configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.
Aborted (14)
Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.
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 may be OK but is unable to 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, ErrorError, or Degraded 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).
Power Mode (18)
"Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.
DMTF Reserved
DMTF has reserved this portion of the range for additional OperationalStatus values in the future.
Vendor Reserved
Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.
OtherCommunicationMechanismDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ObjectManagerCommunicationMechanism.CommunicationMechanism")
A free-form string providing a description of the supported protocols when 1, "Other", is specified in the CommunicationMechanism.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
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 set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
This property is inherited from CIM_EnabledLogicalElement.
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
RequestedState is an integer enumeration that indicates 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 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. 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). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
This property is inherited from CIM_EnabledLogicalElement.
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
Vendor Reserved
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Contains a string indicating the primary status of the object.
Note
This property is deprecated and replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility it should be secondary to the OperationalStatus property.
This property is inherited from CIM_ManagedSystemElement.
("OK")
("Error")
("Degraded")
("Unknown")
("Pred Fail")
("Starting")
("Stopping")
("Service")
("Stressed")
("NonRecover")
("No Contact")
("Lost Comm")
("Stopped")
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The CreationClassName of the scoping System.
This property is inherited from CIM_ServiceAccessPoint.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The Name of the scoping System.
This property is inherited from CIM_ServiceAccessPoint.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The date or time when the EnabledState 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.
Version
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
Provides the protocol version for this service access point. Version information MUST be in the form of M.N, where M is a numeric that describes the Major version and N is a numeric that describes the minor version.
This property is inherited from CIM_ObjectManagerCommunicationMechanism.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|