vSAN Management API
|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - DataProtectionHealthSystem(vim.vsan.DataProtectionHealthSystem)
- See also
- ClusterComputeResource, VsanClusterHealthSummary, VsanHistoricalHealthQuerySpec
- Since
- 9.1.0.0
Managed Object Description
This managed object provides access to Data Protection (DP) Health related configuration and query APIs, operating at the vCenter or cluster level. It can be accessed via the MOID of 'dp-health-system' through vSAN service at vCenter server side.Properties
| Name | Type | Description |
|---|---|---|
| None | ||
Methods
| Methods defined in this Managed Object |
|---|
| VsanGetDpClusterSilentChecks, VsanQueryHealthSummary, VsanQueryHistoricalHealth, VsanSetDpClusterSilentChecks |
VsanGetDpClusterSilentChecks(getDpClusterSilentChecks)
Get the user configured silent data protection health check list of the cluster. This API is only supported on the cluster with data protection enabled.- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DataProtectionHealthSystem used to make the method call. |
| cluster P | ManagedObjectReference
to a ClusterComputeResource |
The target cluster which has data protection enabled
Since 9.1.0.0 |
Return Value
| Type | Description |
|---|---|
| xsd:string[] | The list of all silent health checks testIds |
Faults
| Type | Description |
|---|---|
| NotFound | Thrown if the cluster is not found. |
| NotSupported | Thrown if run directly on an ESX Server host. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VsanFault |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
VsanQueryHealthSummary(queryHealthSummary)
Query Data Protection (DP) health data and generate health checks. It's the primary API for fetching latest DP health status. This API doesn't support host level call and will throw exception in that case. The DP health summary is pushed from the DP appliance and stored in memory by the vSAN health service. If the DP appliance is offline or experiences a loss of connectivity, the vSAN health service will be unable to provide the most current DP health data. However, if the vSAN health service is restarted, it will first load the most recent available DP health status from the historical health database. It will then update the health status once new data is received from the DP appliance, which typically occurs after a few minutes.- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DataProtectionHealthSystem used to make the method call. |
| cluster | ManagedObjectReference
to a ClusterComputeResource |
The target cluster.
Since 9.1.0.0 |
Return Value
| Type | Description |
|---|---|
| VsanClusterHealthSummary | Returns a health summary data object, containing the current DP health status. |
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 |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
VsanQueryHistoricalHealth(queryHistoricalHealth)
Query Data Protection (DP) historical health information based on the query spec.- Query general DP historical health summary. If no groupId and testId specified in the query spec, it aggregates all the historical DP health status for the given time range. Then returns a general DP health summary with only overallHealth, test group IDs, group healths, test IDs and test healths.
- Query DP health status history for a certain DP health check. If groupId and testId are specified, and start time doesn't equal to end time, the result will only contain the historical testHealths for the given time range of the target health check.
- Query a snapshot detail for a certain DP health check. If groupId and testId are specified, and start time equals to end time, the result will contain a full testDetail for the certain timestamp of the target DP health check.
- Query overall DP health trend during the given time range. If both groupId and testId are specified to "#" in the query spec, the result will contain a series of DP health summaries with overallHealth, healthStatusCounts and timestamp within the given time range.
- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DataProtectionHealthSystem used to make the method call. |
| spec | VsanHistoricalHealthQuerySpec |
The query spec.
Since 9.1.0.0 |
Return Value
| Type | Description |
|---|---|
| VsanClusterHealthSummary[] | DP health summary with historical information. |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Exception for invalid input arguments. For example, if the given time range is more than one month, or in case the end time is before the start time. |
| NotFound | |
| NotSupported | Thrown if run directly on an ESX Server host. |
| 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 | |
Show WSDL type definition
VsanSetDpClusterSilentChecks(setDpClusterSilentChecks)
Set silent health check list of the cluster. Specify [testId/groupId] for 'addSilentChecks' to add add health checks to silent list. Specify [testId/groupId] for 'removeSilentChecks' to remove health checks from silent list. To restore the whole silent list, set 'removeSilentChecks' = ['all']. After the silent health check list is updated, it is recommended to refresh the vSAN cluster data protection health summary to get the updated result. The health check items in the silent list should be skipped, and labeled with 'skipped' status. Note:- If groupId is added to silent list, all the checks under this group would be silent.
- If groupId is removed from silent list, all the checks under this group would back to normal.
- If given invalid testId/groupId, it will throw exception.
- This method will do add first and then remove. So if the given health check is in both add and remove list, it would NOT be silent in the end.
- This API is only supported for data protection health checks.
- Required Privileges
- Global.Settings
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the DataProtectionHealthSystem used to make the method call. |
| cluster | ManagedObjectReference
to a ClusterComputeResource |
The target data protection protected cluster
Since 9.1.0.0 |
| addSilentChecks* | xsd:string[] |
The health checks/groups to silent.
Since 9.1.0.0 |
| removeSilentChecks* | xsd:string[] |
The health checks/groups to restore.
Since 9.1.0.0 |
Return Value
| Type | Description |
|---|---|
| xsd:boolean | True to indicate the value being set successfully. No return otherwise. |
Faults
| Type | Description |
|---|---|
| NotFound | Thrown if the cluster is not found. |
| NotSupported | Thrown if run directly on an ESX Server host. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
| VsanFault |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |