Create Support Bundle

Released in v7.0.0.0

Step 1: Invoke operation to provision a token and a URI.
Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it. There can only be one valid token per cluster at any given time. If this operation is invoked again for the same cluster identifier while a token still valid, the API will return the same SupportBundle.Location response. The HTTP GET request will:
return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes’ bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response’s Content-Disposition header.

Request

URL

POST

https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/support-bundle

Path Parameters

Required	Parameter Name	Type	Description
required	cluster	string	Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

Response

Response Body

201 Created returns SupportBundleLocation of type application/json

the download location of the support bundle for the cluster.

{
    "url": "string",
    "wcp_support_bundle_token": {
        "expiry": "string",
        "token": "string"
    }
}

Property Name	Type	Description
url	string	Support Bundle Download URL.
wcp_support_bundle_token	SupportBundleToken	Information about the token required in the HTTP GET request to generate the support bundle.

Errors

Code	Returns	Description
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. \| com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404	Error	com.vmware.vapi.std.errors.not_found : if the specified cluster is not registered on this vCenter server. \| com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default	Error	Not available

Request