Appliance SupportBundle create$Task
Create a support bundle.
This operation was added in vSphere API 7.0.1.0.
Show optional properties
{
"description": "string"
}{
"description": "string",
"components": {
"components": [
"string"
]
},
"content_type": "string",
"partition": "string"
}Support bundle creation description.
This property was added in vSphere API 7.0.1.0.
Support bundle components to be included. Map with groupName as key and list of components in that group as the value.
This property was added in vSphere API 7.0.1.0.
Describes the content type to be collected in support bundle.
For more information see: Appliance SupportBundle ContentType.
This property was added in vSphere API 8.0.2.0.
If missing or null, both logs and core files will be collected.
Partition to be used for saving the support bundle. Available partitions can be retrieved using storage.list API.
This property was added in vSphere API 7.0.1.0.
Success!
Vapi Std Errors NotAllowedInCurrentState If already a support bundle task is in progress.
Vapi Std Errors InvalidArgument
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
Generic error.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"description:"string"}' https://{api_host}/api/appliance/support-bundle?vmw-task=true