With the custom on-demand scan command line interface, you can run a previously defined custom on‑demand scan with new settings, without changing the settings of the original custom scan.
Threat Prevention creates a clone of the original custom on-demand scan, applies your changes to the settings, and logs the changes. The new cloned custom scan is named as <name>_cloned. The <name> refers to original custom on-demand scan. Once the scan is completed, the clone is available for 15–20 minutes. The original scan settings remain unchanged.
Note
You can't change the Quick Scan or Full Scan with the command line interface.
Prerequisites
The Threat Prevention service (
mfetp.exe) must already be running foramcfg.exeto run.The interface mode for the Trellix Endpoint Security (ENS) Client must be set to Full access if a user wants to stop, pause or resume an on-demand scan through command line.
All users can start a scan and check the status of a scan, regardless of the interface mode for the Trellix Endpoint Security (ENS) Client.
Syntax: Custom on-demand scan command line interface
The custom on-demand scan syntax for amcfg.exe is:
installation_path\amcfg.exe /scan [ /list | /task /scan_ID[command_args] [ /action start ] ]
installation_path — C:\Program Files\McAfee\Endpoint Security\Threat Prevention by default
command_args— One of the commands in the Custom on‑demand scan command arguments table
Arguments can appear in any order, except that you must keep each argument with its value.
The scan is executed only if all values are correct. Otherwise, amcfg.exe displays a message with the possible values and doesn't run the scan. If the command line includes multiple values for an argument, the scan runs using only the first value. The scanner ignores any invalid configuration arguments.
While cloning a custom scan, you can add new /targets with already defined custom scan task. The new cloned custom scan, <name>_cloned, not only scans the new /targets but also the paths mentioned in the original custom scan.
When changing a custom scan, the only valid /action argument is start. But, when a cloned scan task is running, you can apply all actions (start, pause, resume, cancel, status) to it as long as the interface mode is set to Full access.
Argument | Value | Description |
|---|---|---|
| Displays the list of currently defined custom on-demand scan tasks, including temporary cloned scan tasks. | |
|
| Specifies the ID of the custom on-demand scan to change and run. If the scan ID includes spaces, you must enclose it in double-quote characters (").
|
| file path | Specifies a single complete file path to scan. |
|
| Examines all subfolders of the specified folder. |
|
| Enables the scanner to use the existing clean scan results.
If you enable logging of files scanned during an on-demand scan, the scanner doesn't log files in the clean scan cache. |
|
| Configures the Trellix GTI sensitivity level to use when determining if a detected sample is malware. When enabled, fingerprints of samples, or hashes, are submitted to Trellix Advanced Research Center to determine if they are malware. By submitting hashes, detection might be made available sooner than the next AMCore content file release, when Trellix Advanced Research Center publishes the update. The higher the sensitivity level, the higher the number of malware detections. But, allowing more detections might result in more false positive results. Trellix GTI sensitivity levels are:
|
|
| Enables the operating system to specify the amount of CPU time that the scanner receives during the scan. Each task runs independently, unaware of the limits for other tasks.
|
|
| Specifies how the scanner responds when it detects a threat:
Remember:
|
| ||
| ||
| ||
|
| Detects, decodes, and scans Multipurpose Internet Mail Extensions (MIME) encoded files. |
|
| Examines the contents of archive (compressed) files, including .jar files.
|
|
| Enables the scanner to detect potentially unwanted programs. The scanner uses the information you configured in the Threat Prevention Options settings to detect potentially unwanted programs. |
|
| Enables the scanner to detect unknown macro threats. |
|
| Uses Trellix GTI to detect executable files that have code resembling malware. |
|
| Specifies file types to scan.
|
Examples: Custom on-demand scan command line interface
Open a command prompt and change to the installation location of amcfg.exe to run these example commands. By default, amcfg.exe is located in the C:\Program Files\McAfee\Endpoint Security\Threat Prevention folder.
To... | Run this command |
|---|---|
Get help on the command line interface. |
|
List the currently defined custom on-demand scans. |
|
Start a custom scan with the specified ID. |
|
| |
Change a custom scan to scan a particular folder. |
|
Specify these settings and run the custom scan:
|
|
Scan only files with .exe extensions in the user Elmo's Downloads folder. |
|
Get status of a cloned scan task. |
|