| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
profile* | VirtualMachineProfileSpec |
Profile to be used for the stats object, see above.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
xsd:string | mounted path of the VSAN stats object (using "/" as path separtor) i.e. /vmfs/volumes/vsan:525218c52dce3d62-e51a774ec7aef712/ |
Faults
Type | Description |
---|---|
CannotCreateFile | Thrown if it cannot complete file creation operation. |
FileAlreadyExists | Thrown if the stats object already exists. |
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if the pre-check tests failed. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
profile* | VirtualMachineProfileSpec |
Profile to be used for the stats object, see above
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | vim task |
Faults
Type | Description |
---|---|
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if the caller doesn't have the required privilege, or the cluster has no hosts. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
xsd:boolean | True on success |
Faults
Type | Description |
---|---|
CannotCreateFile | Thrown if it cannot complete file creation operation. |
FileNotWritable | |
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if the pre-check tests failed, or the host in the states that do not allow objects deletion (i.e. maintenance mode with data migration mode: ensure accessibility). |
VsanNodeNotMaster |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | vim task |
Faults
Type | Description |
---|---|
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if the caller doesn't have the required privilege, or the cluster has no hosts. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
Return Value
Type | Description |
---|---|
VsanPerfEntityType[] |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster | ManagedObjectReference
to a ClusterComputeResource |
The cluster for which to compute health for.
|
Return Value
Type | Description |
---|---|
DynamicData[] | vim.cluster.VsanClusterHealthGroup[] A list of health groups. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
VsanPerfNodeInformation[] |
Faults
Type | Description |
---|---|
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Entity Type | Metrics (Labels) |
---|---|
'cluster-domclient' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'congestion', 'oio' |
'cluster-domcompmgr' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'iopsRecWrite', 'throughputRecWrite', 'latencyAvgRecWrite', 'recWriteCount', 'congestion', 'oio' |
'host-domclient' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'congestion', 'oio' |
'host-domcompmgr' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'iopsRecWrite', 'throughputRecWrite', 'latencyAvgRecWrite', 'recWriteCount', 'congestion', 'oio' |
'cache-disk' | 'iopsDevRead', 'throughputDevRead', 'latencyDevRead', 'ioCountDevRead', 'iopsDevWrite', 'throughputDevWrite', 'latencyDevWrite', 'ioCountDevWrite', 'latencyDevDAvg', 'latencyDevGAvg' |
'capacity-disk' | 'iopsDevRead', 'throughputDevRead', 'latencyDevRead', 'ioCountDevRead', 'iopsDevWrite', 'throughputDevWrite', 'latencyDevWrite', 'ioCountDevWrite', 'latencyDevDAvg', 'latencyDevGAvg', 'iopsRead', 'latencyRead', 'ioCountRead', 'iopsWrite', 'latencyWrite', 'ioCountWrite' |
'disk-group' | 'iopsSched', 'latencySched', 'outstandingBytesSched', 'iopsSchedQueueRec', 'throughputSchedQueueRec','latencySchedQueueRec', 'iopsSchedQueueVM', 'throughputSchedQueueVM','latencySchedQueueVM', 'iopsSchedQueueMeta', 'throughputSchedQueueMeta','latencySchedQueueMeta', 'iopsDelayPctSched', 'latencyDelaySched', 'rcHitRate', 'wbFreePct', 'warEvictions', 'quotaEvictions', 'iopsRcRead', 'latencyRcRead', 'ioCountRcRead', 'iopsWbRead', 'latencyWbRead', 'ioCountWbRead', 'iopsRcWrite', 'latencyRcWrite', 'ioCountRcWrite', 'iopsWbWrite', 'latencyWbWrite', 'ioCountWbWrite', 'ssdBytesDrained', 'zeroBytesDrained', 'memCongestion', 'slabCongestion', 'ssdCongestion', 'iopsCongestion', 'logCongestion', 'compCongestion', 'iopsDirectSched', 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'oioWrite', 'oioRecWrite', 'oioWriteSize', 'oioRecWriteSize', 'rcSize', 'wbSize', 'capacity', 'capacityUsed', 'capacityReserved', 'throughputSched' |
'object' | 'iopsRead', 'throughputRead', 'latencyReadAvg', 'latencyReadStddev', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyWriteAvg', 'latencyWriteStddev', 'writeCount' |
'virtual-machine' | 'iopsRead', 'throughputRead', 'latencyReadAvg', 'latencyReadStddev', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyWriteAvg', 'latencyWriteStddev', 'writeCount' |
'vscsi' | 'iopsRead','iopsWrite','throughputRead','throughputWrite','latencyRead','latencyWrite' |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
querySpecs | VsanPerfQuerySpec[] |
A array of VsanPerfQuerySpec objects. The VsanPerfQuerySpec object
specifies a reference for an entity, plus optional criteria for filtering
results. Only metrics for the entitie that can be resolved are returned in
any result. The VsanPerfQuerySpec object in this operation can query for different metrics. Or, select all types of statistics for a single entity. See above for supported entity types, metric groups and metrics |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
VsanPerfEntityMetricCSV[] | The metric values for the specified entity or entities. |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the set of arguments passed to the function is not specified correctly. |
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
NotSupported | Thrown if the host queried is not a Stats Deamon master |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | |
VsanNodeNotMaster |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
VsanObjectInformation | Object information structure |
Faults
Type | Description |
---|---|
FileNotFound | |
FileNotWritable | |
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ComputeResource |
VSAN cluster. Ignored if called against host.
Since vSphere API 5.5 |
profile* | VirtualMachineProfileSpec |
See above description for all possible options.
Since vSphere API 5.5 |
Return Value
Type | Description |
---|---|
xsd:boolean | True |
Faults
Type | Description |
---|---|
FileNotFound | |
FileNotWritable | |
InvalidArgument | |
NotFound | Thrown if no ESX host could be contacted to perform the operation when called against VC. |
NotSupported | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
VsanFault | Thrown if the caller doesn't have the required privilege |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |