The malwareDetection settings provide keys that define how malware protection is configured, including malware detection processing and quarantine actions.
Select a setting from the table below to determine the edit method Trellix supports. Some of the settings listed in this table can also be changed manually for an individual host by modifying the agent configuration file.
Setting Key | Default | Supported Edit Methods | ||
|---|---|---|---|---|
Web UI | CLI | API | ||
Set by the Endpoint Security server. | No | No | No | |
Set by the Endpoint Security (HX) server. | No | No | No | |
false | Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
--- | Yes | Yes | Yes | |
See malwareDetection network_oas Section Settings for setting keys and default values. | Yes | Yes | Yes | |
See malwareDetection quarantine Section Settings for setting keys and default values. | Yes | Yes | Yes | |
false | No | No | No | |
14400 seconds (4 hours) | Yes | Yes | Yes | |
Internet | Yes | Yes | Yes | |
http://avupdate.fireeye.com/av32bit | No | No | No | |
http://avupdate.fireeye.com/av64bit | No | No | No | |
clean32_uri key
Caution
Changing the value of the clean32_uri key will impact the performance of the Trellix Endpoint Security (HX) xAgent's malware protection feature. Do not change the value of this setting without the advice of your Trellix support representative.
The clean32_uri key identifies the location of Trellix 's database of clean files, which includes Windows system files and commonly used application files, for 32-bit environments.
The Security Content package, which contains the database of clean files, is made available to the Endpoint Security (HX) server via Trellix 's Dynamic Threat Intelligence (DTI) cloud. When malware protection is enabled, the clean32_uri channel is added to the agent_configuration.json file, which allows the Windows system files and commonly used application files to be excluded from malware scanning. This improves the performance of the malware protection feature during agent installation and upgrade. It also improves the malware scanning times of common application installations.
Important
DTI must be enabled and connected to the Endpoint Security (HX) server before you download the Security Content package, which contains the database of clean files.
clean64_uri key
Caution
Changing the value of the clean64_uri key will impact the performance of the Trellix Endpoint Security (HX) xAgent's malware protection feature. Do not change the value of this setting without the advice of your Trellix support representative.
The clean64_uri key identifies the location of Trellix's database of clean files, including Windows system files and commonly used application files, for 64-bit environments.
The Security Content package, which contains the database of clean files, is made available to the Endpoint Security (HX) server via Trellix's Dynamic Threat Intelligence (DTI) cloud. When malware protection is enabled, the clean64_uri channel is added to the agent_configuration.json file, which allows the Windows system files and commonly used application files to be excluded from malware scanning. This improves the performance of the malware protection feature during agent installation and upgrade. It also improves the malware scanning times of common application installations.
Important
DTI must be enabled and connected to the Endpoint Security (HX) server in order to download the Security Content package, which contains the database of clean files.
enable Key
The enable key indicates whether malware detection, a component of malware protection, has been enabled or not. Valid values are true (enabled) or false (disabled). The default is false.
Change this setting using one of the following methods:
Web UI (see ).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
excludedFiles Key
The excludedFiles key lists the files and folders to be excluded from malware protection processing. This list of files and folders is part of the malware protection global policy.
There is no default. If no files or folders are listed, all files and folders are included in malware protection processing.
Files and folders should be listed within quotation marks (") and separated by commas. The full list of files should be enclosed in brackets ([]). For example:
"excludedFiles": [ "\\system32\\", "\\FireEye\\xagt\\events.*" ]
Exclusion Guidelines
Follow these guidelines when adding file or folder paths to the Malware Protection exclusion list:
Change this setting using one of the following methods:
Web UI (see ).
API custom configuration channels (see Using API Custom Configuration Channels.
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
excludedMD5s Key
The excludedMD5s key lists the MD5 hashes to be excluded from malware protection processing. This list of MD5 hashes is part of the malware protection agent default policy.
There is no default. If no MD5 hashes are listed, all MD5 hashes are included in malware protection processing.
MD5 hashes should be listed as a sequence of 32 hexadecimal digits, within quotation marks ("), and separated by commas. The full list of files should be enclosed in brackets ([]). For example:
"excludedMD5s": [ "c8a9dab8f7cdec707eba6deca3448ba8", "c2f5bbc927532092da5bfbb5ef839308" ]
Important
Excluding MD5 hashes from malware protection processing is not recommended because it restricts the hashes that malware protection scans.
The Endpoint Security (HX) server does not validate the correct entry of the MD5 hashes included in your exclusion list. Confirm your MD5 hash exclusions are represented by 32 hexadecimal digits.
Change this setting using one of the following methods:
Web UI (see ).
API custom configuration channels (see Using API Custom Configuration Channels.
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
excludedProcesses Key
The excludedProcesses key lists the processes that should be excluded from Malware Protection processing. This list of monitored applications is part of the malware protection global policy.
There is no default. If no processes are listed, all processes are included in Malware Protection processing.
Specify the fully qualified name of a process you want to exclude from Malware Protection processing within quotation marks ("), and separated by commas. For example:
"excludedProcesses": [ "c:\\windows\\winhlp32.exe", "c:\Program Files (x86)\Redline\Redline.exe" ]
Exclusion Guidelines
Follow these guidelines when adding files and folders, processes, and MD5 hashes to the Malware Protection exclusion list:
Change this setting using one of the following methods:
Web UI (see ).
API custom configuration channels (see Using API Custom Configuration Channels.
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
fileExtInclusions Key
The fileExtInclusions key lists the extensions of files types included in malware protection processing.
By default, all files with extensions of *.com, *.exe, *.dll, *.ocx, and *.sys are included in malware protection processing when it is turned on. These extensions are not shown in the fileExtInclusions list, but are always included in malware protection processing.
Use the fileExtInclusions list to add other file extensions to malware protection processing. There is no default. If no extensions are listed, only files with extensions of *.com, *.exe, *.dll, *.ocx, and *.sys are included in malware protection processing.
File extensions should be listed within quotation marks (") and separated by commas. The full list of file extensions should be enclosed in brackets ([]). For example:
"fileExtInclusions": [ ".log", ".py*" ]
Change this setting using one of the following methods:
API custom configuration channels (see Using API Custom Configuration Channels ).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
malwareDetection network_oas Section Settings
The malwareDetection network_oas settings provide keys that define how Trellix Endpoint Security (HX) xAgents handle on-access malware scans for files accessed over your network.
The following table lists the network_oas setting keys, defines their default values, and identifies the edit methods that are supported by Trellix for each setting. Settings listed in this table can also be changed manually for an individual host by modifying the agent configuration file.
network_oas enabled Key
The network_oas enabled key allows you to enable or disable on-access malware scans for files accessed over your network when malware detection is enabled. Valid values include true (enabled) and false (disabled). The default value is false.
Important
If the malware detection enable key is not enabled, the network_oas enabled key value is ignored.
Change this setting using one of the following methods:
Web UI (see Enabling and Disabling On-Access Network Scans).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, enclose the network_oas settings in braces ({}) within the malwareDetection settings section of the agent_config.json file. For example, you can set the enabled key to "enabled": true,.
{
"malwareDetection": {
"enable": true,
...
"network_oas": {
"enabled": true,
"mode": "read",
}
network_oas mode Key
The network_oas mode key allows you to define how malware protection processing handles on-access malware scans for network files on your host endpoints. Valid values include read, read-write, and write.The default value is read.
The table below describes each on-access malware scan mode.
Value | Description |
|---|---|
read | On-access scans occur only when a network file is read. |
read-write | On-access scans occur when a network file is read or written. |
write | On-access scans occur only when a network file is written. |
malwareDetection enable Key
Important
If the malware detection enable key and the network_oas enabled are not enabled, the network_oas mode key is ignored.
Change this setting using one of the following methods:
Web UI (see Enabling and Disabling On-Access Network Scans).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
For manual changes, enclose the network_oas settings in braces ({}) within the malwareDetection settings section of the agent_config.json file. For example, you can set the mode key to "mode": read,.
{
"malwareDetection": {
"enable": true,
...
"network_oas": {
"enabled": true,
"mode": "read",
}
malwareDetection quarantine Section Settings
The malwareDetection quarantine settings provide keys that define how remediation actions, including file quarantine and clean, are handled during malware protection processing.
Select a setting from the table below to view the edit methods FireEye supports. Settings listed in this table can also be changed manually for an individual host by modifying the agent configuration file.
Setting Key | Sub Keys | Default | Supported Edit Methods | ||
|---|---|---|---|---|---|
Web UI | CLI | API | |||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
actions section settings
The actions settings provide keys that control which remediation actions occur after an infected file is quarantined.
Select a setting from the table below to go to the edit methods Trellix supports. Some of the settings listed in this table can also be changed manually for an individual host by modifying the agent configuration file.
Setting Key | Sub Keys | Default | Supported Edit Methods | ||
|---|---|---|---|---|---|
Web UI | CLI | API | |||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
false | Yes | No | Yes | ||
clean_infection key
The clean_infection key allows you to enable or disable the removal of malware infections from files in quarantine. Valid values are true (enabled) or false (disabled). The default is false.
When you enable the clean_infection key, Trellix Endpoint Security (HX) xAgent malware protection engine removes malware infections from files after they are placed in quarantine.
If the clean_infection key value is true, you must also set the following key values to true:
Malware Detection enable Key
Quarantine enable Malware Quarantine Key
Important
If the malware detection
enablekey and the quarantineenablekey are not enabled, theclean_infectionkey value is ignored.
Change this setting using one of the following methods:
Web UI (see Cleaning Quarantined Files ).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
notify_user key
Use the notify_user key to enable or disable notification alerts on the host endpoint when files infected with malware are quarantined or cleaned. Valid values are true (enable notification alerts) or false (disable notification alerts). The default is false.
When the notify_user key is enabled, the user will receive a notification alert on their host endpoint when a file infected with malware is quarantined and when a quarantined file is cleaned.
If the notify_user key value is true, you must set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Quarantine clean_infection Key
Important
If these keys are not enabled, the
notify_userkey value is ignored.
Change this setting using one of the following methods:
Web UI (see Managing Malware Protection Notification Alerts).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
remove_trace key
Use the remove_trace key to enable and disable the removal of all trace malware artifacts from quarantined files when malware detection and quarantine are enabled. Valid values are true (enabled) or false (disabled).
When the remove_trace exclusion is enabled, the malware protection removes all trace malware artifacts from quarantined files on your the host endpoint. By default, the remove_trace key is disabled.
If the remove_trace key value is true, you must also set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Quarantine clean_infection Key
Important
If these keys are not enabled, the
remove_tracekey value is ignored.
Change this setting using one of the following methods:
Web UI (see Removing Malware Traces from Quarantined Files).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
enable malware quarantine key
The malware quarantine enable key allows you to enable and disable quarantine and remediation actions, components of malware protection, for infected files on your host endpoints. Valid values are true (quarantine and remediation enabled) or false (quarantine and remediation disabled). The default is false.
If the malware quarantine enable key value is true, the malwareDetection enable Key value must also be true, or file quarantine and remediation are ignored.
Change this setting using one of the following methods:
Web UI (see Managing File Quarantine).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
exceptions section settings
The exceptions settings provide keys that control malware protection process exclusions by allowing you to enable and disable adware, spyware, PUP, and heuristic detection exclusions.
Select a setting from the table below to go to the edit methods Trellix supports. Some of the settings listed in this table can also be changed manually for an individual host by modifying the agent configuration file.
Setting Key | Sub Keys | Default | Supported Edit Methods | ||
|---|---|---|---|---|---|
Web UI | CLI | API | |||
false | Yes | Yes | Yes | ||
false | Yes | Yes | Yes | ||
false | Yes | Yes | Yes | ||
false | Yes | Yes | Yes | ||
adware key
The adware key determines whether Trellix Endpoint Security (HX) xAgent malware protection engine excludes files with adware from the malware protection global exclusion policy. Valid values are true (enabled) or false (disabled).
When the adware exclusion is enabled, the Trellix Endpoint Security (HX) xAgent malware protection engine does not quarantine or protect the host endpoint from adware. By default, the adware key is disabled.
If the adware key value is true, you must also set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Important
If the malware detection
enablekey and the quarantineenablekey are not enabled, theadwarekey value is ignored.
Change this setting using one of the following methods:
Web UI (see Excluding Adware from Malware Protection Processing).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
heuristic_detections key
The heuristic_detections key allows you to enable and disable the heuristic detection exclusion from Trellix Endpoint Security (HX) xAgent malware protection engine's quarantine and remediation actions. Valid values are true (enabled) or false (disabled).
When the heuristic_detections exclusion is enabled, the Trellix Endpoint Security (HX) xAgent malware protection engine does not quarantine or protect the host endpoint from malware detected using heuristic detection. By default, the heuristic_detections key is disabled.
If the heuristic_detections key value is true, set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Important
If these keys are not enabled, the
heuristic_detectionskey value is ignored.
Change this setting using one of the following methods:
Web UI (see Excluding Heuristic Detections from Malware Protection Processing).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
pup key
The pup key allows you to enable and disable the potentially unwanted programs (PUP) exclusion from Trellix Endpoint Security (HX) xAgent malware protection engine's quarantine and remediation actions. Valid values are true (enabled) or false (disabled).
When pup exclusion is enabled, the Trellix Endpoint Security (HX) xAgent malware protection engine does not quarantine or protect the host endpoint from PUP. By default, the pup key is disabled.
If you set the pup key value to true, you must also set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Important
If these keys are not enabled, the
pupkey value is ignored.
Change this setting using one of the following methods:
Web UI (see Excluding Potentially Unwanted Programs (PUP) from Malware Protection Processing).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
spyware Key
The spyware key allows you to enable and disable the spyware exclusion from Trellix Endpoint Security (HX) xAgent malware protection engine's quarantine and remediation actions. Valid values are true (enabled) or false (disabled).
When the spyware exclusion is enabled, the Trellix Endpoint Security (HX) xAgent malware protection engine does not quarantine or protect the host endpoint from spyware. By default, the spyware key is disabled.
If you set the spyware key value to true, you must also set the following key values to true:
malware Detection enable Key
Quarantine enable Malware Quarantine Key
Important
If these keys are not enabled, the
spywarekey value is ignored.
Change this setting using one of the following methods:
Web UI (see Excluding Spyware from Malware Protection Processing ).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
update_enabled Key
Caution
Do not change the value of this setting without the advice of your Trellix support representative.
The update_enabled key is used internally by malware protection processing. Do not change its value.
update_interval Key
The update_interval key specifies the interval, in seconds, at which malware definition updates should be retrieved from the Trellix servers. Valid values range from 60 seconds to 86400 seconds (one day). The default is 14400 seconds (four hours).
Change this setting using one of the following methods:
Web UI (see ).
API custom configuration channels (see Using API Custom Configuration Channels.
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
update_source Key
The update_source key specifies the malware protection indicator download channel used to download the latest malware protection indicators to the Trellix Endpoint Security (HX) xAgents on your host endpoints. Valid values include internet, hx-preferred, andhx-only.
The table below lists the available channel options. The Internet is the default source.
Indicator Source | Description |
|---|---|
Internet | Malware protection indicator updates are downloaded directly from the Internet. |
HX-Preferred | Malware protection indicator updates are downloaded from the Endpoint Security (HX) server. If the Endpoint Security server is unavailable, malware protection indicator updates are downloaded from the Internet. |
HX-Only | Malware protection indicator updates are downloaded from the Endpoint Security (HX) server only. |
NoteWhen you first enable malware protection, the latest malware indicators are downloaded to your agents. By default, this initial download of these indicators can take up to four hours to complete. Malware protection will not start until the indicators have been downloaded. To verify that the data has downloaded successfully, review the Host Details tab in the Web UI for a Windows host and verify the values in the Content Version and Last Updated fields under Malware Protection on the tab. For more information, see the Endpoint Security (HX) Server User Guide . | |
Change this setting using one of the following methods:
Web UI (see Configuring the Malware Protection Indicator Download Channel ).
API custom configuration channels (see Using API Custom Configuration Channels).
Manually on individual endpoints using a text editor (see Modifying the Configuration File for a Single Endpoint).
update_url32 Key
Caution
Do not change the value of this setting without the advice of your Trellix support representative.
The update_url32 key identifies the location of Trellix's malware definitions in 32-bit environments.
update_url64 Key
Caution
Do not change the value of this setting without the advice of your Trellix support representative.
The update_url64 key identifies the location of Trellix 's malware definitions in 64-bit environments.