Msvm_MetricServiceCapabilities class

Describes the capabilities of the associated Msvm_MetricService instance.

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_MetricServiceCapabilities : CIM_MetricServiceCapabilities
{
  string  InstanceID;
  string  Caption = "Hyper-V Metric Service Capabilities";
  string  Description = "Defines Hyper-V Metric Service Capabilities";
  string  ElementName = "Hyper-V Metric Service Capabilities";
  boolean ElementNameEditSupported;
  unit16  MaxElementNameLen;
  unit16  RequestedStatesSupported[];
  string  ElementNameMask;
  string  ControllableMetrics[];
  uint16  MetricsControlTypes[];
  string  ControllableManagedElements[];
  uint16  ManagedElementControlTypes[];
  uint16  SupportedMethods[];
};

Members

The Msvm_MetricServiceCapabilities class has these types of members:

• Properties

Properties

The Msvm_MetricServiceCapabilities class has these properties.

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

ControllableManagedElements

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

Identifies the instances of CIM_ManagedElement that can be controlled by the associated CIM_MetricService instance. If this property is Null, all elements can be controlled. This property is inherited from CIM_MetricServiceCapabilities.

ControllableMetrics

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

Identifies the instances of CIM_BaseMetricDefinition that can be controlled by the associated CIM_MetricService instance. If this property is Null, all metrics can be controlled. This property is inherited from CIM_MetricServiceCapabilities.

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 "Defines Hyper-V Metric Service Capabilities".

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

ElementNameEditSupported

Data type: boolean

Access type: Read-only

Indicates whether the ElementName property can be modified. This property is inherited from CIM_EnabledLogicalElementCapabilities.

ElementNameMask

Data type: string

Access type: Read-only

Specifies the restrictions on ElementName, expressed as a regular expression. This property is inherited from CIM_EnabledLogicalElementCapabilities.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

ManagedElementControlTypes

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

Identifies the type of control supported by the associated CIM_MetricService instance for the CIM_ManagedElement object identified by the value at the same array index in the ControllableManagedElements property. If this property is Null, all control types are supported. This property is inherited from CIM_MetricServiceCapabilities.

Value	Meaning
0	Unknown
2	Discrete
3	Bulk
4	Both
5..32767	DMTF reserved
32768..65535	Vendor specific

MaxElementNameLen

Data type: unit16

Access type: Read-only

Qualifiers: MaxValue (256)

Specifies the maximum supported length of the ElementName property. This property is inherited from CIM_EnabledLogicalElementCapabilities.

MetricsControlTypes

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

Identifies the type of control supported by the associated CIM_MetricService instance for the CIM_BaseMetricDefinition identified by the value at the same array index in the ControllableMetrics property. If this property is Null, all control types are supported. This property is inherited from CIM_MetricServiceCapabilities.

Value	Meaning
0	Unknown
2	Discrete
3	Bulk
4	Both
5..32767	DMTF reserved
32768..65535	Vendor specific

RequestedStatesSupported

Data type: unit16 array

Access type: Read-only

Indicates the possible states that can be requested when using the RequestStateChange method on the enabled logical element. This property is inherited from CIM_EnabledLogicalElementCapabilities.

Value	Meaning
2	Enabled
3	Disables
4	Shut Down
6	Offline
7	Test
8	Defer
9	Quiesce
10	Reboot
11	Reset

SupportedMethods

Data type: uint16 array

Access type: Read-only

Specifies the methods supported by the metric service. This property is inherited from CIM_MetricServiceCapabilities.

Value	Meaning
2	The ControlMetrics method is supported.
3	The ControlMetricsByClass method is supported.
4	The ShowMetrics method is supported.
5	The ShowMetricsByClass method is supported.
6	The GetMetricValues method is supported.
7	The ControlSampleTimes method is supported.
8..32767	DMTF reserved
32768..65535	Vendor specific

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

See also

CIM_MetricServiceCapabilities

Msvm_MetricService