| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Privileges | Required on |
---|---|
Global.Diagnostics | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
task | ManagedObjectReference
to a Task |
Task returned by VsanPerfDiagnoseTask
|
cluster* | ManagedObjectReference
to a ComputeResource |
vSAN cluster. Ignored if called against host.
Since vSAN API 6.7 |
Return Value
Type | Description |
---|---|
VsanPerfDiagnosticResult[] | A list of performance issues. |
Faults
Type | Description |
---|---|
NotFound | Thrown if no result is found in the cache for the specified task |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | |
VsanFault | Thrown if the caller doesn't have the required privilege, or the cluster has no hosts. |
Events
Type | |
---|---|
None |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 separator) 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 ESXi host could be contacted to perform the operation when called against vCenter. |
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 |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 ESXi host could be contacted to perform the operation when called against vCenter. |
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 |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 |
Privileges | Required on |
---|---|
Global.Diagnostics | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ClusterComputeResource |
Since vSAN API 6.6 |
name | xsd:string |
Delete by the name of VsanPerfTimeRange
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidArgument | |
NotFound | |
NotSupported | |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
perfDiagnoseQuery | VsanPerfDiagnoseQuerySpec |
The query describing details of diagnosis
required, such as the period of diagnosis and the query type.
|
cluster* | ManagedObjectReference
to a ComputeResource |
vSAN cluster. Ignored if called against host.
Since vSAN API 6.6 |
Return Value
Type | Description |
---|---|
VsanPerfDiagnosticResult[] | The list of performance issues found. Each performance issue is returned as a VsanPerfDiagnosticResult. The VsanPerfDiagnosticResult object will contain the entity and the metrics that caused the performance exception. |
Faults
Type | Description |
---|---|
InvalidArgument | |
NotFound | |
NotSupported | |
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 |
Privileges | Required on |
---|---|
Global.Diagnostics | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
perfDiagnoseQuery | VsanPerfDiagnoseQuerySpec |
The query describing details of diagnosis
required, such as the period of diagnosis and the query type.
|
cluster* | ManagedObjectReference
to a ComputeResource |
vSAN cluster. Ignored if called against host.
Since vSAN API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | A task doing the asynchronous work. |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the set of arguments passed to the function is not specified correctly. |
NotFound | Thrown if no ESXi host could be contacted to perform the operation when called against vCenter or if the API was not invoked on vCenter or if CEIP is not enabled |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Timedout | |
VsanFault | Thrown if the caller doesn't have the required privilege, or the cluster has no hosts. |
VsanNodeNotMaster |
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 |
---|---|
NotFound | |
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. |
Return Value
Type | Description |
---|---|
VsanPerfDiagnosticException[] |
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. |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 ESXi host could be contacted to perform the operation when called against vCenter. |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 | Entity ID format | Example | Notes |
---|---|---|---|
cluster-domclient | <cluster-UUID> | 'cluster-domclient:52c89b61-f818-e495-af20-816d24c850b8' | The UUID is represented by the associated cluster UUID. |
cluster-domcompmgr | <cluster-UUID> | 'cluster-domcompmgr:52c89b61-f818-e495-af20-816d24c850b8' | The UUID is represented by the associated cluster UUID. |
host-domclient | <host-UUID> | 'host-domclient:588b2225-c58c-8365-c47b-02001065be12' | The UUID is represented by the associated ESXi host UUID. |
host-domcompmgr | <host-UUID> | 'host-domcompmgr:588b2225-c58c-8365-c47b-02001065be12' | The UUID is represented by the associated ESXi host UUID. |
cache-disk | <CacheDisk-UUID> | 'cache-disk:55c98c4d-41f0-6ff7-2784-0200103eb5e1' | The UUID is represented by the associated cache disk UUID. |
capacity-disk | <CapacityDisk-UUID> | 'capacity-disk:55c98c4d-41f0-6ff7-2784-0200103eb5e1' | The UUID is represented by the associated capacity disk UUID. |
disk-group | <CacheDisk-UUID> | 'disk-group:55c98c4d-41f0-6ff7-2784-0200103eb5e1' | The UUID is represented by the associated disk group UUID, which is the same as cache disk UUID. |
vscsi | <VM-instance-UUID>|<VSCSI-name> | 'vscsi:55c98c4d-41f0-6ff7-2784-0200103eb5e1|vscsi0:1' | The UUID is represented by the associated VM instance UUID with its VSCSI name. Virtual disk IOPS limit statistics are associated with 'virtual-disk'. |
virtual-disk | <VM-dir-uuid>/<VMDK-file-name> | 'virtual-disk:a2a04b57-e0e6-502b-e4a0-0200073bd703/iops-160-10.160.109.28-1_1.vmdk' | The UUID is represented by the VMDK file path, which can be retrieved using the vSphere API. |
vsan-vnic-net | <host-UUID>|<stack-name>|<vnic-name> | 'vsan-vnic-net:588b2225-c58c-8365-c47b-02001065be12|defaultTcpipStack|vmknic0' | The UUID is represented by the associated ESXi host UUID with its stack name and vNIC name. |
vsan-pnic-net | <host-UUID>|<pnic-name> | 'vsan-pnic-net:588b2225-c58c-8365-c47b-02001065be12|vmnic0' | This UUID is represented by the associated ESXi host UUID with the pNIC name. |
lsom-world-cpu | <host-UUID>|<world-name>|<world-id> | 'lsom-world-cpu:5ad47458-3bca-870a-602c-02002c89fe44|VSAN_0x43050bf3f7f8_LSOMLLOG|1001393599' | The UUID is represented by the associated ESXi host UUID with the LSOM world name and its world ID. |
dom-world-cpu | <host-UUID>|<world-name>|<world-id> | 'dom-world-cpu:5ad47458-3bca-870a-602c-02002c89fe44|VSAN_0x430bfa348888_CompServer|1001393015' | The UUID is represented by the associated ESXi host UUID with its DOM world name and world ID. |
host-cpu | <host-UUID> | 'host-cpu:5ad47458-3bca-870a-602c-02002c89fe44' | The UUID is represented by the associated ESXi host UUID. |
iscsi-target-alias | <iscsi-target-alias>|<lunid> | 'iscsi-target-alias:iscsitargetaliasexample|1' | The UUID is represented by iSCSI target alias with the LUN ID. |
vsan-datastore-capacity | <cluster-UUID> | 'vsan-cluster-capacity:52c89b61-f818-e495-af20-816d24c850b8' | The UUID is represented by the associated cluster UUID. |
Entity Type | Metrics (Labels) |
---|---|
'cluster-domclient' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'congestion', 'oio' |
'cluster-domcompmgr' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'iopsRecWrite', 'throughputRecWrite', 'latencyAvgRecWrite', 'congestion', 'oio', 'iopsResyncRead', 'tputResyncRead', 'latAvgResyncRead' |
'host-domclient' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'congestion', 'oio', 'clientCacheHits', 'clientCacheHitRate', 'iopsUnmap', 'throughputUnmap', 'latencyAvgUnmap' |
'host-domcompmgr' | 'iopsRead', 'throughputRead', 'latencyAvgRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyAvgWrite', 'writeCount', 'iopsRecWrite', 'throughputRecWrite', 'latencyAvgRecWrite', 'recWriteCount', 'congestion', 'oio', 'iopsResyncRead', 'tputResyncRead', 'latAvgResyncRead', 'iopsUnmap', 'iopsRecUnmap', 'throughputUnmap', 'throughputRecUnmap', 'latencyAvgUnmap', 'latencyAvgRecUnmap' |
'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', 'iopsResyncReadPolicy', 'iopsResyncReadDecom', 'iopsResyncReadRebalance', 'iopsResyncReadFixComp', 'iopsResyncWritePolicy', 'iopsResyncWriteDecom', 'iopsResyncWriteRebalance', 'iopsResyncWriteFixComp', 'tputResyncReadPolicy', 'tputResyncReadDecom', 'tputResyncReadRebalance', 'tputResyncReadFixComp', 'tputResyncWritePolicy', 'tputResyncWriteDecom', 'tputResyncWriteRebalance', 'tputResyncWriteFixComp', 'latResyncReadPolicy', 'latResyncReadDecom', 'latResyncReadRebalance', 'latResyncReadFixComp', 'latResyncWritePolicy', 'latResyncWriteDecom', 'latResyncWriteRebalance', 'latResyncWriteFixComp' |
'virtual-machine' | 'iopsRead', 'throughputRead', 'latencyReadAvg', 'latencyReadStddev', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyWriteAvg', 'latencyWriteStddev', 'writeCount' |
'vscsi' | 'iopsRead', 'throughputRead', 'latencyRead', 'readCount', 'iopsWrite', 'throughputWrite', 'latencyWrite', 'writeCount' |
'virtual-disk' | 'iopsLimit', 'NIOPS', 'NIOPSDelayed' |
'vsan-host-net' | 'rxThroughput', 'rxPackets', 'rxPacketsLossRate', 'txThroughput', 'txPackets', 'txPacketsLossRate', 'tcpTxRexmitRate', 'tcpRxErrRate' |
'vsan-vnic-net' | 'rxThroughput', 'rxPackets', 'rxPacketsLossRate', 'txThroughput', 'txPackets', 'txPacketsLossRate', 'portRxDrops', 'portTxDrops' |
'vsan-pnic-net' | 'rxThroughput', 'rxPackets', 'rxPacketsLossRate', 'txThroughput', 'txPackets', 'txPacketsLossRate', 'portRxDrops', 'portTxDrops' |
'lsom-world-cpu' | 'usedPct', 'readyPct' |
'dom-world-cpu' | 'usedPct', 'readyPct' |
'host-cpu' | 'coreUtilPct', 'pcpuUtilPct', 'pcpuUsedPct' |
'vsan-iscsi-host' | 'iopsRead', 'iopsWrite', 'iopsTotal', 'bandwidthRead', 'bandwidthWrite', 'bandwidthTotal', 'latencyRead', 'latencyWrite', 'latencyTotal', 'queueDepth' |
'vsan-iscsi-target' | 'iopsRead', 'iopsWrite', 'iopsTotal', 'bandwidthRead', 'bandwidthWrite', 'bandwidthTotal', 'latencyRead', 'latencyWrite', 'latencyTotal', 'queueDepth' |
'vsan-iscsi-lun' | 'iopsRead', 'iopsWrite', 'iopsTotal', 'bandwidthRead', 'bandwidthWrite', 'bandwidthTotal', 'latencyRead', 'latencyWrite', 'latencyTotal', 'queueDepth' |
'vsan-cluster-capacity' | 'total', 'used', 'free', 'savedByDedup', 'dedupRatio' |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 entities 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 Note: To avoid performance and resource usage issues caused by massive stats data from a stats query. In each query, the startTime and endTime must be specified in the query spec. And the suggested time span is less than 24 hours. To query stats for larger time range, please use paging mechanism. For example, split the time range in to smaller ones, and use multiple status queries with smaller time ranges. |
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 ESXi host could be contacted to perform the operation when called against vCenter. |
NotSupported | Thrown if the host queried is not a Stats Daemon 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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
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 ESXi host could be contacted to perform the operation when called against vCenter. |
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 |
Privileges | Required on |
---|---|
System.Read | ClusterComputeResource |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ClusterComputeResource |
Since vSAN API 6.6 |
querySpec | VsanPerfTimeRangeQuerySpec |
Specify the name and time boundaries. See details
in VsanPerfTimeRangeQuerySpec
|
Return Value
Type | Description |
---|---|
VsanPerfTimeRange[] |
Faults
Type | Description |
---|---|
InvalidArgument | |
NotFound | |
NotSupported | |
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 |
Privileges | Required on |
---|---|
Global.Diagnostics | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ClusterComputeResource |
Since vSAN API 6.6 |
timeRanges | VsanPerfTimeRange[] |
VsanPerfTimeRange list to be saved.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidArgument | |
NotFound | |
NotSupported | |
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 |
Privileges | Required on |
---|---|
Host.Inventory.EditCluster | ClusterComputeResource |
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 ESXi host could be contacted to perform the operation when called against vCenter. |
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 |
Privileges | Required on |
---|---|
Global.Settings | RootFolder |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanPerformanceManager used to make the method call. |
cluster* | ManagedObjectReference
to a ClusterComputeResource |
Since vSAN API 6.6 |
verboseMode | xsd:boolean |
Switch of verbose mode, the type is boolean.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidArgument | |
NotFound | |
NotSupported | |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |