Create Support Bundle Task
Create a support bundle.
Request
URLURL
https://{api_host}/api/appliance/support-bundle?vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
SupportBundleCreateSpec of mimetype application/json
Required
This parameter has no documentation
(Both the class referenced by the parameter and parameter itself are missing descriptions)
{
"description": "string"
}
string
description
Required
Support bundle creation description.
map of
string
components
Optional
Support bundle components to be included. Map with groupName as key and list of components in that group as the value.
string
partition
Optional
Partition to be used for saving the support bundle. Available partitions can be retrieved using storage.list API.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
PowerCLI Client SDK Example
$SupportBundleCreateSpec = Initialize-SupportBundleCreateSpec -Description "MyDescription"
Invoke-CreateSupportBundleAsync -SupportBundleCreateSpec $SupportBundleCreateSpec
PowerCLI Client SDK All Parameters Example
$SupportBundleCreateSpec = Initialize-SupportBundleCreateSpec -Description "MyDescription" -Components @{ key_example = "MyInner" } -Partition "MyPartition"
Invoke-CreateSupportBundleAsync -SupportBundleCreateSpec $SupportBundleCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"components":{"key":"string"},"description":"string","partition":"string"}' https://{api_host}/api/appliance/support-bundle?vmw-task=true
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If already a support bundle task is in progress | com.vmware.vapi.std.errors.invalid_argument : The request cannot be fulfilled due to bad syntax.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
Availability
Added in 7.0.1.0
