Download a Support Bundle Via the API (KBA6889)

Prerequisites

This method uses just the API to download a support bundle. The procedure is generic. Encapsulate the sequence described using the scripting language of your choice on Linux, Unix, or Microsoft Windows. The examples here all use curl because it is commonly available on all systems, including recent versions of Windows. 

To Generate and Download a Support Bundle

1. Create a session.

Request

curl -s -X POST -k --data @- https://<DELPHIX_HOSTNAME>/resources/json/delphix/session -c ~/cookies.txt -H "Content-Type: application/json" <<-EOF
{
    "type": "APISession",
    "version": {
       "type": "APIVersion",
       "major": 1,
       "minor": 5,
       "micro": 0
    }
}
EOF

Example Response

{"type":"OKResult","status":"OK","result":{"type":"APISession","version":{"type":"APIVersion","major":1,"minor":5,"micro":0},"locale":null,"client":null},"job":null,"action":null}

Note:

In this example the version 1.5.0 from the API has been specified. You can review newer API versions in our documentation.

2. Log In.

Request

curl -s -X POST -k --data @- https://<DELPHIX_HOSTNAME>/resources/json/delphix/login -b ~/cookies.txt -c ~/cookies.txt -H "Content-Type: application/json" <<-EOF
{
   "type": "LoginRequest",
   "username": "sysadmin",
   "password": "<SYSADMIN_PASSWORD>",
   "domain": "SYSTEM"
}
EOF

Example Response

{"type":"OKResult","status":"OK","result":"USER-1","job":null,"action":null}

3. Generate a support bundle.

Request

curl -s -X POST -k --data "{}" https://<DELPHIX_HOSTNAME>/resources/json/delphix/service/support/bundle/generate -b ~/cookies.txt -c ~/cookies.txt -H "Content-Type: application/json"

Example Response

 

Note:

It may take up to an hour to generate a support bundle on some systems. This may look like the command is unresponsive. However, the response should return eventually.

{"type":"DataResult","status":"OK","result":"ecb84984-a9fa-41b9-80c4-9a6a4dec6e19", "job":null,"action":"ACTION-51"}

4. Download the bundle.

Extract the value of the result field in the response to step 3. This will then be passed as part of the query string for the file download request.

Request

This will result in a file being saved to ~/support_bundle.tgz. 

curl -s -X GET -k https://<DELPHIX_HOSTNAME>/resources/json/delphix/data/download?token=ecb84984-a9fa-41b9-80c4-9a6a4dec6e19 -b ~/cookies.txt -c ~/cookies.txt -o ~/support_bundle.tgz -#

Note:

Some support bundles can be very large (>1GiB). As a result, it is normal for the last download request to take some time.

5. Troubleshooting.

During the connection to the API, avoid the use of proxy servers, or add the server URL to the bypass rules.

If you encounter a timeout during the connections, add the parameter -m <number of seconds> to increase the max time for the operation to complete:

curl -s -m 3600 -X GET -k https://<DELPHIX_HOSTNAME>/resources/json/delphix/data/download?token=ecb84984-a9fa-41b9-80c4-9a6a4dec6e19 -b ~/cookies.txt -c ~/cookies.txt -o ~/support_bundle.tgz -#

If you still have issues, add the parameter -v to enable the verbose mode and provide this information to the support team for review.

The example below provides a samle reply with the verbose parameter enabled:

curl -s -v -X POST -k --data @- https://<DELPHIX_HOSTNAME>/resources/json/delphix/session -c ~/cookies.txt -H "Content-Type: application/json" <<-EOF
{
    "type": "APISession",
    "version": {
       "type": "APIVersion",
       "major": 1,
       "minor": 11,
       "micro": 33
    }
}

* Trying 172.16.1.26:443...
* Connected to 172.16.1.26 (172.16.1.26) port 443
* ALPN: curl offers h2,http/1.1
* (304) (OUT), TLS handshake, Client hello (1):
* (304) (IN), TLS handshake, Server hello (2):
* (304) (IN), TLS handshake, Unknown (8):
* (304) (IN), TLS handshake, Certificate (11):
* (304) (IN), TLS handshake, CERT verify (15):
* (304) (IN), TLS handshake, Finished (20):
* (304) (OUT), TLS handshake, Finished (20):
* SSL connection using TLSv1.3 / AEAD-AES256-GCM-SHA384 / [blank] / UNDEF
* ALPN: server accepted http/1.1
* Server certificate:
*  subject: C=US; CN=localhost
*  start date: Oct  7 14:21:57 2022 GMT
*  expire date: Nov  9 14:21:57 2023 GMT
*  issuer: C=US; CN=Engine localhost CA
*  SSL certificate verify result: unable to get local issuer certificate (20), continuing anyway.
* using HTTP/1.x
> POST /resources/json/delphix/session HTTP/1.1
> Host: 172.16.1.26
> User-Agent: curl/8.6.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 131
> 
< HTTP/1.1 200 
< Date: Mon, 20 May 2024 16:09:17 GMT
< Content-Type: application/json
< Content-Length: 181
< Connection: keep-alive
* Added cookie JSESSIONID="FEEB4551E8D0733D426E217E9C1209" for domain 172.16.1.26, path /resources, expire 0
< Set-Cookie: JSESSIONID=FEEB4551E8D0733D426E217E9C1209; Path=/resources; Secure; Secure; HttpOnly; SameSite=Lax
< Cache-Control: max-age=0
< Expires: Mon, 20 May 2024 16:09:17 GMT
< Strict-Transport-Security: max-age=0
< X-Frame-Options: SAMEORIGIN
< Content-Security-Policy: font-src 'self' data:; default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; connect-src 'self'; img-src 'self' data:; base-uri 'self'; object-src 'self'
< Referrer-Policy: no-referrer
< Cache-Control: private
< X-Content-Type-Options: nosniff
< 
* Connection #0 to host 172.16.1.26 left intact

{"type":"OKResult","status":"OK","result":{"type":"APISession","version":{"type":"APIVersion","major":1,"minor":11,"micro":33},"locale":null,"client":null},"job":null,"action":null}