The command line interface supports several commands, some of them requiring parameters to return valid results.

All examples in this section are given using the Product Console from the BEST installation folder.

GetUpdateStatus product|antivirus

Retrieve information about the last update(s).

This command requires one of these parameters:

Example:

GetVersion product|antivirus

Retrieve information about the product's current version.

This command requires one of these parameters:

Example:

IsUpdateInProgress

Verify if a product update is in progress.

Output values:

Example:

IsUpdateRestartNeeded

Verify if a machine requires a system restart after the update.

Output values:

Example:

StartUpdate

Start an update and retrieve the result without waiting for the task to finish.

Example:

StartUpdate

Output format: error 0 (the command has been executed successfully)

StartUpdate -force

Override the product update settings and start a forced update process. The command returns an error code.

FileScan.OnDemand.RunScanTask custom [option]

Starts an on-demand scan and displays the path to the scan log and the summary of the scan.

This command requires the parameter custom, followed, if needed, by one or more options. For example:

With options, you can customize a scanning task. These options are not mandatory.

Each option has two or more available values, but you can use only one value.

When the FileScan.OnDemand.RunScanTask command does not specify any option, the custom scan takes into account the default value of that option. For example, if you run this command without mentioning the scanKeyloggers option, that means Bitdefender Endpoint Security Tools will still scan for keyloggers, according to the scanKeyloggers default value (true).

Options

path="<path>"

Enter the path of the scan target location. For multiple paths use: path="<path1>" path="<path2>".

Example:

FileScan.OnDemand.RunScanTask custom path="C:\Program Files"

infectedAction1=ignore|disinfect|disinfectOnly|delete|quarantine

Select the first action taken when an infected file is detected: ignore, disinfect, delete or move it to quarantine. You can use this action together with infectedAction2.

Default value: disinfect

Example:

infectedAction2=ignore|disinfect|disinfectOnly|delete|quarantine

Select the second action taken when an infected file is detected if the first action fails.

Default value: quarantine

Example:

suspiciousAction1=ignore|delete|quarantine

Select the first action to take when a suspicious file is detected. You can use this action together with suspiciousAction2.

Default value: ignore

Example:

suspiciousAction2=ignore|delete|quarantine

Select the second action taken when a suspicious file is detected if the first action fails.

Default value: ignore

Example:

scanBootSectors=true|false

Scan the boot sectors of your hard disk.

Default value: false

Example:

scanRegistry=true|false

Scan the registry keys on your machine.

Default value: false

Example:

scanMemory=true|false

Scan the programs running in your system’s memory.

Default value: false

Example:

smartScan=true|false

Scan only new and changed files.

Default value: true

Example:

scanRootKits=true|false

Scan for rootkits and hidden objects using such software.

Default value: false

Example:

scanKeyloggers=true|false

Scan for keylogger software.

Default value: true

Example:

scanPUA=true|false

Scan Potentially Unwanted Applications (PUA).

Default value: false

Example:

scanArchives=true|false

Scan for infected files inside archives.

Default value: true

Example:

extensionType=all|application|custom|none

Scan files depending on their extension: all files, only executable files, only files with the extensions you want, or do not scan any file.

Default value: all

Example:

customExt="<string>"

This option helps you scan only the files with the extensions you want. It requires a string with each extension between vertical bars (such as "|exe|ini|txt|"). This option is valid only together with the option extensionType=custom.

Example:

lowPriority=true|false

Run the task with low priority.

Default value: false

Example:

These options are an alternative to the options available in BEST console. For more information refer to Configuring and Running a Custom Scan.

The command line utility may return the following error codes: