CIM_MetricServiceCapabilities class
Describes the capabilities of a CIM_MetricService object.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Metrics::BaseMetrics")]
class CIM_MetricServiceCapabilities : CIM_EnabledLogicalElementCapabilities
{
string Caption;
string Description;
string InstanceID;
string ElementName;
boolean ElementNameEditSupported;
uint16 MaxElementNameLen;
uint16 RequestedStatesSupported[];
string ElementNameMask;
string ControllableMetrics[];
uint16 MetricsControlTypes[];
string ControllableManagedElements[];
uint16 ManagedElementControlTypes[];
uint16 SupportedMethods[];
};
Members
The CIM_MetricServiceCapabilities class has these types of members:
Properties
The CIM_MetricServiceCapabilities class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ControllableManagedElements
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MetricServiceCapabilities.ManagedElementControlTypes")
An array that contains identifiers of the CIM_ManagedElement instances that are controlled by the metric service. The identifiers must be formatted as Web-Based Enterprise Management (WBEM) URIs. In order to use this property, the metric service must support enabling or disabling at least one metric that is defined for the CIM_ManagedElement instance.
-
-
ControllableMetrics
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MetricServiceCapabilities.MetricControlTypes")
An array that contains identifiers of the CIM_BaseMetricDefinition that defines the metrics that are managed by the metric service. The identifiers must be formatted as Web-Based Enterprise Management (WBEM) URIs.
In order to use this property, a CIM_BaseMetricDefinition instance must be associated with a CIM_MetricService instance through the CIM_ServiceAffectsElement class. In addition the metric service must support enabling or disabling at least one metric that is defined by the CIM_BaseMetricDefinition instance.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user friendly name for this class instance. In addition, the user friendly name can be used as a index property for a query. This value does not have to be unique within its namespace.
This property is inherited from CIM_Capabilities.
-
-
ElementNameEditSupported
-
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|EditName"), ModelCorrespondence ("CIM_ManagedElement.ElementName")
true if the ElementName property of the enabled logical element can be modified; otherwise, false.
This property is inherited from CIM_EnabledLogicalElementCapabilities.
-
-
ElementNameMask
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElementCapabilities.MaxElementNameLen")
A regular expression that indicates the restrictions on the ElementalName property of the enable logical element. See DMTF standard ABNF with the Management Profile Specification Usage Guide, appendix C for the permitted syntax.
Note
If this property and the ElementalNameMask property of the enable logical element describe the maximum length of ElementalName, the smaller value is used.
This property is inherited from CIM_EnabledLogicalElementCapabilities.
-
-
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 above 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 provider 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 CIM_Capabilities.
-
-
ManagedElementControlTypes
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MetricServiceCapabilities.ControllableManagedElements")
An array that indicates the control types that are supported by the metric service for the managed elements in the ControllableManagedElements array. This array corresponds to the ControllableManagedElements array. The control types in this array are associated with metrics through the ControllableManagedElements array.
The possible values are:
-
-
Unknown (0)
-
Discrete (2)
-
The metrics service can enable and disable the associated metrics individually.
-
Bulk (3)
-
The metrics service can enable and disable all associated metrics with a single operation.
-
Both (4)
-
The metrics service can enable and disable the associated metrics individually, and with a single operation.
-
DMTF Reserved
-
Vendor Specific
MaxElementNameLen
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MaxValue (256), MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars"), ModelCorrespondence ("CIM_FCSwitchCapabilities.ElementNameEditSupported", "CIM_EnabledLogicalElementCapabilities.ElementNameMask")
The maximum supported length of the ElementName property of the enabled logical element.
This property is inherited from CIM_EnabledLogicalElementCapabilities.
MetricsControlTypes
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_MetricServiceCapabilities.ControllableMetrics")
An array that indicates the control types that are supported by the metric service. This array corresponds to the ControllableMetrics array. The control types in this array are associated with metrics through the ControllableMetrics array.
The possible values are:
Unknown (0)
Discrete (2)
The metrics service can enable and disable the associated metrics individually.
Bulk (3)
The metrics service can enable and disable all associated metrics with a single operation.
Both (4)
The metrics service can enable and disable the associated metrics individually, and with a single operation.
DMTF Reserved
Vendor Specific
RequestedStatesSupported
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange")
The possible states that can be requested on the enabled logical element by the RequestStateChange method.
This property is inherited from CIM_EnabledLogicalElementCapabilities.
Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
SupportedMethods
-
Data type: uint16 array
-
Access type: Read-only
An array that contains names of methods that are supported by the metric service.
The possible values are:
ControlMetrics (2)
ControlMetricsByClass (3)
ShowMetrics (4)
ShowMetricsByClass (5)
GetMetricValues (6)
ControlSampleTimes (7)
DMTF Reserved
Vendor Specific
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|