REST API - create-task

appliance support bundle: create-task

Create a support bundle. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/appliance/support-bundle

?vmw-task=true
{
    "components"{
        "<string>"[
            "string",
            "string"
        ]
    },
    "partition""string",
    "description""string"
}

Body Parameters:

Name Type Description
bold = required
- create_spec
-.description string Support bundle creation description. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

-.components object Support bundle components to be included. Map with groupName as key and list of components in that group as the value. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

-.components.* string[]
-.partition string Partition to be used for saving the support bundle. Available partitions can be retrieved using storage.list API. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string

Errors:

HTTP Status Code Type Description
400 not_allowed_in_current_state If already a support bundle task is in progress
400 invalid_argument
500 error Generic error