# Managed Object - VsanPhoneHomeSystem(vim.VsanPhoneHomeSystem)

See also
  ClusterComputeResource, Task, VsanCloudHealthStatus
Since
  vSAN API 6.6

## Managed Object Description

VsanPhoneHomeSystem contains a collection of APIs to perform online health checks. The Managed Entity can be accessed through MOID of vsan-phonehome-system through vSAN service at vCenter server side.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
QueryVsanCloudHealthStatus, VsanPerformOnlineHealthCheck, VsanQueryObjectSnapshotsInfo

# QueryVsanCloudHealthStatus(queryVsanCloudHealthStatus)

QueryVsanCloudHealthStatus returns a VsanCloudHealthStatus object with various states of the vSAN CEIP Collector Agent. When checking for internet connectivity, a connection to https://vcsa.vmware.com/ will be attempted with timeout of 10 seconds.

Required Privileges
  Global.Diagnostics
Since
  vSAN API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanPhoneHomeSystem used to make the method call.

Return Value

Type | Description
--- | ---
VsanCloudHealthStatus | vim.vsan.VsanCloudHealthStatus

Faults

Type | Description
--- | ---
InvalidArgument |
NotFound |
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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanCloudHealthStatus" type="vsan:QueryVsanCloudHealthStatusRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanCloudHealthStatusResponse"> <complexType> <sequence> <element name="returnval" type="vsan:VsanCloudHealthStatus" minOccurs="0"/> </sequence> </complexType> </element>

# VsanPerformOnlineHealthCheck(vsanPerformOnlineHealthCheck)

An asynchronous API for performing vSAN online health checks. This API generates a task to collect current vSAN environment settings and performance data driven by a manifest, and send the collected data to VMware for data streaming analysis. It then queries the analyzed results back to help customer have the best vSAN practices. This task usually takes about 1 minute for a typical 4 nodes vSAN cluster. However, this task can take more time based on the size of vSAN cluster, the size of queried data driven by manifest and the customer Internet speed.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanPhoneHomeSystem used to make the method call.
cluster P | ManagedObjectReference to a ClusterComputeResource | The target vSAN cluster Since vSAN API 6.6

P Required privilege: cluster

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Task | task vCenter Task

Faults

Type | Description
--- | ---
InvalidArgument |
NotFound |
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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPerformOnlineHealthCheck" type="vsan:VsanPerformOnlineHealthCheckRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanPerformOnlineHealthCheckResponse"> <complexType> <sequence> <element name="returnval" type="vsan:ManagedObjectReference"/> </sequence> </complexType> </element>

# VsanQueryObjectSnapshotsInfo(vsanQueryObjectSnapshotsInfo)

API to get vSAN object snapshot information in a vSAN cluster

Required Privileges
  None
Since
  vSAN API 8.0.0.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the VsanPhoneHomeSystem used to make the method call.
cluster P | ManagedObjectReference to a ClusterComputeResource | Target cluster Since vSAN API 8.0.0.1

P Required privilege: cluster

Return Value

Type | Description
--- | ---
xsd:string | string of json format data, for example: {"summary" : { "TotalObjects" : , "TotalSnapshots" : }, "detail" : { "snapshot_count_0" : count, "snapshot_count_1" : count, "snapshot_count_2" : count } }

Faults

Type | Description
--- | ---
InvalidArgument | Exception for invalid input arguments, for example, if the given argument is not passed correctly.
InvalidType | Exception for invalid type arguments, for example, if the given argument is not type of cluster moId.
ManagedObjectNotFound | Exception for invalid reference argument, for example, if the given cluster is not found.
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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryObjectSnapshotsInfo" type="vsan:VsanQueryObjectSnapshotsInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryObjectSnapshotsInfoResponse"> <complexType> <sequence> <element name="returnval" type="xsd:string" minOccurs="0"/> </sequence> </complexType> </element>