Configure and Download the Diagnostics Report File

Learn about configuring and downloading the diagnostics report file.

This section contains information about enabling, configuring, and modifying the way diagnostic reports are generated using CLI.

Note: You need root user privileges to perform these tasks.

The diagnostic report is not enabled by default. You must enable the feature to capture the diagnostic report. Once enabled, you must configure the information that is to be captured in the diagnostic report. You can customize and package the diagnostics report with flexibility.

Log in to the appliance through SSH and switch to the root user.

See Logging In to Oracle DBSecCentral Appliances Through SSH.
Run the following command on the appliance:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb --install
```
If diagnostics are not enabled, running the utility generates a diagnostics-not-enabled.readme file explaining how to enable diagnostics.
After the package has been installed, the diagnostics configuration must be modified to allow the utility to collect information about the appliance. Collection of all elements and files can be enabled with:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb --enable ALL
```
Alternatively, the collection of the SOS report can be enabled with:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb --enable SOS_REPORT
```
Optionally, further options are available by viewing the utility help:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb --help
```
Run the following command to capture the enabled diagnostic information for the appliance:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb
```
When you run the diagnostics collection command, deployment information will be collected by default. See the table below to learn what deployment information is collected.

The location of the saved zip file is displayed at the end of the command execution.
When you have collected the diagnostics, remove the package with the following command:
```
/usr/local/dbfw/bin/priv/dbfw-diagnostics-package.rb --remove
```

Table 1 Deployment Information Collected By the Diagnostics Log When Run With the ALL Option on the Audit Vault Server (AVS)

Deployment Information	Details
Number of targets and type of targets	Number of each type of target
Audit trail type	Number of each type of audit trail
Number of Database Firewall (DBFW) servers	Number of DBFW servers (individual servers)
High Availability (HA) Configuration - AVS	Yes or No
High Availability (HA) Configuration - DBFW	Yes or No If yes, the number of primary/secondary firewall servers
DBFW deployment model	Count of each type of deployment if present Monitoring/Blocking (Proxy) Monitoring (Host Monitor) Monitoring (Out-Of-Band)
List of audit policies enabled	Are unified auditing policies provisioned? Yes or No
	Are traditional auditing policies provisioned? Yes or No
	The number of predefined policies that are enabled
	The number of custom policies
DBFW policies and rules deployed	The number of policies with Database Object rule
	The number of policies with Session Context rule
	The number of policies with Default rule
	The number of policies with SQL Statement rule
Entitlement report	Is it scheduled? Yes or No
Sensitive Object job	Is it scheduled? Yes or No
Security Assessment	Is it scheduled? Yes or No
Number of Alert policies	Number of alerts enabled
Email notification	Is it enabled for alert policies? Yes or No
Email notification	Is it enabled for system alerts? Yes or No
Sensitive object upload	Have you uploaded a file? Yes or No
Number of generated reports	Number of reports per category generated
Number of scheduled reports	Number of reports per category Scheduled
STIG	Is it enabled? Yes or No
TLS	Is it enabled? Yes or No
FIPS	Is it enabled? Yes or No
Stored procedure auditing	Is it scheduled? Yes or No
Number of events per second	Number of events per second
Use of network-based storage	Is it being used? Yes or No
Archive policy	The archive policies being used for targets: number of months online and offline.
Backup frequency	Backup frequency
Hardware configuration (core/RAM) of AVS and DBFW server	Hardware configuration (core/RAM) of AVS
	Total memory space (KB)
	Total disk space (Bytes)
	CPU utilization percent

Related Topics

Viewing the Status and Diagnostics Report for Database Firewall