Provides the ability to manage metrics.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_MetricService : CIM_MetricService
{
string InstanceID;
string Caption = "Hyper-V Metric Service";
string Description = "Provides Hyper-V Metric WMI management";
string ElementName = "Hyper-V Metric Service";
datetime InstallDate;
uint16 OperationalStatus[] = 2;
string StatusDescriptions[] = "OK";
string Status = "OK";
uint16 HealthState = 5;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
string EnabledState = 2;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState;
string SystemCreationClassName = "Msvm_ComputerSystem";
string SystemName;
string Name = "metricsvc";
string CreationClassName = "Msvm_MetricService";
string PrimaryOwnerName;
string PrimaryOwnerContact;
string StartMode;
boolean Started;
};
Members
The Msvm_MetricService class has these types of members:
Methods
The Msvm_MetricService class has these methods.
| Method | Description |
|---|---|
| ControlMetrics | Used to control the collection of metrics for a managed element or elements. |
| ControlMetricsByClass | Controls the metrics by class. |
| ControlSampleTimes | Sets the control sample times. |
| GetMetricValues | Retrieves the metric values. |
| ModifyServiceSettings | Modifies the setting data for the service. |
| RequestStateChange | Requests a state change. |
| ShowMetrics | Shows the specified metrics. |
| ShowMetricsByClass | Shows the metrics by class. |
| StartService | Starts the service. |
| StopService | Stops the service. |
Properties
The Msvm_MetricService 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. This property is inherited from CIM_EnabledLogicalElement.
Caption
Data type: string
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Metric Service".
CommunicationStatus
Data type: uint16
Access type: Read-only
Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
CreationClassName
Data type: string
Access type: Read-only
The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_Service, and it is always set to "Msvm_MetricService".
Description
Data type: string
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Provides Hyper-V Metric WMI management".
DetailedStatus
Data type: uint16
Access type: Read-only
Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
ElementName
Data type: string
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Metric Service".
EnabledDefault
Data type: uint16
Access type: Read-only
An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).
EnabledState
Data type: string
Access type: Read-only
The enabled and disabled states of an element. This property can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).
HealthState
Data type: uint16
Access type: Read-only
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 nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).
InstallDate
Data type: datetime
Access type: Read-only
The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.
InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key
Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement, and it is always set to Null.
Name
Data type: string
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_Service, and it is always set to "metricsvc".
OperatingStatus
Data type: uint16
Access type: Read-only
Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
OperationalStatus
Data type: uint16 array
Access type: Read-only
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to 2 (OK).
OtherEnabledState
Data type: string
Access type: Read-only
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, and it is always set to Null.
PrimaryOwnerContact
Data type: string
Access type: Read-only
A value that provides information about how the primary owner of the service can be reached (for example, phone number, email address, and so on). This property is inherited from CIM_Service, and it is always set to Null.
PrimaryOwnerName
Data type: string
Access type: Read-only
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the service. This property is inherited from CIM_Service, and it is always set to Null.
PrimaryStatus
Data type: uint16
Access type: Read-only
Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )
RequestedState
Data type: uint16
Access type: Read-only
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. A particular instance of CIM_EnabledLogicalElement might not support the RequestStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).
Started
Data type: boolean
Access type: Read-only
Indicates whether the service is currently running. This property is inherited from CIM_Service.
StartMode
Data type: string
Access type: Read-only
A string value that indicates whether the service is automatically started by a system, an operating system, or is started only upon request. This property is inherited from CIM_Service, and it is always set to Null.
Status
Data type: string
Access type: Read-only
This property is inherited from CIM_ManagedSystemElement, and it is always set to "OK".
StatusDescriptions
Data type: string array
Access type: Read-only
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement, and the strings are always set to "OK".
SystemCreationClassName
Data type: string
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_Service, and it is always set to "Msvm_ComputerSystem".
SystemName
Data type: string
Access type: Read-only
The name of the hosting computer system. This property is inherited from CIM_Service.
TimeOfLastStateChange
Data type: datetime
Access type: Read-only
The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.
TransitioningToState
Data type: uint16
Access type: Read-only
Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Namespace | Root\Virtualization\V2 |
| MOF | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
