VMware vSphere SDKs and Tools 8.0

8.0 7.0 6.7 6.5

Managing Support Bundles
Last Updated December 16, 2024

You can retrieve information about support bundles and create support bundles.
The following table lists the operations that you can perform to manage support bundles.
User Operations
Operation
Description
Get support bundle components
You can retrieve a list of components and manifests included in the support bundle. Manifests specify the files that must be collected for a component as part of the support bundle.
List support bundles
You can retrieve a list of generated support bundles. The list contains details about each support bundle.
Create a support bundle
You can generate a support bundle. Optionally, you can specify the support bundle components and the partition where you want to save the support bundle.
You can run support bundle management operations by using the
vSphere Automation
 SDK or sending an HTTP request.
For information about the HTTP requests that you can use to perform the user operations, see HTTP Requests for Support Bundle Management Operations.
REST
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.
The following examples provide sample input and output values for the support bundle management operations.
  • Example: 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": ...
}
  • Example: 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"
}
  • Example: 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

Content feedback and comments