File: MetricId.rst

package info (click to toggle)
python-pyvmomi 6.7.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,984 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (50 lines) | stat: -rw-r--r-- 2,167 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.. _int: https://docs.python.org/2/library/stdtypes.html

.. _str: https://docs.python.org/2/library/stdtypes.html

.. _metricId: ../../vim/PerformanceManager/QuerySpec.rst#metricId

.. _instance: ../../vim/PerformanceManager/MetricId.rst#instance

.. _counterId: ../../vim/PerformanceManager/MetricId.rst#counterId

.. _PerfQuerySpec: ../../vim/PerformanceManager/QuerySpec.rst

.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst

.. _PerformanceManager: ../../vim/PerformanceManager.rst


vim.PerformanceManager.MetricId
===============================
  This data object type contains information that associates a performance counter with a performance metric. When constructing this data object for the `metricId`_ property of the `PerfQuerySpec`_ to submit to one of the `PerformanceManager`_ query operations, the `instance`_ property supports these special characters:
   * An asterisk (*) to specify all instances of the metric for the specified
   * `counterId`_
   * 
   * Double-quotes ("") to specify aggregated statistics
:extends: vmodl.DynamicData_

Attributes:
    counterId (`int`_):

       The `ID`_ of the counter for the metric.
    instance (`str`_):

       An identifier that is derived from configuration names for the device associated with the metric. It identifies the instance of the metric with its source. This property may be empty.
        * For memory and aggregated statistics, this property is empty.
        * For host and virtual machine devices, this property contains the name of the device, such as the name of the host-bus adapter or the name of the virtual Ethernet adapter. For example,
        * mpx
        * vmhba33
        * C0
        * T0
        * L0
        * or
        * vmnic0
        * 
        * For a CPU, this property identifies the numeric position within the CPU core, such as 0, 1, 2, 3.
        * For a virtual disk, this property identifies the file type:
        * 
        * DISKFILE, for virtual machine base-disk files
        * SWAPFILE, for virtual machine swap files
        * DELTAFILE, for virtual machine snapshot overhead files
        * OTHERFILE, for all other files of a virtual machine