You can use HTTP requests to perform support bundle management operations.

The following HTTP requests show the syntax that you can use to perform the available user operations.

  • Get support bundle components

    GET https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle/components

  • List support bundles

    GET https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle

  • Create a support bundle

    POST https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle

For information about the content and syntax of the HTTP request body for each operation, see the API reference documentation.

Example Input and Output for Support Bundle Management Operations

The following examples provide sample input and output values for the support bundle management operations.

Get Support Bundle Components

This operation does not require input.

GET https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle/components

Type

Example

Output

 
{
"Group1" : List of manifests under this group,
"Group2": ...
}

List Support Bundles

This operation does not require input, but supports optional query parameters.

GET https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle

Type

Example

Input

 
"IterationSpec":{
"size" : 10
}
FilterSpec:{
"creationStatus" : "SUCCEEDED",
"available" : True/False
}

Output

 
{
"Description": "Reason for generation",
"Generation time": 2 Mar 2021,
"URL" : "Download URL",
"Downloadable" : True/False
"Expiration time": "URL expiration time"
}

Create a Support Bundle

This operation requires description input and supports optional body parameters. As output, you receive a task ID, which you can use to track the progress of the task. When the operation is completed, you receive the download URL in the task response.

POST https://<vcenter_ip_address_or_fqdn>:443/api/appliance/support-bundle

Type

Example

Input

 
{
"Description" : "Reason",
"Inclusions" : List of components to be included in the bundle
<Optional> path: partition to be used.
}

Output

Task ID