Generate Tech Support Bundle

Generate Tech Support Log Bundle

Initiates an asynchronous tech support log collection job. Collects logs from HCX Manager, fleet appliances (IX, NE, WANOPT), and Sentinel VMs. Returns a job ID for tracking progress.

Collection Scope:

HCX Manager: Always included (web engine, app engine, HTTPD, database logs)
Fleet Appliances: Specify appliance IDs in fleetAppliances array
Sentinels: Specify Sentinel IDs in sentinels array
Database: Full PostgreSQL dump (if collectDbDump is true)

Async Operation:

Job runs in background (may take several minutes)
Use /jobStatus/{jobId} to check progress
Download bundle when job state is SUCCESS

Request

URI

POST

https://{server}:9443/api/admin/techSupportLogs/generate

COPY

Request Body

TechSupportBundleGenerateRequest of type(s) application/json

Required

{
    "collectNspTechBundle": false,
    "fleetAppliances": [
        "12345678-1234-1234-1234-123456789012"
    ],
    "collectDbDump": false,
    "sentinels": [
        "sentinel-12345678-1234-1234-1234-123456789012"
    ]
}

boolean

collectNspTechBundle

Optional

Include HCX Manager appliance logs

array of string

fleetAppliances

Optional

List of fleet appliance IDs to collect logs from (get IDs from /retrieveComponents)

boolean

collectDbDump

Optional

Include PostgreSQL database dump in the bundle

array of string

sentinels

Optional

List of Sentinel VM IDs to collect logs from (get IDs from /retrieveSentinelInventory)

Authentication

This operation uses the following authentication methods.

BASIC_AUTH

XHM_TOKEN

VCF_SSO_TOKEN

Responses

201

Tech support log collection job created successfully

Returns TechSupportJobCreatedResponse of type(s) application/json

{
    "jobId": "hcx-techsupport-2025-11-13-10-30-45-abc123"
}

string

jobId

Optional

Job identifier

400

Bad request - Invalid appliance IDs or Sentinel IDs

Returns SimpleErrorMessage of type(s) application/json

{
    "message": "string"
}

string

message

Optional

Error message

500

Internal server error - Failed to create collection job

Returns SimpleErrorMessage of type(s) application/json

{
    "message": "string"
}

string

message

Optional

Error message

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/techSupportLogs/generate

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Tech Support Logs Operations

GET

Get Fleet Components

GET