# blackduck-debuginfo

**Repository Path**: mirrors_blackducksoftware/blackduck-debuginfo

## Basic Information

- **Project Name**: blackduck-debuginfo
- **Description**: Utility script to retrieve debug information from a Black Duck instance and save to a file.  This can be useful for troubleshooting or to save the environment configuration such as environment variables for later reference.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-29
- **Last Updated**: 2025-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# blackduck-debuginfo
Utility script to retrieve debug information from a Black Duck instance and save to a file.  This can be useful for troubleshooting or to save the environment configuration such as environment variables for later reference.

Within the Black Duck user interface 'Admin' section there is a 'System Information' section with a wealth of information on the environment variables, memory, database, scan usage etc.  This utility calls these URLs and combines all of the information into a file of your choice.  This could be useful for troubleshooting or even as a record of your settings in case you need to replicate the environment for disaster recovery.

# Pre-requisites
This is a bash script and has dependencies on jq and curl being installed.

# To use
NOTE the API_TOKEN has to be from a user with sysadmin privileges.
```
./blackduck_debug.sh -u https://myblackduck -a <api_token> -f <output_file.txt>
```
Example:
```
./blackduck_debug.sh -u https://myblackduck -a <api_token> -f debug.txt
```