Create Support Bundle
Returns the location SupportBundle.Location information for downloading the Namespaces-related support bundle for the specified cluster. Retrieving a support bundle involves two steps:
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
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/support-bundle
Path Parameters
Path Parameters
string
cluster
Required
Identifier of cluster for which the Namespaces-related support bundle should be generated. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
NamespaceManagementSupportBundleLocation
of type application/json
the download location of the support bundle for the cluster.
{
"url": "string",
"wcp_support_bundle_token": {
"expiry": "string",
"token": "string"
}
}
string
url
Required
Support Bundle Download URL.
wcp_support_bundle_token
Required
Information about the token required in the HTTP GET request to generate the support bundle.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Global.Diagnostics privilege.
404
com.vmware.vapi.std.errors.not_found : if the specified cluster is not registered on this vCenter server.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-CreateClusterNamespaceManagementSupportBundle -Cluster "MyCluster"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/support-bundle
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.0.0
