Start Support Bundle
Start a Support Bundle operation using SoS
supportbundlespec
{
"logs": {
"apiLogs": false,
"automationLogs": false,
"esxLogs": false,
"lifecycleLogs": false,
"nsxLogs": false,
"operationsForLogs": false,
"operationsLogs": 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
}
}
OK
{
"bundleAvailable": "string",
"bundleName": "string",
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"id": "string",
"status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
Indicate if bundle is available in file system.
Name of the Support Bundle.
CompletionTimestamp.
CreationTimestamp.
Name of the Operation.
Id of the Support Bundle task.
Support Bundle Status.
Accepted
{
"bundleAvailable": "string",
"bundleName": "string",
"completionTimestamp": "string",
"creationTimestamp": "string",
"description": "string",
"id": "string",
"status": "One among: IN_PROGRESS, PENDING, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE"
}
Indicate if bundle is available in file system.
Name of the Support Bundle.
CompletionTimestamp.
CreationTimestamp.
Name of the Operation.
Id of the Support Bundle task.
Support Bundle Status.
Bad request! Invalid Headers or Data. Error: {error}
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Bad request! Authorization Header is missing or not in correct format.
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Operation is in progress for Id {id}. Wait for the operation to complete.
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message
Something went wrong. Internal server error occurred. Error {error}
{
"arguments": [
"string"
],
"causes": [
{
"message": "string",
"type": "string"
}
],
"context": {
"context": "string"
},
"errorCode": "string",
"errorType": "string",
"message": "string",
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"remediationMessage": "string"
}
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
The minor error code
The error type
The localized error message
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized remediation error message