Start Support Bundle

Start Support Bundle

Start a Support Bundle operation using SoS

Request
URI
POST
https://{api_host}/v1/system/support-bundles
COPY
Request Body
SupportBundleSpec of type(s) application/json
Required
{
    "options": {
        "config": {
            "skipKnownHostCheck": false,
            "force": false
        },
        "include": {
            "summaryReport": false,
            "healthCheck": false
        }
    },
    "scope": {
        "includeFreeHosts": false,
        "domains": [
            {
                "domainName": "string",
                "clusterNames": [
                    "string"
                ]
            }
        ]
    },
    "logs": {
        "vcLogs": false,
        "nsxLogs": false,
        "esxLogs": false,
        "wcpLogs": false,
        "sddcManagerLogs": false,
        "apiLogs": false,
        "vxrailManagerLogs": false,
        "systemDebugLogs": false,
        "vmScreenshots": false,
        "vraLogs": false,
        "vropsLogs": false,
        "vrliLogs": false,
        "vrslcmLogs": false,
        "automationLogs": false,
        "operationsLogs": false,
        "operationsForLogs": false,
        "lifecycleLogs": false
    }
}
object
options
Optional

Sos options for support bundle collection.

object
scope
Optional

Domain and cluster under which logs should be collected.

object
logs
Optional

Logs of different components.

Responses
202

Accepted

Returns SupportBundle of type(s) application/json
"SupportBundle Object"
string
status
Optional

Support Bundle Status.

string
creationTimestamp
Optional

CreationTimestamp.

string
description
Optional

Name of the Operation.

string
bundleAvailable
Optional

Indicate if bundle is available in file system.

string
id
Optional

Id of the Support Bundle task.

string
completionTimestamp
Optional

CompletionTimestamp.

string
bundleName
Optional

Name of the Support Bundle.


400

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

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


401

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

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


409

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

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

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

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/system/support-bundles