MSFT_NetEventProvider class

This class encapsulates an ETW provider on a computer for the event capture

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

Syntax

[UMLPackagePath("CIM::Core::CoreElements"), ClassVersion("1.0"), dynamic, provider("NetEventPacketCapture"), AMENDMENT]
class MSFT_NetEventProvider : MSFT_NetEventProviderBase
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   Name;
  string   Guid;
  string   SessionGuid;
  string   SessionName;
  uint8    Level;
  uint64   MatchAnyKeyword;
  uint64   MatchAllKeyword;
};

Members

The MSFT_NetEventProvider class has these types of members:

Properties

The MSFT_NetEventProvider class has these properties.

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.

CommunicationStatus
Data type: uint16
Access type: Read-only

CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. 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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
0

Unknown

1

Not Available

2

Communication OK

3

Lost Communication

4

No Contact

..

DMTF Reserved

0x8000..

Vendor Reserved

 

Description
Data type: string
Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

DetailedStatus
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

DetailedStatus compliments PrimaryStatus with additional status detail. 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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
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

 

ElementName
Data type: string
Access type: Read-only

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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

This property is inherited from CIM_ManagedElement.

Guid
Data type: string
Access type: Read-only
Qualifiers: key

Guid, the unique id of the provider installed on the computer.

This property is inherited from MSFT_NetEventProviderBase.

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 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 completely 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 might not be possible.

"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.

"Minor Failure" (15) - All functionality is available but some might 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 might not be operating at optimal performance or it might 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 cannot report on HealthState at this time.

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
0

Unknown

5

OK

10

Degraded/Warning

15

Minor failure

20

Major failure

25

Critical failure

30

Non-recoverable error

..

DMTF Reserved

 

InstallDate
Data type: datetime
Access type: Read-only

A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceID
Data type: string
Access type: Read-only

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

This property is inherited from CIM_ManagedElement.

Level
Data type: uint8
Access type: Read-only

The maximum event level for the event capture.

This property is inherited from MSFT_NetEventProviderBase.

MatchAllKeyword
Data type: uint64
Access type: Read-only

The MatchAllKeyword mask specified for the event capture.

This property is inherited from MSFT_NetEventProviderBase.

MatchAnyKeyword
Data type: uint64
Access type: Read-only

The MatchAnyKeyword mask specified for the event capture.

This property is inherited from MSFT_NetEventProviderBase.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

The name of the provider

This property is inherited from MSFT_NetEventProviderBase.

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

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. 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).

"Servicing" 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.

"Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.

"In Service" describes an element that is in service and operational.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
0

Unknown

1

Not Available

2

Servicing

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

15

Transitioning

16

In Service

..

DMTF Reserved

0x8000..

Vendor Reserved

 

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

Indicates the current statuses 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 here in more detail.

"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 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 state and configuration of the element might need to be updated.

"Dormant" indicates that the element is inactive or quiesced.

"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.

"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, 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" indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ManagedSystemElement.

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

..

DMTF Reserved

0x8000..

Vendor Reserved

 

PrimaryStatus
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. 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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
0

Unknown

1

OK

2

Degraded

3

Error

..

DMTF Reserved

0x8000..

Vendor Reserved

 

SessionGuid
Data type: string
Access type: Read-only
Qualifiers: key

Guid, the unique id of the session, when part of a session. NULL Guid otherwise.

This property is inherited from MSFT_NetEventProviderBase.

SessionName
Data type: string
Access type: Read-only

The session of the provider, when part of a session.

This property is inherited from MSFT_NetEventProviderBase.

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

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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.

2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.

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.

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
"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")

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.

This property is inherited from CIM_ManagedSystemElement.

Requirements

Minimum supported client

Windows 10

Minimum supported server

Windows Server 2016 Technical Preview

Namespace

root\standardcimv2

MOF

NetEventPacketCapture.mof

DLL

NetEventPacketCapture.dll

See also

MSFT_NetEventProviderBase

 

 

Show: