[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Health Summary

Description

Initiates Health Summary checks.

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/system/health-summary
Copy

Request Body

Request Body

HealthSummarySpec of type(s) application/json Required

healthsummaryspec

{
	"healthChecks": {
		"certificateHealth": false,
		"composabilityHealth": false,
		"computeHealth": false,
		"connectivityHealth": false,
		"dnsHealth": false,
		"generalHealth": false,
		"hardwareCompatibilityHealth": false,
		"ntpHealth": false,
		"passwordHealth": false,
		"servicesHealth": false,
		"storageHealth": false,
		"versionHealth": false
	},
	"options": {
		"config": {
			"force": false,
			"skipKnownHostCheck": false
		},
		"include": {
			"precheckReport": false,
			"summaryReport": false
		}
	},
	"scope": {
		"domains": [
			{
				"clusterNames": [
					"string"
				],
				"domainName": "string"
			}
		],
		"includeAllDomains": false,
		"includeFreeHosts": false
	}
}
healthChecks Optional

Sos Health Checks.


options Optional

Sos options for support health checks.


scope Optional

Domain and cluster under which logs should be collected.

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns HealthSummary of type(s) application/json
{
    "status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
bundleAvailable Optional

Indicate if bundle is available in file system.


string
bundleName Optional

Name of the Support Bundle.


string
completionTimestamp Optional

CompletionTimestamp.


string
creationTimestamp Optional

CreationTimestamp.


string
description Optional

Name of the Operation.


string
id Optional

Id of the Support Bundle task.


string
status Optional

Health summary collection status.


202 Accepted Response Body>

Response Body

202 Accepted

Returns HealthSummary of type(s) application/json
{
    "status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
string
bundleAvailable Optional

Indicate if bundle is available in file system.


string
bundleName Optional

Name of the Support Bundle.


string
completionTimestamp Optional

CompletionTimestamp.


string
creationTimestamp Optional

CreationTimestamp.


string
description Optional

Name of the Operation.


string
id Optional

Id of the Support Bundle task.


string
status Optional

Health summary collection status.

Errors

Errors

400

Bad request! Invalid Headers or Data. Error: {error}


401

Bad request! Authorization Header is missing or not in correct format.


409

Operation is in progress for Id {id}. Wait for the operation to complete.


500

Something went wrong. Internal server error occurred. Error {error}

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"healthChecks":{"certificateHealth":false,"composabilityHealth":false,"computeHealth":false,"connectivityHealth":false,"dnsHealth":false,"generalHealth":false,"hardwareCompatibilityHealth":false,"ntpHealth":false,"passwordHealth":false,"servicesHealth":false,"storageHealth":false,"versionHealth":false},"options":{"config":{"force":false,"skipKnownHostCheck":false},"include":{"precheckReport":false,"summaryReport":false}},"scope":{"domains":[{"clusterNames":["string"],"domainName":"string"}],"includeAllDomains":false,"includeFreeHosts":false}}' https://sfo-vcf01.rainpole.io/v1/system/health-summary


[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?