Generate a Support Bundle

Overview

A support bundle is a diagnostic package that collects logs and configuration details from one or more hosts so that Platform9 Support can investigate an issue. From the Private Cloud Director console or API, you can request a support bundle for entire clusters, specific hosts, or a single host, then download the resulting package. If a host can't reach the management plane, you can also generate a bundle directly on that host using the pcdctl CLI.

In this guide, you will generate a support bundle for one or more hosts from the Private Cloud Director console or API, and learn when to use the direct, on-host alternative instead.

Generate a Support Bundle from the Console or API

A single support bundle request can include a maximum of 10 hosts. Requesting more than 10 hosts in one request fails with:

Too many hosts in request. Maximum 10 hosts allowed per bundle request.

To collect bundles for more than 10 hosts, split them across multiple requests.

Using the UI

1. Navigate to Infrastructure > Cluster Hosts in the Private Cloud Director UI.
2. Select one or more hosts in the host grid, then choose Generate Support Bundle from the Actions menu. The same action is also available from a host's details page and from the Clusters page.
3. In the Generate Support Bundle modal, choose what to include:

   • Use the cluster list on the left to select entire clusters.
   • Use the searchable host list on the right to select individual hosts.

   The modal header tracks your selection as Selected Hosts: N.
4. Select Generate Bundle. Private Cloud Director collects logs from your selection and assembles a downloadable package; progress appears in a Generating Support Bundles (N) popover.
5. Once a bundle is ready, find its row in the Generating Support Bundles (N) popover and select the download control on that row (tooltip: Download bundle). While the download is in progress, the tooltip reads Bundle is being downloaded.

A host that already has a bundle generation in progress can't be selected again; it shows the message "This host is already in a support bundle." If every host you select is already part of an in-flight bundle, the modal shows "All hosts are already in a support bundle." Requesting a bundle for a host that's already covered by a request in progress does not start a duplicate job for that host.

If collection fails for one or more of the selected hosts, the bundle still completes for the rest. A bundle affected this way shows: "Some hosts failed to generate support bundle. If you download the bundle, some hosts may not be included."

Using the API

Send a POST request to the hosts support-bundle endpoint with the host IDs to include:

POST /resmgr/v1/hosts/support/bundles
Content-Type: application/json

{
  "hostIds": ["<host-id-1>", "<host-id-2>"]
}

A successful request returns HTTP 202 with a bundleId, a status of in_progress, and the number of hosts included (hostCount). A request naming more than 10 hosts returns HTTP 400 with error, hostCount, maxHostsPerBundle, and a suggestion field describing how to split the request. Duplicate host IDs in the request body are deduplicated before processing. Sending the same set of host IDs again while a matching request is still in progress returns HTTP 200 instead of starting a second bundle for that host set.

Generate a Support Bundle Directly on a Host

The console and API paths above can collect a bundle for a single host too; just select or specify that one host. Use the pcdctl generate-support-bundle command instead when the host can't currently reach the management plane, since the console and API paths depend on that connection. This command runs locally on the host and only collects data for that host. See Support bundle in the pcdctl reference for the command and its options.

Bundle Retention

Each region keeps a limited number of generated support bundles, 30 by default. Once a new bundle takes the region past that limit, the oldest bundle is removed to make room for it. A bundle that is still being generated is never removed this way.

Download a bundle you still need before it ages out. If a bundle you expected is no longer listed, generate a new one.

Related Pages

• Host: add, authorize, and manage the hosts you request bundles for
• Support bundle: generate a bundle directly on a single host using pcdctl
• Airctl Support Bundle: the equivalent bundle mechanism for your self-hosted management-plane infrastructure, not your virtualized cluster hosts