[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
Health Summary
DescriptionInitiates Health Summary checks.
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/system/health-summary
Request Body
Request Body
{
"healthChecks": {
"certificateHealth": false,
"composabilityHealth": false,
"computeHealth": false,
"connectivityHealth": false,
"dnsHealth": false,
"generalHealth": false,
"hardwareCompatibilityHealth": false,
"ntpHealth": false,
"passwordHealth": false,
"servicesHealth": false,
"storageHealth": false
},
"options": {
"config": {
"force": false,
"skipKnownHostCheck": false
},
"include": {
"summaryReport": false
}
},
"scope": {
"domains": [
{
"clusterNames": [
"string"
],
"domainName": "string"
}
],
"includeAllDomains": false,
"includeFreeHosts": false
}
}
Response
Response
Response BodyResponse Body
202 Accepted returns
HealthSummary
of type(s) application/json
{
"bundleAvailable": "string",
"bundleName": "string",
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"id": "string",
"status": "string"
}
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
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},"options":{"config":{"force":false,"skipKnownHostCheck":false},"include":{"summaryReport":false}},"scope":{"domains":[{"clusterNames":["string"],"domainName":"string"}],"includeAllDomains":false,"includeFreeHosts":false}}' https://sfo-vcf01.rainpole.io/v1/system/health-summary
[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]
vcf
On This Page
SOS Operations
get
post
post
