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, VsanQueryLSOMwbsize, VsanQueryNvmeCriticalWarningStats, VsanQueryObjectSnapshotsInfo, VsanQueryZdomScrubberData

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: Host.Inventory.EditCluster

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>

VsanQueryLSOMwbsize(vsanQueryLSOMwbsize)

It is a VC level API that iterates over all hosts in the clusters to get LSOM wbSize through the host level API. Only supported in vSAN OSA Example: { host-29 :{ "5257a570-922c-9a38-e79a-3ab2871ab0b8": { "wbSize": 16105168896 }, "521530b5-91cf-0dfe-d469-9cdfc9146b64": { "wbSize": 0 }, "521446ca-e8bb-e369-912c-abb02b97001f": { "wbSize": 0 }, }, host-30:{ "5257a570-922c-9a38-e79a-3ab2871ab0b8": { "wbSize": 16105168896 }, "521530b5-91cf-0dfe-d469-9cdfc9146b64": { "wbSize": 0 }, "521446ca-e8bb-e369-912c-abb02b97001f": { "wbSize": 0 } } }

Required Privileges: None
Since: vSAN API 8.0.0.4

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanPhoneHomeSystem used to make the method call.

cluster P

ManagedObjectReference
to a ClusterComputeResource

Since vSAN API 8.0.0.4

P Required privilege: System.Read

Return Value

Type	Description
xsd:string

Faults

Type	Description
InvalidArgument
InvalidType
ManagedObjectNotFound
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryLSOMwbsize" type="vsan:VsanQueryLSOMwbsizeRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryLSOMwbsizeResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VsanQueryNvmeCriticalWarningStats(vsanQueryNvmeCriticalWarningStats)

API to Enhance DDH health state monitoring for VSAN NVMe disks to check the NVMe critical warnings. This API iterates over each host to call the Host Level API to collect the data Note: This data is collected for only VSAN NVMe devices

Required Privileges: None
Since: vSAN API 8.0.0.4

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.4

P Required privilege: System.Read

Return Value

Type	Description
xsd:string	string of json format data, for example: { "host-29":{ "eui.3c22afd568ada7e3000c29675e8e0701": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 }, "eui.1c29f18de63cdc84000c2965dd62c898": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 } } "host-30":{ "eui.3c22afd568ada7e3000c29675e8e0701": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 }, "eui.1c29f18de63cdc84000c2965dd62c898": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 } } }

Type

Description

xsd:string

string of json format data, for example: { "host-29":{ "eui.3c22afd568ada7e3000c29675e8e0701": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 }, "eui.1c29f18de63cdc84000c2965dd62c898": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 } } "host-30":{ "eui.3c22afd568ada7e3000c29675e8e0701": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 }, "eui.1c29f18de63cdc84000c2965dd62c898": { "spare_space": 0, "temp_exceeded_threshold": 0, "subsystem_reliability_degraded": 0, "read_only": 0, "backup_failed": 0 } } }

Faults

Type	Description
InvalidArgument
InvalidType
ManagedObjectNotFound
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryNvmeCriticalWarningStats" type="vsan:VsanQueryNvmeCriticalWarningStatsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryNvmeCriticalWarningStatsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string" minOccurs="0"/>
                     </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: System.Read

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>

VsanQueryZdomScrubberData(vsanQueryZdomScrubberData)

VC API to iterate over all hots to collect zDOMscrubber stats from the path "/vmkModules/vsan/zdom/zdomObjects//zdomPaused" Note: This data is collected for hosts which are part of VSAN ESA cluster only

Required Privileges: None
Since: vSAN API 8.0.0.4

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.4

P Required privilege: System.Read

Return Value

Type	Description
xsd:string	string of json format data, for example: { "" : [{'Object_uuid': , 'state': }, {'Object_uuid': , 'state': }], "" : [{'Object_uuid': , 'state': }] }

Faults

Type	Description
InvalidArgument
InvalidType
ManagedObjectNotFound
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryZdomScrubberData" type="vsan:VsanQueryZdomScrubberDataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryZdomScrubberDataResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

vSAN Management API

Managed Object - VsanPhoneHomeSystem(vim.VsanPhoneHomeSystem)

Managed Object Description

QueryVsanCloudHealthStatus(queryVsanCloudHealthStatus)

VsanPerformOnlineHealthCheck(vsanPerformOnlineHealthCheck)

VsanQueryLSOMwbsize(vsanQueryLSOMwbsize)

VsanQueryNvmeCriticalWarningStats(vsanQueryNvmeCriticalWarningStats)

VsanQueryObjectSnapshotsInfo(vsanQueryObjectSnapshotsInfo)

VsanQueryZdomScrubberData(vsanQueryZdomScrubberData)