Required Parameters

Name	Type	Since	Description
autoUpdate	boolean	-	Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. Default is true. Default value is: true. User property is: autoupdate.
externalReport	boolean	-	Sets whether or not the external report format should be used. Default value is: false. User property is: externalReport.
failBuildOnCVSS	float	-	Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11 which means since the CVSS scores are 0-10, by default the build will never fail. Default value is: 11. User property is: failBuildOnCVSS.
format	String	-	The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. Default is HTML. Default value is: HTML. User property is: format.
outputDirectory	File	-	The output directory. Default value is: ${project.build.directory}.
reportOutputDirectory	File	-	Specifies the destination directory for the generated Dependency-Check report. Default value is: ${project.reporting.outputDirectory}. User property is: reportOutputDirectory.

Optional Parameters

Name	Type	Since	Description
connectionString	String	-	The database connection string. User property is: nexusUrl.
connectionTimeout	String	-	The Connection Timeout. User property is: connectionTimeout.
databaseDriverName	String	-	The database driver name. An example would be org.h2.Driver. User property is: databaseDriverName.
databaseDriverPath	String	-	The path to the database driver if it is not on the class path. User property is: databaseDriverPath.
databasePassword	String	-	The password to use when connecting to the database. User property is: databasePassword.
databaseUser	String	-	The database user name. User property is: databaseUser.
description	String	-	The description of the Dependency-Check report to be displayed in the Maven Generated Reports page Default value is: A report providing details on any published vulnerabilities within project dependencies. This report is a best effort but may contain false positives and false negatives.. User property is: description.
logFile	String	-	The path to the verbose log User property is: logfile.
name	String	-	The name of the report to be displayed in the Maven Generated Reports page Default value is: Dependency-Check. User property is: name.
nexusAnalyzerEnabled	boolean	-	Whether or not the Nexus Analyzer is enabled. Default value is: true. User property is: nexusAnalyzerEnabled.
nexusUrl	String	-	Whether or not the Nexus Analyzer is enabled. User property is: nexusUrl.
proxyPassword	String	-	The Proxy password. User property is: proxyPassword.
proxyPort	String	-	The Proxy Port. User property is: proxyPort.
proxyUrl	String	-	The Proxy URL. User property is: proxyUrl.
proxyUsername	String	-	The Proxy username. User property is: proxyUsername.
reportName	String	-	The name of the site report destination. Default value is: dependency-check-report. User property is: report-name.
showSummary	boolean	-	Flag indicating whether or not to show a summary in the output. Default value is: true. User property is: showSummary.
suppressionFile	String	-	The Connection Timeout. User property is: suppressionFile.

Parameter Details

autoUpdate:

• Type: boolean
• Required: Yes
• User Property: autoupdate
• Default: true

---

connectionString:

• Type: java.lang.String
• Required: No
• User Property: nexusUrl

---

connectionTimeout:

• Type: java.lang.String
• Required: No
• User Property: connectionTimeout

---

databaseDriverName:

• Type: java.lang.String
• Required: No
• User Property: databaseDriverName

---

databaseDriverPath:

• Type: java.lang.String
• Required: No
• User Property: databaseDriverPath

---

databasePassword:

• Type: java.lang.String
• Required: No
• User Property: databasePassword

---

databaseUser:

• Type: java.lang.String
• Required: No
• User Property: databaseUser

---

description:

• Type: java.lang.String
• Required: No
• User Property: description
• Default: A report providing details on any published vulnerabilities within project dependencies. This report is a best effort but may contain false positives and false negatives.

---

externalReport:

• Type: boolean
• Required: Yes
• User Property: externalReport
• Default: false

---

failBuildOnCVSS:

• Type: float
• Required: Yes
• User Property: failBuildOnCVSS
• Default: 11

---

format:

• Type: java.lang.String
• Required: Yes
• User Property: format
• Default: HTML

---

logFile:

• Type: java.lang.String
• Required: No
• User Property: logfile

---

name:

• Type: java.lang.String
• Required: No
• User Property: name
• Default: Dependency-Check

---

nexusAnalyzerEnabled:

• Type: boolean
• Required: No
• User Property: nexusAnalyzerEnabled
• Default: true

---

nexusUrl:

• Type: java.lang.String
• Required: No
• User Property: nexusUrl

---

outputDirectory:

• Type: java.io.File
• Required: Yes
• Default: ${project.build.directory}

---

proxyPassword:

• Type: java.lang.String
• Required: No
• User Property: proxyPassword

---

proxyPort:

• Type: java.lang.String
• Required: No
• User Property: proxyPort

---

proxyUrl:

• Type: java.lang.String
• Required: No
• User Property: proxyUrl

---

proxyUsername:

• Type: java.lang.String
• Required: No
• User Property: proxyUsername

---

reportName:

• Type: java.lang.String
• Required: No
• User Property: report-name
• Default: dependency-check-report

---

reportOutputDirectory:

• Type: java.io.File
• Required: Yes
• User Property: reportOutputDirectory
• Default: ${project.reporting.outputDirectory}

---

showSummary:

• Type: boolean
• Required: No
• User Property: showSummary
• Default: true

---

suppressionFile:

• Type: java.lang.String
• Required: No
• User Property: suppressionFile