Page Comparison

apiKey 

(Mandatory) A unique identifier of your organization. Used to identify the organization in plugins. 

N/A

N/A

No default

-apiKey

userKey 

Unique identifier of the user that can be generated from the Profile page in your WhiteSource account.

NOTE: Required only if Enforce user level access is selected in the Integrate page.

N/A

N/A

No default

-userKey

requesterEmail 

The provided email will be matched with an existing WhiteSource account. Requests for new libraries will be created with the matched account as the requester email.

user@provider.com

N/A

N/A

No default

No

projectName 

The name of the project to update (mandatory).

NOTE: If not defined, then projectToken must be defined instead.

N/A

N/A

No default

-project

projectVersion 

The project's version.

NOTE: Added to the name if Use version in project names is selected in the Integrate page.

N/A

N/A

No default

-projectVersion

projectToken 

Unique identifier of the project to update; found on the Integrate page.

NOTE: If not defined, then projectName must be defined instead.

N/A

N/A

No default

-projectToken

projectTag 

Enables setting of project tag only for a newly-created project. Project tag should be defined with key:value

For example: projectTag= myTagKey:myTagValue

NOTE: This parameter is not supported when using the Repo Integrations or the Azure DevOps Services Integration.

N/A

N/A

No default

-projectTag

productName 

Name of the product to update

N/A

N/A

MyProduct

-product

productVersion 

Version of the product and project to update. It overrides the project version.

N/A

N/A

No default

-productVersion

productToken 

Unique identifier of the product to update; found on the Integrate page.

N/A

N/A

No default

-productToken

projectPerFolder

Creates one project per subfolder according to your "-d" parameter. Each subfolder is named according to the folder.

A project per folder is created

A project per folder is not created

False

-projectPerFolder

projectPerFolderIncludes 

Comma or space-delimited list of folder names to be included in the scan.

NOTE: Relevant only if projectPerFolder is True.

N/A

N/A

All folders

No

projectPerFolderExcludes 

Comma or space-delimited list of folder names to be excluded from the scan.

NOTE: Relevant only if projectPerFolder is True.

N/A

N/A

The default value is ""

No

wss.connectionTimeoutMinutes 

Connection timeout in minutes.

N/A

N/A

60

wss.url=https://saas.whitesourcesoftware.com/agent

#wss.url=https://app.whitesourcesoftware.com/agent

#wss.url=https://app-eu.whitesourcesoftware.com/agent 

Enable the relevant URL according to your organization's WS Server URL from your Profile page on the Server URLs panel (additionally, it can be found in the Integrate tab). Then, add the agent path.

N/A

N/A

https://saas.whitesourcesoftware.com/agent

-wss.url

offline 

Whether to create an offline update request instead of sending one to WhiteSource.

An offline request file is created in the whitesource folder next to the scanned project.

Results are sent directly to the server.

False

-offline

offline.zip

Whether to create a zipped offline update request instead of sending one to WhiteSource.

A zipped offline request file is created in the whitesource folder next to the scanned project.

The offline request will not be zipped.

False

No

updateType 

If scanning a previously-scanned project, whether to append or override the results.

• APPEND - Add the scanned libraries to the project’s inventory. If only a transitive dependency has been added, it will be added as a direct dependency, so all of the application's mechanisms such as alerts and policies will be applied on it. Use this value only in case of working with multiple build processes that are managed under the same WhiteSource project.

• OVERRIDE- Adds the newly-added dependencies (the difference)

N/A

N/A

OVERRIDE

-updateType

ignoreSourceFiles  

Whether to only include package dependencies for all package managers/dependency resolvers. 

IMPORTANT: As of version 2122.25.21, this parameter is being will be deprecated and will be replaced by a new parameter , fileSystemScan.

Overrides the individual x.ignoreSourceFiles parameter value of each of the package managers and ignores all source files discovered during the dependency resolution.

NOTE: When ignoreSourceFiles is used, then the includes/excludes parameter will be ignored.

No override action will occur, and each of the package manager's x.ignoreSourceFiles parameter default values will apply (unless explicitly stated).

False

No

fileSystemScan

Performs a file system scan for source files and binaries, in addition to the package manager based dependencies resolution. The files to be scanned can be controlled by the includes and excludes parameters and the resolver-specific ignoreSourceFiles parameters.

IMPORTANT: This parameter is new for version 21.2.2, and overrides the soon-to-be-deprecated ignoreSourceFiles.

Performs a file system scan for source files and binaries, in addition to the package manager based dependencies resolution. 

Only package manager based dependencies resolution is being performed. 

True

No

scanComment 

Adds a comment to a scan. The comment is then displayed in the Project Vitals panel of the Project pages, and the Plugin Request History Report. Supports UTF-8 characters.

A comment is added to the scan.

No comments will be added to the scan.

No default

-scanComment

failErrorLevel 

When set to ALL - the Unified Agent will exit on any major error (such as resolution failed, pre-steps error, etc.)

Otherwise, there is no change in behavior.

Possible values - ALL or DEFAULT (upper-case only)

N/A

N/A

"DEFAULT"

No

requireKnownSha1 

Checks for dependencies with known/unknown SHA-1. 

The Unified Agent will terminate the scan if one or more dependencies with an unknown SHA-1 were found.

The scan will continue normally.

True

-requireKnownSha1

generateProjectDetailsJson 

Whether to generate a JSON file upon scan completion containing the projectTokens and projectNames.

The Unified Agent generates a JSON file at the end of the scan named scanProjectDetails.json containing the projectTokens and projectNames.

The JSON file report will not be generated.

False

No

generateScanReport 

(For Organization and Product Administrators only) Whether to create a report in JSON format at the end of the scan, which includes information on vulnerabilities, policy violations, top fixes, and inventory details.

The filename format is '<project_name>-<yyyy-mm-dd>T<HHmmss>+<UTC offset>-scan_report.json'. 
For example: 'Demo App-2019-06-04T181226+0300-scan_report.json'

NOTES:

• The userKey configuration parameter is mandatory for this report.

• To generate this report, the configuration parameter updateInventory must be set to True.

• This parameter does not work in offline mode.

A report in JSON format is created at the end of the scan, which includes information on vulnerabilities, policy violations, top fixes, and inventory details.

The report will not be generated.

False

-generateScanReport

scanReportTimeoutMinutes 

Time-out (in minutes) for the process of generating the scan report. If the timeout interval has passed then the report will not be generated, but the scan will continue.

N/A

N/A

10

No

scanReportFilenameFormat 

Controls the filename format of a generated scan report.
Valid values are: 

• project_with_timestamp (default) - the format will be: <project_name>-<yyyy-mm-dd>T<HHmmss>+<UTC offset>-scan_report.json

• project_only - the format will be: <project_name>-scan_report.json

• static - the format will be scan_report.json

N/A

N/A

Default value is "project_with_timestamp"

No

commandTimeout

Time-out (in seconds) for the running of commands.

N/A

N/A

900

-commandTimeout

updateEmptyProject 

Whether to create an empty project in WhiteSource or to update an existing project with empty data.

NOTE: This parameter affects all resolvers/package managers.

Updates/creates a project even if there are no dependencies.

Will not create/ update the empty project.

True

No

log.files.level 

For storing logs by default, this determines the log's level: 

• Trace

• Debug (default)

• Info

• Warn

• Error

• Off - Deactivates the feature.

NOTES:

• The location of the logs is determined by the log.files.path parameter.

• In the Unified Agent, each successive scan of the same library generates its own folder. The structure is: 

wss-scan-<date>-<time>

N/A

N/A

Debug

-log.files.level 

log.files.maxFileSize 

For storing logs by default, this is the maximum size in MB. If exceeding this size, the file will be overridden. 

NOTE: This reflects one run (cycle) of the Unified Agent. The files accumulate after each run.

N/A

N/A

10 MB

No

log.files.maxFilesCount 

For storing logs by default, this is the maximal count of log files. If exceeding this size, the oldest files will be overridden with new files. 

NOTE: This reflects one run (cycle) of the Unified Agent. The files accumulate after each run.

N/A

N/A

3

No

log.files.path 

Location of the created log file.

NOTE:  In Windows, do not put "\ " at the end of the value.

N/A

N/A

The default location of the logs is in the 'whitesource' folder (determined by the whiteSourceFolderPath parameter)

No

sendLogsToWss

Whether to send logs to WhiteSource.

Sends logs to WhiteSource.

Will not send logs to WhiteSource.

False

No

case.sensitive.glob

Whether the file system should be case sensitive.

The file system will be case sensitive.

The file system will not be case sensitive.

False

No

showProgressBar

Whether to display a progress bar inside logs.

NOTE: This parameter is valid for the Unified Agent only (not Prioritize).

Progress bars will be displayed inside logs.

Progress bars will not be displayed inside logs.

True

No

-c

String

Configuration file name (including file path).

No

The default file name is 'wss-unified-agent.config'

• Starting from version 19.1.1, the default file is 'wss-unified-agent.config'. 
  If this file is not found, then the Unified Agent searches for a 'whitesource-fs-agent.config' file.

• When using the -detect flag, the generated configuration file is wss-generated-file.config and it should be explicitly stated: 
  -c wss-generated-file.config

-d

String

Comma-separated list of directories and/or files to scan

No

N/A

-f

String

File list path

No

N/A

-v

String

Query the Unified Agent for its version

No

N/A

-archiveFastUnpack 

Boolean

Fast unpacking of archive files

No

False

-requestFiles

String

Comma-separated list of paths to offline request files. 

Regarding the priority of the parameters usage, the Unified Agent searches for the CLI argument, then the configuration file parameter (if not found in the CLI), and then the offline request parameter (if not found in the configuration file).
If multiple request files are provided, then the data from the first offline request is used. Note that the 'projectName', 'projectToken', and 'projectVersion' are fetched from each request file.

If '-d' is explicitly provided when '-requestFiles' is also used, then the Unified Agent does not scan the local folder (which '-d' points to). Instead, it scans only the offline request file(s) provided. '-d' will be ignored in this scenario.

No

When a single request file is provided and if neither 'productName' or 'productToken' values are set in the CLI, Config and Offline request file, then the default product name is 'My Product'.

-whiteSourceFolderPath 

String

A path to the 'whiteSource' directory. The WhiteSource folder is created when checking policies and creating an offline file. Path can be absolute or relative. 

No

The default location of the 'whitesource' folder is the working directory from which the Unified Agent is run.

-requirementsFileIncludes 

(there is only python)

String

Comma-separated list of dependency filenames specifying which files to be scanned for dependencies.

No

requirements.txt

-noConfig

Boolean

When set to True, you can run a scan without using a configuration file. However, in this case, parameters  -projectToken or -project 
and -apiKey are mandatory.

Unless explicitly provided, the default wss.url parameter value is https://saas.whitesourcesoftware.com/agent

No

False

-detect

When this parameter is added, the Unified Agent will analyze the scanned files and will create a new .config file with the relevant configuration parameters. The new configuration file will contain the resolveDependencies parameters according to the discovered package managers. For each manifest file, we will set the relevant parameter to True.

Usage:  java -jar unified-agent.jar -detect 

For example, if a bower.json file is found in the project folder, bower.resolveDependencies will be set to True in the newly created configuration file.

No

By default, the detection is based on the current directory where the Unified Agent jar is located. To change this, add the -d parameter.

For example use:  java -jar unified-agent.jar -detect -d projectFolder

-help or -h

Boolean

The Unified Agent prints the parameters that can be used from the CLI. 

No

-logLevel

String

Specifies the minimal log level printed to stdout. This parameter can be used to control console logging and is useful if a customer is trying to pull logs from a pipeline scan.

To disable console logging set log.level=off

To enable debug logging set log.level=debug

No

info

-proxy

String

Proxy info in the following format:
scheme://<user>:<password>@host:port/

No