[{"label":"Latest (4.4.0)","version":"latest"},{"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

Supportbundles

Description

Initiates Support bundle download

Request

Request

URL

URL


post
https://sfo-vcf01.rainpole.io/v1/system/support-bundles
Copy

Request Body

Request Body

SupportBundleSpec of type(s) application/json Required

supportbundlespec

{
	"logs": {
		"apiLogs": false,
		"esxLogs": false,
		"nsxLogs": false,
		"sddcManagerLogs": false,
		"systemDebugLogs": false,
		"vcLogs": false,
		"vmScreenshots": false,
		"vraLogs": false,
		"vrliLogs": false,
		"vropsLogs": false,
		"vrslcmLogs": false,
		"vxrailManagerLogs": false,
		"wcpLogs": false
	},
	"options": {
		"config": {
			"force": false,
			"skipKnownHostCheck": false
		},
		"include": {
			"healthCheck": false,
			"summaryReport": false
		}
	},
	"scope": {
		"domains": [
			{
				"clusterNames": [
					"string"
				],
				"domainName": "string"
			}
		],
		"includeFreeHosts": false
	}
}
logs Optional

Logs of different components.


options Optional

Sos options for support bundle collection.


scope Optional

Domain and cluster under which logs should be collected.

Response

Response

Response Body

Response Body

200 OK returns SupportBundle 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

Support Bundle 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 '{"logs":{"apiLogs":false,"esxLogs":false,"nsxLogs":false,"sddcManagerLogs":false,"systemDebugLogs":false,"vcLogs":false,"vmScreenshots":false,"vraLogs":false,"vrliLogs":false,"vropsLogs":false,"vrslcmLogs":false,"vxrailManagerLogs":false,"wcpLogs":false},"options":{"config":{"force":false,"skipKnownHostCheck":false},"include":{"healthCheck":false,"summaryReport":false}},"scope":{"domains":[{"clusterNames":["string"],"domainName":"string"}],"includeFreeHosts":false}}' https://sfo-vcf01.rainpole.io/v1/system/support-bundles


[{"label":"Latest (4.4.0)","version":"latest"},{"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?