Traps Administrator's Guide

4.0

paloaltonetworks.com/documentation
Table of Contents
Traps Overview....................................................................................................9
About Traps................................................................................................................................................11
Malware Protection Overview..................................................................................................11
Exploit Protection Overview..................................................................................................... 12
Traps Components....................................................................................................................................13
ESM Console................................................................................................................................. 13
ESM Server.................................................................................................................................... 13
Database......................................................................................................................................... 14
Endpoints........................................................................................................................................14
Traps Agent....................................................................................................................................14
External Logging Platform..........................................................................................................15
WildFire...........................................................................................................................................15
Forensic Folder............................................................................................................................. 16

Traps Deployment Scenarios......................................................................... 19

Standalone Deployment.......................................................................................................................... 21
Small Deployments................................................................................................................................... 22
Small Single-Site Deployment................................................................................................... 22
Small Multi-Site Deployment.................................................................................................... 23
Large Deployments...................................................................................................................................24
Large Single-Site Deployment...................................................................................................24
Large Multi-Site Deployment with One Endpoint Security Manager..............................25
Large Multi-Site Deployment with Roaming Agents (Without VPN)...............................26
Large Multi-Site Deployment with Roaming Agents (With VPN).....................................27

Prerequisites.......................................................................................................29
Hardware Requirements..........................................................................................................................31
Standalone Endpoint Security Manager Hardware Requirements................................... 31
Distributed Endpoint Security Manager Hardware Requirements...................................31
Traps Hardware Requirements................................................................................................. 33
Software Requirements........................................................................................................................... 35
ESM Console Software Requirements.................................................................................... 35
ESM Server Software Requirements....................................................................................... 35
Database Software Requirements............................................................................................36
Traps Software Requirements...................................................................................................37

Set Up the Traps Infrastructure.................................................................... 39

Set Up the Endpoint Infrastructure......................................................................................................41
Activate Traps Licenses...........................................................................................................................42
Set Up the Endpoint Security Manager.............................................................................................. 43
Endpoint Infrastructure Installation Considerations............................................................ 43
TLS/SSL Encryption for Traps Components..........................................................................43
Configure the MS-SQL Server Database............................................................................... 45
Install the Endpoint Security Manager Server Software.................................................... 46
Install the Endpoint Security Manager Console Software..................................................49
Set Up the Endpoints...............................................................................................................................53
Recommended Traps Deployment Process........................................................................... 53

TABLE OF CONTENTS iii

 Traps Installation Options.......................................................................................................... 54
Install Traps on Windows Endpoints.......................................................................................54
Install Traps on Mac Endpoints................................................................................................ 55
Install Traps Components Using Windows Msiexec........................................................................ 58
Install Traps Components...........................................................................................................58
Uninstall Traps Components..................................................................................................... 59
Verify a Successful Installation..............................................................................................................60
Verify Connectivity from the Endpoint.................................................................................. 60
Verify Connectivity from the ESM Console.......................................................................... 60

VDI........................................................................................................................63
VDI Overview............................................................................................................................................ 65
Virtualized Applications and Desktops................................................................................... 65
VDI Modes..................................................................................................................................... 65
VDI Installation Considerations............................................................................................................. 67
Set Up Traps in a VDI Environment Overview................................................................................. 68
Set Up the Golden Image....................................................................................................................... 70
Prerequisites for Configuring the Golden Image..................................................................70
Configure the Golden Image..................................................................................................... 71
Traps VDI Tool CLI...................................................................................................................... 73
Configure Traps VDI Settings................................................................................................................ 76
Configure Traps for a Non-Persistent Storage Scenario.................................................... 76
Configure Traps for a Persistent Storage Scenario..............................................................76
Tune and Test the VDI Policy............................................................................................................... 79

Administer the ESM Server............................................................................81

Manage ESM Server Settings................................................................................................................ 83
Manage ESM Console Settings............................................................................................................. 85
Manage Multiple ESM Servers.............................................................................................................. 86
Known Limitations with Multi-ESM Deployments...............................................................86
What Logic Does the Agent Use When Selecting an ESM Server?................................. 86
Activate, Disable, or Delete an ESM Server..........................................................................87
Traps Licenses............................................................................................................................................89
Add a Traps License Using the ESM Console....................................................................... 89
Add a Traps License Using the DB Configuration Tool...................................................... 90
Manage Administrator Access to the ESM Console........................................................................ 91
Administrative Roles....................................................................................................................91
Administrative Privileges............................................................................................................ 92
Administrative Users................................................................................................................... 94
Administrative Authentication.................................................................................................. 95
Configure Administrative Accounts and Authentication.................................................... 95
Export and Import Policy Files............................................................................................................100
User-Defined Rules................................................................................................................... 100
Content Updates........................................................................................................................101

Monitoring........................................................................................................103
Maintain the Endpoints and Traps.....................................................................................................105
Use the Endpoint Security Manager Dashboard............................................................................ 106
Monitor Security Events....................................................................................................................... 107
Use the Security Events Dashboard..................................................................................... 107
View the Security Event History on an Endpoint..............................................................109
Monitor the Endpoints.......................................................................................................................... 111

iv TABLE OF CONTENTS
 View Endpoint Health Details................................................................................................ 111
View Notifications About Changes in the Agent Status.................................................. 111
View the Status of the Agent from the Traps Console.................................................... 112
View the Rule History of an Endpoint................................................................................. 113
View Changes to the Security Policy from the Traps Console....................................... 113
View the Service Status History of an Endpoint............................................................... 114
Remove an Endpoint from the ESM Console..................................................................... 114
Monitor the ESM Servers.....................................................................................................................116
View the Health of the ESM Servers................................................................................... 116
View Notifications About the ESM Server..........................................................................116
View the Rule Summary....................................................................................................................... 117
Monitor Forensics Retrieval.................................................................................................................118

Getting Started with Rules...........................................................................119

Endpoint Policy Rule Concepts...........................................................................................................121
Policy Rule Types.......................................................................................................................121
Policy Enforcement................................................................................................................... 122
Default Protection Policy.........................................................................................................122
Common Rule Components and Actions..........................................................................................125
Conditions.................................................................................................................................... 125
Target Objects............................................................................................................................ 128
Name or Rename a Rule.......................................................................................................... 129
Save Rules....................................................................................................................................129
Manage Saved Rules................................................................................................................. 129
Filter Rules...................................................................................................................................130
Disable or Enable All Protection Rules.................................................................................131
Show or Hide the Default Policy Rules................................................................................132
Wildcards and Variables in Policy Rules...........................................................................................133
Wildcards in Policy Rules.........................................................................................................133
Environment Variables in Policy Rules................................................................................. 133
Environment Variable Support for Windows Vista and Later Releases........................134
Environment Variable Support for Windows XP............................................................... 135
Example: Using Wildcards and Variables in Policy Rules.................................................136
Process Management............................................................................................................................ 138
Process Protection Types........................................................................................................ 138
Processes Protected by the Default Policy.........................................................................138
Add a New Protected Process............................................................................................... 138
Import or Export a Process..................................................................................................... 140
View, Modify, or Delete a Process........................................................................................140
View Processes Currently Protected by Traps...................................................................141

Malware Protection....................................................................................... 143

Malware Protection Policy Best Practices....................................................................................... 145
Malware Protection Flow..................................................................................................................... 146
Phase 1: Evaluation of the Malware Protection Policy.................................................... 146
Phase 2: Evaluation of the Restriction Policy.....................................................................146
Phase 3: Evaluation of Hash Verdicts.................................................................................. 146
Manage Malware Protection Rules....................................................................................................149
Malware Protection Rules....................................................................................................... 149
Configure Child Process Protection...................................................................................... 149
Configure the Gatekeeper Enhancement MPM.................................................................151
Manage Restrictions on Executable Files.........................................................................................154
Restriction Rules........................................................................................................................ 154

TABLE OF CONTENTS v
 Add a New Restriction Rule....................................................................................................154
Manage Global Whitelists........................................................................................................156
Block Execution from Local and Network Folders............................................................ 157
Whitelist a Network Folder.....................................................................................................158
Define External Media Restrictions.......................................................................................159
Define Child Process Restrictions......................................................................................... 160
Define Java Restrictions...........................................................................................................161
WildFire Integration............................................................................................................................... 163
WildFire Integration Concepts............................................................................................... 163
Set Up the ESM to Communicate with WildFire...............................................................164
Set Up a Private WildFire Cloud........................................................................................... 166
Configure a WildFire Rule....................................................................................................... 167
Manage Hashes for Executable Files................................................................................................ 171
View and Search Hashes......................................................................................................... 171
Export and Import Hashes.......................................................................................................177
View a WildFire Report............................................................................................................178
View the History of a Verdict................................................................................................ 178
Override a WildFire Verdict....................................................................................................179
Recheck a WildFire Decision.................................................................................................. 180
Report an Incorrect Verdict.................................................................................................... 180
Upload a File to WildFire for Analysis................................................................................. 181
Manage Quarantine Settings.................................................................................................. 181
Restore a Quarantined File..................................................................................................... 182

Exploit Protection...........................................................................................185
Exploit Protection Rules....................................................................................................................... 187
Windows Exploit Protection Modules (EPMs)................................................................................ 188
Mac Exploit Protection Modules (EPMs)..........................................................................................190
Create an Exploit Protection Rule......................................................................................................191
Exclude an Endpoint from an Exploit Protection Rule.................................................................. 194

Manage the Endpoints.................................................................................. 195

Manage Traps Action Rules................................................................................................................. 197
Traps Action Rules.....................................................................................................................197
Add a New Action Rule........................................................................................................... 197
Manage Data Collected by Traps.......................................................................................... 198
Uninstall or Upgrade Traps on the Endpoint...................................................................... 200
Manage Agent Settings Rules............................................................................................................. 201
Traps Agent Settings Rules..................................................................................................... 201
Add a New Agent Settings Rule............................................................................................ 202
Define Event Logging Preferences........................................................................................203
Hide or Restrict Access to the Traps Console....................................................................204
Define Communication Settings Between the Endpoint and the ESM Server............205
Collect New Process Information..........................................................................................208
Manage Service Protection..................................................................................................... 209
Change the Uninstall Password............................................................................................. 210
Create a Custom User Alert Message.................................................................................. 211
Remove an Endpoint from the ESM Console..................................................................................213

Forensics........................................................................................................... 215
Forensics Overview................................................................................................................................217
Forensics Flow............................................................................................................................217

vi TABLE OF CONTENTS
 Forensic Data Types................................................................................................................. 218
Best Practices for Managing Forensic Data.................................................................................... 220
Manage Forensics Rules and Settings...............................................................................................221
Forensics Rules...........................................................................................................................221
Change the Default Forensic Folder.....................................................................................221
Create a Forensics Rule........................................................................................................... 223
Define Memory Dump Preferences...................................................................................... 224
Define Forensics Collection Preferences.............................................................................225
Retrieve Data About a Security Event................................................................................. 226
Agent Query............................................................................................................................................ 228
Agent Query Flow..................................................................................................................... 228
Search Endpoints for a File, Folder, or Registry Key........................................................ 228
View the Results of an Agent Query....................................................................................229

Reports and Logging......................................................................................231

Event Log Types..................................................................................................................................... 233
Security Events...........................................................................................................................233
Policies - General....................................................................................................................... 234
Policies - Rules........................................................................................................................... 234
Policies - Process Management............................................................................................. 235
Policies - Restriction Settings................................................................................................. 235
Policies - Hash Control.............................................................................................................236
Monitor - Agent......................................................................................................................... 237
Monitor ESM...............................................................................................................................241
Settings - Administration......................................................................................................... 242
Settings - Agent......................................................................................................................... 243
Settings - ESM............................................................................................................................244
Settings - Conditions.................................................................................................................245
Settings - Licenses.....................................................................................................................245
Settings - Installation Package................................................................................................246
Common Variables Used in Events....................................................................................................248
Agent Change Event Variables...............................................................................................248
ESM Configuration Change Event Variables.......................................................................248
Policy Change Event Variables...............................................................................................249
ESM Server Event Variables................................................................................................... 250
Security Event Monitoring Variables.................................................................................... 250
Forward Logs to an External Logging Platform.............................................................................. 252
Enable Log Forwarding to an External Logging Platform.................................................252
Enable Log Forwarding to an External Logging Platform Using the DB Configuration
Tool................................................................................................................................................253
CEF Format................................................................................................................................. 254
LEEF Format................................................................................................................................267
Syslog (RFC5424) Format........................................................................................................ 281
Forward Logs to Panorama..................................................................................................................294
Set Up Secure Communication with Panorama................................................................. 294
Enable Log Forwarding to Panorama....................................................................................296
View ESM Logs and Correlated Events on Panorama...................................................... 297
Forward Logs to Email.......................................................................................................................... 299
Enable Log Forwarding to Email............................................................................................ 299
Email Format............................................................................................................................... 300

Troubleshooting.............................................................................................. 317
Traps Troubleshooting Resources...................................................................................................... 319

TABLE OF CONTENTS vii

 Traps and Endpoint Security Manager Processes.......................................................................... 321
ESM Tech Support File......................................................................................................................... 322
Database (DB) Configuration Tool..................................................................................................... 323
Access the Database Configuration Tool............................................................................ 323
Configure Administrative Access to the ESM Console Using the DB Configuration
Tool................................................................................................................................................324
Configure ESM Server Settings Using the DB Configuration Tool................................ 325
Customizable ESM Server Settings....................................................................................... 326
Cytool.........................................................................................................................................................329
Access Cytool............................................................................................................................. 329
View the Status of the Agent Using Cytool........................................................................331
View Processes Currently Protected by Traps Using Cytool.......................................... 331
Manage Protection Settings on the Endpoint Using Cytool........................................... 332
Manage Traps Drivers and Services on the Endpoint Using Cytool..............................335
View and Compare Security Policies on an Endpoint Using Cytool.............................. 339
Manage Logging of Traps Components Using Cytool...................................................... 341
Restore a Quarantined File Using Cytool............................................................................ 342
View Statistics for a Protected Process Using Cytool...................................................... 343
View Details About the Traps Local Analysis Module Using Cytool............................. 344
View Hash Details About a File Using Cytool.................................................................... 345
Troubleshoot Traps Issues................................................................................................................... 346
Why cant I install Traps?........................................................................................................ 346
Why cant I upgrade or uninstall Traps?.............................................................................. 346
Why cant Traps connect to the ESM Server?................................................................... 347
How do I fix a Traps server certificate error?.................................................................... 349
Troubleshoot ESM Console Issues.....................................................................................................350
Why cant I log in to the ESM Console?..............................................................................350
Why do I get a server error when launching the ESM Console?................................... 351
Why do all endpoints appear as disconnected in the ESM Console?............................351

viii TABLE OF CONTENTS

Traps Overview
Traps replaces antiquated antivirus solutions by preventing advanced persistent threats
(APTs) and zero-day attacks. Traps also provides protection for your endpoints by blocking
attack vectors before any malware is initiated or software vulnerabilities or bugs are exploited.
The following topics describe the Traps solution in more detail:

> About Traps

> Traps Components

9
10 TRAPS ADMINISTRATOR'S GUIDE | Traps Overview
About Traps
Cyberattacks are attacks performed on networks or endpoints to inflict damage, steal information, or
achieve other goals that involve taking control over computer systems that do not belong to the attackers.
Adversaries perpetrate cyberattacks either by causing a user to unintentionally run a malicious executable
file or by exploiting a weakness in a legitimate executable file to run malicious code behind the scenes
without the knowledge of the user.
One way to prevent these attacks is to identify executable files, dynamic-link libraries (DLLs), or other
pieces of code as malicious and then prevent them from executing by testing each potentially dangerous
code module against a list of specific, known threat signatures. The weakness of this method is that it is
time-consuming for signature-based antivirus (AV) solutions to identify newly created threats that are
known only to the attacker (also known as zero-day attacks or exploits) and add them to the lists of known
threats, which leaves endpoints vulnerable until signatures are updated.
The Traps solution takes a more effective and efficient approach to preventing attacks thus eliminating the
need for traditional AV. Rather than try to keep up with the ever-growing list of known threats, Traps sets
up a series of roadblocks that prevent the attacks at their initial entry pointsthat point where legitimate
executable files are about to unknowingly allow malicious access to the system.
Traps targets software vulnerabilities in processes that open non-executable files using exploit prevention
techniques. Traps also uses malware prevention techniques to prevent malicious executable files from
running. Using this two-fold approach, the Traps solution can prevent all types of attacks, whether they are
known or unknown threats.
All aspects of endpoint security settingsthe endpoints and groups to which settings are applied, the
applications they protect, the defined rules, the restrictions, and the actionsare all highly configurable.
This allows each organization to tailor Traps to its needs so that Traps can provide maximum protection
with minimal disruption of day-to-day activities.
Malware Protection Overview
Exploit Protection Overview

Malware Protection Overview

Malicious executable files, known as malware, are often disguised as or embedded in non-malicious files.
These files can attempt to gain control, gather sensitive information, or disrupt the normal operations of the
system.
Traps prevents malware by reducing the attack surface and increasing the accuracy of malware detection.
This approach combines several layers of protection, collectively known as the Malware Prevention Engine.
Using the following combination of mitigation techniques, the Malware Prevention Engine can automatically
prevent malicious and unknown executable filesincluding Microsoft Windows screensaver files (.scr)and
macros from running and, when unable to prevent, halt malicious behavior:
WildFire integrationEnables automatic detection of unknown malware and quickly prevents threats
before an enterprise is compromised.
Evaluation of trusted signersPermits unknown executable files that are signed by trusted signers to run
on the endpoint.
Local static analysisEnables Traps to use machine learning to analyze unknown executable files and
issue a verdict. Traps uses the verdict returned by the local analysis module until it receives a verdict
from the ESM Server.
Policy-based restrictionsEnables you to block files from executing from specific local folders, network
folders, or external media locations.
Malware protection modulesTargets specific malware behaviors and enable you to block the creation
of child processes.

TRAPS ADMINISTRATOR'S GUIDE | Traps Overview 11

 Office file protectionEnables you to block known and unknown Macros when run from Microsoft
Office files.
For additional information, see Malware Protection Flow.

Exploit Protection Overview

An exploit is a sequence of commands that take advantage of a bug or vulnerability in a software
application or process. Attackers use these exploits as a means to access and use a system to their
advantage. To gain control of a system, the attacker must take advantage of a chain of vulnerabilities in
the system. Blocking any attempt to exploit a vulnerability in the chain will block the exploitation attempt
entirely.
In a typical attack scenario, an attacker attempts to gain control of a system by first corrupting or bypassing
memory allocation or handlers. Using memory-corruption techniques, such as buffer overflows and heap
corruption, a hacker can trigger a bug in software or exploit a vulnerability in a process. The attacker must
then manipulate a program to run code provided or specified by the attacker while evading detection. If the
attacker gains access to the operating system, the attacker can then upload malware, such as Trojan horses
(programs that contain malicious executable files), or otherwise use the system to their advantage. Traps
prevents such exploit attempts by employing roadblocks or traps at each stage of an exploitation attempt.

To combat these types of attacks, Traps employs Exploit Protection. When a user opens a non-executable
file, such as a PDF or Word document, and the process that opened the file is protected, the Traps agent
seamlessly injects code into the software. This occurs at the earliest possible stage before any files
belonging to the process are loaded into memory. The Traps agent then activates one or more Exploit
Protection Modules (see Windows Exploit Protection Modules (EPMs) and Mac Exploit Protection Modules
(EPMs)) inside the protected process. The EPM targets a specific exploitation technique and is designed to
prevent attacks on program vulnerabilities based on memory corruption or logic flaws.
Examples of attacks that the EPMs can prevent include dynamic-link library (DLL) hijacking (replacing
a legitimate DLL with a malicious one of the same name), hijacking program control flow, and inserting
malicious code as an exception handler.
In addition to automatically protecting processes from such attacks, Traps reports any prevention events
to the Endpoint Security Manager, and performs additional actions according to the settings of the security
policy rules. Common actions that Traps performs include collecting forensic data and notifying the user
about the event. Traps does not perform any additional scanning or monitoring actions.
The default endpoint security policy protects the most vulnerable and most commonly used applications,
but you can also add other third-party and proprietary applications to the list of protected processes. For
more information, see Add a New Protected Process.

12 TRAPS ADMINISTRATOR'S GUIDE | Traps Overview

Traps Components
The Traps solution centers around the Endpoint Security Manager (ESM), which comprises an ESM Console,
a database, an ESM Server, and the Traps agent protection software. The Traps agent is installed on each
endpoint in your organization and, together, these components manage security policy rules, distribute the
security policy to endpoints, and enforce the policy on the endpoints. The following diagram displays the
Traps components and their relationships to each other and to other security components.

The following topics describe the Traps and other components in more detail.
ESM Console on page 13
ESM Server on page 13
Database on page 14
Endpoints on page 14
Traps Agent on page 14
External Logging Platform on page 15
WildFire on page 15
Forensic Folder on page 16

ESM Console
The Endpoint Security Manager (ESM) Console is a web interface that enables you to manage security
events, monitor endpoint health, and configure policy rules from a web browser. The ESM Console
communicates with the database independently from the ESM Server. You can install the ESM Console on
the same server as the ESM Server, on a separate server, or on a cloud-based server.

As a best practice, use a single ESM Console to manage the ESM Server(s) in your Traps
deployment. Using multiple ESM Consoles is not supported.

For information on hardware and software requirements for the ESM Console, see ESM Console Software
Requirements.

ESM Server
The Endpoint Security Manager (ESM) Server functions as the connection server that relays information
between the ESM components, including the Traps agent, and WildFire. Each ESM Server supports up to

TRAPS ADMINISTRATOR'S GUIDE | Traps Overview 13

 16,000 Traps agents. In a multi-ESM deployment you can also install up to 5 ESM Servers to support up to
80,000 agents.
On a regular basis, the ESM Server retrieves the security policy from the database and distributes it to all
Traps agents. Traps agents also relay security event information back to the ESM Server. For information on
requirements for the ESM Server, see ESM Server Software Requirements.

Database
The database stores administrative information, security policy rules, endpoint history, and other
information about security events. The database is managed over the MS-SQL platform. Each database
requires a license and can communicate with one or more ESM Servers. The database may be installed on
the same server as the ESM Console and ESM Server, such as in a standalone environment, or the database
can be installed on a dedicated server. For information on hardware and software requirements for the
database, see Database Software Requirements.

During evaluation we recommend you use SQL Server Express which enables you to easily
migrate the database to SQL Server Standard or SQL Server Enterprise.

Endpoints
An endpoint is a Windows- or Mac-based computer, server, virtual machine, tablet, or mobile device
running the client-side protection application named Traps. For prerequisites, see Traps Software
Requirements.

Traps Agent
The Traps agent protects the endpoint by enforcing your organizations security policy as defined in
the Endpoint Security Manager. Depending on the configuration, Traps can protect against attempts to
exploit software vulnerabilities and bugs and can prevent malicious executable files from running on your
endpoints.
When a security event occurs on an endpoint, Traps collects forensic information about that event and,
optionally, can also notify the user about the event and even display a custom notification message. On
a regular basis, Traps communicates the status of the endpoint and transmits data related to any security
events to the Endpoint Security Manager. The following table describes the types of messages that the
Traps agent sends to the ESM Server:

Message Type Description

Traps status The Traps agent periodically sends messages to the ESM Server to
indicate that it is operational and to request the latest security policy. The
Notifications and Health pages in the Endpoint Security Manager display
the status for each endpoint. The duration between messages, known as the
heartbeat period, is configurable.

Notifications The Traps agent sends notification messages about changes in the agent, such
as when a service starts or stops, to the ESM Server. The server logs these
notifications in the database and you can view the notifications in the ESM
Console.

14 TRAPS ADMINISTRATOR'S GUIDE | Traps Overview

 Message Type Description

Updates An end user can request an immediate policy update by clicking Check In
Now on the Traps Console. This causes the Traps agent to request the latest
security policy from the ESM Server without waiting for the end of the
heartbeat period.

Prevention reports If a prevention event occurs on an endpoint where the Traps agent is
installed, the Traps agent reports all of event-related information to the ESM
Server in real-time.

Traps also provides a user interface that you can use to view the protection status on the endpoint, security
event history, running processes, and current security policy rules. Usually, a user will not need to run the
Traps Console but the information can be useful when investigating a security-related event. If needed,
you can choose to hide the console icon that launches the console or prevent users from launching the
console from an endpoint altogether. If you provide access to the Traps Console, you can access it from the
notification area (system tray) on an endpoint.

External Logging Platform

By using an external logging platformsuch as security information and event management (SIEM) system
or a syslog deviceyou can view aggregated logs from the ESM Console and ESM Servers. You can
also configure the ESM to send logs to Panorama. The ability to view Traps logs in the same context as
the firewall logs allows you to correlate discrete activity observed on the network and the endpoints.
Correlated events help you see the overall picture across your network and the endpoints so that you can
detect any risks that evade detection or take advantage of blind spots, and strengthen your security posture
well before any damage occurs.
When enabled, the ESM component forwards reports about events to the external logging platform in
addition to storing logs internally. The ESM component which forwards the logs varies depending on the
type of event. For example, if you monitor verdict changes, the ESM Console sends logs when you override
the verdict for a hash. If WildFire changes the verdict, the ESM Server sends the logs.
You can also integrate your external logging platform with third-party monitoring tools, such as Splunk, to
analyze log data. Download the Splunk app for Palo Alto Networks at https://apps.splunk.com/app/491/.
To add an external logging platform, see Forward Logs to an External Logging Platform.

WildFire
The Traps agent is designed to block attacks before any malicious code can run on the endpoint. While this
approach ensures the safety of data and infrastructure, it enables the collection of forensic evidence only
at the moment of prevention. And while Traps can prevent the attack, Traps alone cannot fully reveal the
purpose of the attack or its entire flow.
To provide more insight into malware activity, the Endpoint Security Manager supports WildFire
integration. This enables the Endpoint Security Manager to send any unknown executable files to WildFire,
a malware analysis environment that turns unknown threats into preventable incidents.
You can integrate WildFire with your Endpoint Security Manager using either of the following two options:
WildFire public cloudThe WildFire Virtual Environment analyzes and identifies previously unknown
malware and generates signatures that Palo Alto Networks firewalls and Palo Alto Networks Endpoint
Security Managers can use to detect and block the malware. When Traps detects an unknown sample
(an executable file or macro), the Endpoint Security Manager can automatically forward the sample for
WildFire analysis.

TRAPS ADMINISTRATOR'S GUIDE | Traps Overview 15

 WildFire private cloudA WildFire private cloud enables you to analyze unknown executable files
discovered on Windows endpoints in a local sandbox. To deploy a WildFire private cloud, you must
install a local WF-500 appliance.

The local WF-500 appliance is ideal for deployments with privacy and legal regulations that restrict the
transfer of files outside your network. The WildFire-500 appliance queries the WildFire public cloud
to obtain the verdict and, if unknown, analyzes the executable file in the local sandbox. By default, the
WF-500 appliance does not send discovered malware outside your network, however, you can choose
to automatically forward malware to the WildFire public cloud to generate and distribute signatures to
all Palo Alto Networks firewalls with Threat Prevention and WildFire licenses. Otherwise, the WF-500
appliance only forwards the malware report (and not the sample itself) to the WildFire public cloud.
If WildFire integration is enabled in the ESM Console, the Status page of the Traps Console displays a
next to Forensic Data Collection. If WildFire is not enabled, the Traps Console displays an next to
Forensic Data Collection.
For more information, see Set Up the ESM to Communicate with WildFire and Malware Protection Flow.

Forensic Folder
When Traps encounters a security-related event, such as a file execution or an exploit attack, it logs real-
time forensic details about the event on the endpoint. The forensic data includes the memory dump and
other information associated with the event. You can retrieve the forensic data by creating an action rule to
collect the data from the endpoint. After the endpoint receives the security policy that includes the action
rule, the Traps agent sends all the forensic information to the forensic folder, which is sometimes referred
to as the quarantine folder.
During the initial installation, you specify the path of the forensic folder that the Endpoint Security Manager
uses to store forensic information it retrieves from endpoints. The Endpoint Security Manager supports
multiple forensic folders and enables the Background Intelligent Transfer Service (BITS) on the folder during

16 TRAPS ADMINISTRATOR'S GUIDE | Traps Overview

installation. If the forensic folder specified during installation cannot be reached, Traps defaults to the
forensic folder specified in the ESM Console. You can change the default folder at any time using the ESM
Console.
For more information, see Forensics Flow on page 217.

TRAPS ADMINISTRATOR'S GUIDE | Traps Overview 17

18 TRAPS ADMINISTRATOR'S GUIDE | Traps Overview
Traps Deployment Scenarios
You can deploy the Traps solution in a wide range of environments. The following topics
describe typical deployment scenarios that take into account the number of agents and sites:

> Standalone Deployment on page 21

> Small Deployments on page 22
> Large Deployments on page 24

For installation prerequisites and considerations, see Prerequisites on page 29.

19
20 TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios
Standalone Deployment

For an initial proof of concept (POC) or a small site with fewer than 3000 Traps agents, use a standalone
deployment to install the following Endpoint Security Manager (ESM) components on a single server or
virtual machine:
ESM Server
ESM Console
Forensic (quarantine) folder
Database
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform, such as an SIEM or syslog
For best practices on using a phased approach for installing Traps on endpoints, see Recommended Traps
Deployment Process on page 53.

TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios 21

Small Deployments
Small Single-Site Deployment on page 22
Small Multi-Site Deployment on page 23

Small Single-Site Deployment

This single-site deployment scenario supports up to 16,000 Traps agents in Traps ESM 4.0.0 or up to
30,000 Traps agents in Traps ESM 4.0.1 and consists of the following components:
One dedicated database server
One ESM Console for managing the security policy and Traps agents
Two ESM Servers, one primary and one backup, on the same network segment as the database server
and ESM Console
One forensic folder accessible by all endpoints for storing real-time forensic details about security
events
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform, such as an SIEM or syslog
In this deployment scenario, a single site contains the database, ESM Console for managing local policies
and endpoints, and redundant ESM Servers. In the event that the primary ESM Server is inaccessible, Traps
agents connect to the Endpoint Security Manager using the backup server. Both servers obtain the security
policy from the database and distribute the policy to the agents.

22 TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios

Small Multi-Site Deployment

This multi-site deployment scenario supports up to 32,000 Traps agents if using Traps ESM 4.0.0 or 60,000
Traps agents if using Traps ESM 4.0.1 and consists of the following components:
One dedicated database server at one of the sites
One ESM Console in the same location as the database for managing the security policy and Traps
agents
One ESM Server per site or two ESM Servers per site for redundancy
One forensic folder accessible by all endpoints for storing real-time forensic details about security
events
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform, such as an SIEM or syslog
In this deployment scenario, Site A contains an ESM Server, database, and ESM Console for managing local
policies and endpoints. Site B contains a second ESM Server that is capable of supporting up to 16,000
additional agents in Traps ESM 4.0.0 or 30,000 additional agents in Traps ESM 4.0.1. Both servers obtain
the security policy from the database located in Site A and distribute the policy to the agents. The agents
connect to the primary ESM Server on their site while the ESM Server in the other site acts as a secondary
backup server.

TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios 23

Large Deployments
Large Single-Site Deployment on page 24
Large Multi-Site Deployment with One Endpoint Security Manager on page 25
Large Multi-Site Deployment with Roaming Agents (Without VPN) on page 26
Large Multi-Site Deployment with Roaming Agents (With VPN) on page 27

Large Single-Site Deployment

This single-site deployment scenario supports up to 80,000 Traps agents in Traps ESM 4.0.0 or 150,000
Traps agents in Traps ESM 4.0.1 and consists of the following components:
One dedicated database server
One ESM Console in the same location as the database for managing the security policy and Traps
agents
One ESM Server 4.0.0 for every 16,000 Traps agents (for a maximum of 80,000 agents) or one ESM
Server 4.0.1 for every 30,000 Traps agents (for a maximum of 150,000 agents).
One forensic folder for each ESM Server that is accessible by all endpoints for storing real-time forensic
details about security events
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform such as an SIEM or syslog
In this example, up to 80,000 (4.0.0) or 130,000 (4.0.1) Traps agents can connect to the Endpoint Security
Manager. To support this scenario, the endpoints connect to five ESM Servers through an optional load
balancer. Each ESM Server connects to a central database that is managed by a dedicated ESM Console.

24 TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios

Large Multi-Site Deployment with One Endpoint Security
Manager

This multi-site deployment scenario supports up to 80,000 Traps agents in Traps ESM 4.0.0 or 150,000
Traps agents in Traps ESM 4.0.1 and consists of the following components:
One dedicated database server
One ESM Console in the same location as the database for managing the security policy and Traps
agents
One ESM Server for every 16,000 Traps agents (for a maximum of 80,000 agents) in each 4.0.0 site or
30,000 Traps agents (for a maximum of 150,000 agents) in each 4.0.1 site
One forensic folder for each ESM Server that is accessible by all endpoints for storing real-time forensic
details about security events
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform such as an SIEM or syslog
In this example, Sites A, B, C, D, and E each need to support up to 16,000 Traps agents in Traps ESM 4.0.0
or 30,000 Traps agents in Traps ESM 4.0.1. To support this scenario, you must deploy an ESM Server in
each site that retrieves the security policy from the database located in Site A. The agents connect to the
Endpoint Security Manager using their local ESM Servers as the primary server and use the ESM Servers at
other sites as secondary servers.

TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios 25

Large Multi-Site Deployment with Roaming Agents (Without
VPN)

This deployment scenario consists of the following components:

One dedicated database server
One ESM Console in the same location as the database for managing the security policy and Traps
agents
One ESM Server for every 30,000 Traps agents (for a maximum of 150,000 agents) in each 4.0.1 site or
16,000 Traps agents (for a maximum of 80,000 agents) in each 4.0.0 site
One ESM Server with a public-facing DNS record that accepts connections from roaming Traps agents
configured in one of two ways:
Configured with a port that accepts connections from external networks
Installed in a DMZ with a connection to the internal database server

This server can also function as a backup server.

One forensic folder for each ESM Server that is accessible by all endpoints for storing real-time forensic
details about security events
(Recommended) WildFire integration
(Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform such as an SIEM or syslog
In this example, Sites A, B, C, and D each need to support up to 16,000 Traps agents in Traps ESM 4.0.0
or 30,000 Traps agents in Traps ESM 4.0.1. An additional site supports Traps agents that are roaming. To
support this scenario, each site contains an ESM Server that retrieves the security policy from the database
located at Site A. Internal endpoints connect to the Endpoint Security Manager using their local ESM
Servers. External endpoints connect through a publicly available ESM Server located in a DMZ or through a
port that is configured to allow traffic from external networks. If an endpoint is roaming and cannot connect
to the ESM Server, Traps collects prevention data locally until the agent can establish a connection to the
forensic folder.

26 TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios

Large Multi-Site Deployment with Roaming Agents (With VPN)

In Traps ESM 4.0.1, this deployment scenario supports up to 90,000 Traps agents that can connect through
local sites and from off-site locations through a VPN tunnel. To support up to 150,000 Traps agents, you
can deploy two additional 4.0.1 ESM Servers.
In Traps ESM 4.0.0, this deployment scenario supports up to 48,000 Traps agents that can connect through
local sites and from off-site locations through a VPN tunnel. To support up to 80,000 Traps agents, you can
deploy two additional 4.0.0 ESM Servers).
This multi-site environment consists of the following components:
One dedicated database server
One ESM Console in the same location as the database for managing the security policy and Traps
agents
One ESM Server for every 30,000 Traps agents (for a maximum of 150,000 agents) in each 4.0.1 site or
16,000 Traps agents (for a maximum of 80,000 agents) in each 4.0.0 site
GlobalProtect or an alternative VPN gateway to provide roaming users with an internal IP address for
accessing the ESM Server
One forensic folder for each ESM Server that is accessible by all endpoints for storing real-time forensic
details about security events
(Recommended) WildFire integration

TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios 27

 (Optional) Load balancer for distributing traffic across ESM Servers
(Optional) External logging platform such as an SIEM or syslog
In this example, Sites A, B, and C each need to support up to 16,000 Traps agents with some of those
agents located off-site. To support this scenario, each site contains an ESM Server that retrieves the
security policy from the database located at Site A. Internal endpoints connect to the Endpoint Security
Manager using their local ESM Servers. External endpoints connect through a VPN tunnel that provides
the endpoint with an internal IP address for connecting to the site. If an endpoint is roaming and cannot
connect over VPN, Traps collects prevention data locally until the agent can establish a connection to the
forensic folder.

28 TRAPS ADMINISTRATOR'S GUIDE | Traps Deployment Scenarios

Prerequisites
The following topics describe prerequisites for installing the Traps infrastructure:

> Hardware Requirements on page 31

> Software Requirements on page 35

29
30 TRAPS ADMINISTRATOR'S GUIDE | Prerequisites
Hardware Requirements
Standalone Endpoint Security Manager Hardware Requirements on page 31
Distributed Endpoint Security Manager Hardware Requirements on page 31
Traps Hardware Requirements on page 33

Standalone Endpoint Security Manager Hardware Requirements

In a Standalone Deployment on page 21, you install the Endpoint Security Manager componentswhich
consists of the ESM Server, ESM Console, and databaseon the same server. The following table displays
the hardware requirements for the standalone server.

Specification 250 Agents 3000 Agents

Processor 2-Core Intel Xeon E5-2660 V2 4-Core Intel Xeon E5-2660 V2

2.2GHz or better 2.2GHz or better

Disk space for Traps First year: 250MB First year: 2.5GB
data Second year: 500MB Second year: 5GB
Third year: 1GB Third year: 10GB

RAM 4GB 16GB

Database SQL Express SQL Server

For Traps requirements, see Traps Hardware Requirements on page 33.

Distributed Endpoint Security Manager Hardware Requirements

In a distributed deployment, you install the Endpoint Security Manager componentswhich consists of the
ESM Server, ESM Console, and databaseon different servers.

TRAPS ADMINISTRATOR'S GUIDE | Prerequisites 31

 The following tables display the hardware requirements for each Endpoint Security Manager in release
4.0.1 and 4.0.0. For hardware requirements to install the ESM components on a standalone server, see
Standalone Endpoint Security Manager Hardware Requirements.

Table 1: Hardware Requirements for ESM 4.0.1

Specification 500 Agents 5,000 Agents 10,000 30,000 100,000 150,000

Agents Agents Agents Agents

ESM Console Hardware Requirements

Processor 2-Core 4-Core 4-Core 4-Core 4-Core 4-Core

2.2GHz or 2.2GHzor 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or
better better better better better better

Disk space 3GB plus 3GB plus 3GB plus 3GB plus 3GB plus 3GB plus
50GB for 50GB for 50GB for 50GB for 50GB for 50GB for
the forensic the forensic the forensic the forensic the forensic the forensic
folder folder folder folder folder folder

RAM 4GB 8GB 8GB 8GB 8GB 8GB

ESM Server Hardware Requirements

Processor 2-Core 4-Core 8-Core 8-Core Install 4 or Install 5 or

2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or more ESM more ESM
better better better better Servers to Servers to
support support
Disk space 3GB plus 3GB plus 3GB plus 3GB plus this number this number
50GB for 50GB for 50GB for 50GB for of agents of agents
the forensic the forensic the forensic the forensic (each server (each server
folder folder folder folder supports up supports up
to 30,000 to 30,000
RAM 4GB 4GB 8GB 8GB agents) agents)

Database Hardware Requirements

Processor 4-Core 8-Core 8-Core 8-Core 8-Core 8-Core

2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or
better better better better better better

Disk space First First First First First First

for Traps year: year: year: year: year: year:
data 250MB 2.5GB 5GB 15GB 50GB 75GB
Second Second Second Second Second Second
year: year: year: year: year: year:
500MB 5GB 10GB 30GB 100GB 150GB
Third Third Third Third Third Third
year: year: year: year: year: year:
1GB 10GB 20GB 60GB 200GB 300GB

RAM 4GB RAM 8GB RAM 8GB RAM 8GB RAM 32GB RAM 32GB RAM

32 TRAPS ADMINISTRATOR'S GUIDE | Prerequisites

 Table 2: Hardware Requirements for ESM 4.0.0

Specification 500 Agents 5,000 Agents 10,000 16,000 50,000 80,000

Agents Agents Agents Agents

ESM Console Hardware Requirements

Processor 2-Core 4-Core 4-Core 4-Core 4-Core 4-Core

2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or
better better better better better better

Disk space 3GB plus 3GB plus 3GB plus 3GB plus 3GB plus 3GB plus
50GB for 50GB for 50GB for 50GB for 50GB for 50GB for
the forensic the forensic the forensic the forensic the forensic the forensic
folder folder folder folder folder folder

RAM 4GB 8GB 8GB 8GB 8GB 8GB

ESM Server Hardware Requirements

Processor 2-Core 4-Core 8-Core 8-Core Install 4 or Install 5 or

2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or more ESM more ESM
better better better better Servers to Servers to
support support
Disk space 3GB plus 3GB plus 3GB plus 3GB plus this number this number
50GB for 50GB for 50GB for 50GB for of agents of agents
the forensic the forensic the forensic the forensic (each server (each server
folder folder folder folder supports up supports up
to 16,000 to 16,000
RAM 4GB 4GB 8GB 8GB agents) agents)

Database Hardware Requirements

Processor 4-Core 8-Core 8-Core 8-Core 8-Core 8-Core

2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or 2.2GHz or
better better better better better better

Disk space First First First First First First

for Traps year: year: year: year: year: year:
data 250MB 2.5GB 5GB 7.5GB 26GB 52GB
Second Second Second Second Second Second
year: year: year: year: year: year:
500MB 5GB 10GB 15GB 52GB 104GB
Third Third Third Third Third Third
year: year: year: year: year: year:
1GB 10GB 20GB 30GB 100GB 200GB

RAM 4GB RAM 8GB RAM 8GB RAM 8GB RAM 32GB RAM 32GB RAM

Traps Hardware Requirements

The following table displays the hardware requirements for each endpoint.

TRAPS ADMINISTRATOR'S GUIDE | Prerequisites 33

 Specification Per Endpoint

Processor Intel Pentium 4 or later with SSE2 instruction set support

AMD Opteron/Athlon 64 or later with SSE2 instruction set
support

Disk space 200MB minimum; 20GB recommended

RAM 512MB minimum; 2GB recommended

For software requirements see Traps Software Requirements on page 37.

34 TRAPS ADMINISTRATOR'S GUIDE | Prerequisites

Software Requirements
ESM Console Software Requirements on page 35
ESM Server Software Requirements on page 35
Database Software Requirements on page 36
Traps Software Requirements on page 37

ESM Console Software Requirements

Before installing ESM Console software, make sure that the server meets the following prerequisites:
ESM Server and ESM Console are running the same version
English-language version of a physical or virtual Windows Server. To determine which versions of
Windows Server are supported, refer to Where Can I Install the Endpoint Security Manager (ESM)? in
the Palo Alto Networks Compatibility Matrix.
Internet Information Services (IIS) 7.0 or above with ASP.NET and Static Content Compressions
components
.NET Framework 4.5.1 Full
SSL certificate from a trusted certificate authority (CA) with server authentication and client
authentication (recommended)
Allow communication on the TCP port from clients to server (the default is port 2125)
Forensic folder with BITS enabled
Allow communication on HTTP port (80) or HTTPS port (443) from the clients to the quarantine folder
Browser, any of the following:
Internet Explorer 10 and later versions
Microsoft Edge (all versions)
Chrome 30 and later versions
Firefox 35 and later versions
Opera 25 and later versions
For ESM Console hardware requirements, see Distributed Endpoint Security Manager Hardware
Requirements

ESM Server Software Requirements

In a Multi-ESM Server deployment you can deploy multiple ESM Servers to support the agents in your
organization. The number of agents supported by your ESM deployment and per ESM Server vary
depending on the ESM version:
4.0.130,000 agents per ESM Server and a total number of 150,000 agents per database
4.0.016,000 agents per ESM Server and a total number of 80,000 agents per database
While you can deploy as many ESM Servers as you want, you cannot exceed the total number of supported
agents for the database.
Before installing ESM Server software, make sure that the server meets the following prerequisites:
ESM Server and ESM Console running the same version.
Ensure that the round-trip communication time between the ESM Server and the database is less than
80 ms.
.NET Framework 4.5.1 Full
SSL certificate from a trusted certificate authority (CA) with server authentication and client
authentication (recommended)

TRAPS ADMINISTRATOR'S GUIDE | Prerequisites 35

 Allow communication on the TCP port from clients to server (the default is port 2125)
Forensic folder with BITS enabled
Internet Information Services (IIS) 7.0 or above with ASP.NET and Static Content Compressions
components
English-language version of a physical or virtual Windows Server. To determine which versions of
Windows Server are supported, refer to Where Can I Install the Endpoint Security Manager(ESM)? in the
Palo Alto Networks Compatibility Matrix.
Communication between the ESM Server and the agents is based on Windows Communication
Foundation (WCF) client with a TLS/SSL version which is dependent on the version of the Traps agent
and the operating system.
Traps 4.0.x on Windows XP, Windows Vista, Windows Server 2003, and Windows Server 2008
TLS/SSL 1.2
Traps 4.0.x on all other operating systemsTLS/SSL 1.0
Traps 3.4.xTLS/SSL 1.0
For ESM Server hardware requirements, see Distributed Endpoint Security Manager Hardware
Requirements

Database Software Requirements

The server-side applications require an SQL database that can be either a local database installed on the
same server as the ESM Console or ESM Server, or an external database installed on another machine.
If you plan to deploy multiple ESM Servers, install the database on the ESM Console or use an external
database.

Consult with the Palo Alto Networks support team if you require integration with an existing
database.

Provision a database server that meets the following prerequisites:

Database application for use during evaluation or production. Use one of the following:

SQL Server Express SQL Server Enterprise SQL Server Standard

Versions 2008 R2 2008 2008

2012 2012 2012
2014 2012 with Always 2014
2016 On* 2016
2014 2016 with Always
2014 with Always On*
On*
*Always On based on
2016 group availability
2016 with Always
On*
*Always On based on
group availability

Agents supported 200 endpoints 200 endpoints 200 endpoints

during evaluation 50 VDI 50 VDI 50 VDI
50 server 50 server 50 server

36 TRAPS ADMINISTRATOR'S GUIDE | Prerequisites

 SQL Server Express SQL Server Enterprise SQL Server Standard

Agents supported 250 agents 4.0.1150, 000 4.0.1150, 000

during production agents agents
per database cluster 4.0.080, 000 4.0.080, 000
agents agents

English-language version of a physical or virtual Windows Server. To determine which versions of

Windows Server are supported, refer to Where Can I Install the Endpoint Security Manager (ESM)? in
the Palo Alto Networks Compatibility Matrix.
For database hardware requirements, see Distributed Endpoint Security Manager Hardware
Requirements

Traps Software Requirements

Before installing Traps software, make sure that the target endpoint meets the following prerequisites:
ESM Server and ESM Console running the same or a later version than the Traps agent
Operating system: Palo Alto Networks supports Traps on many operating systems. To determine the
minimum Traps release for a specific operating system, refer to Where Can I Install the Traps Agent? in
the Palo Alto Networks Compatibility Matrix.
Virtual environments and applications: Palo Alto Networks supports Traps on virtual desktops and
applications. To determine the minimum Traps release for a specific virtual technology, refer to Where
Can I Install the Traps Agent? in the Palo Alto Networks Compatibility Matrix.
Allow communication on the TCP port from clients to server (the default is port 2125)
(Windows only) .NET:

Operating System .NET Version

Windows 7 and earlier releases .NET 3.5 SP1 or 3.5.1

Windows 8 .NET 4.5

Windows 8.1 .NET 4.5.1

Windows 10 and later releases .NET 4.6

Windows Server 2008 .NET 3.5 SP1 or 3.5.1

Windows Server 2012 .NET 4.5

Windows Server 2012 R2 and later releases .NET 4.5.1

Windows Server 2016 .NET 4.5.1

(Windows only) BITS client
(Windows only) Windows Accessories (Notepad) to view logs
Traps Hardware Requirements

TRAPS ADMINISTRATOR'S GUIDE | Prerequisites 37

38 TRAPS ADMINISTRATOR'S GUIDE | Prerequisites
Set Up the Traps Infrastructure
The following topics describe how to set up the Traps infrastructure components:

> Set Up the Endpoint Infrastructure

> Activate Traps Licenses
> Set Up the Endpoint Security Manager
> Set Up the Endpoints
> Install Traps Components Using Windows Msiexec
> Verify a Successful Installation

39
40 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure
Set Up the Endpoint Infrastructure
Use the following workflow to set up the Endpoint infrastructure or, to upgrade your existing Endpoint
infrastructure, use the workflow to Upgrade to Traps 4.0 described in the Traps 4.0 New Features Guide:

STEP 1 | Activate Traps Licenses.

STEP 2 | Review the installation considerations of the software.

Endpoint Infrastructure Installation Considerations
Prerequisites

STEP 3 | Review the recommended implementation stages.

Recommended Traps Deployment Process

STEP 4 | (Optional) Configure SSL encryption.

TLS/SSL Encryption for Traps Components

STEP 5 | (Optional) Configure the MS-SQL Server.

Database Software Requirements
Configure the MS-SQL Server Database

STEP 6 | Install the ESM Server software.

ESM Server Software Requirements
Install the Endpoint Security Manager Server Software
(Optional) Install Traps Components Using Windows Msiexec

STEP 7 | Install the ESM Console software.

ESM Console Software Requirements
Install the Endpoint Security Manager Console Software
(Optional) Install Traps Components Using Windows Msiexec

STEP 8 | Install the Traps agent on the endpoints.

Traps Software Requirements
Install Traps on Windows Endpoints
(Optional) Install Traps Components Using Windows Msiexec

STEP 9 | Verify the installation is successful.

Verify a Successful Installation

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 41

Activate Traps Licenses
Before you can start using your Endpoint Security Manager to prevent malware and exploit attacks on
your endpoints, you must activate the Traps license for the number of endpoint agents you purchased.
When you add new licenses or renew existing licenses, the Customer Service Portal automatically adds the
licenses using your existing authorization code. As a result, you only need to activate a license if you are
doing so for the first time.

STEP 1 | Log in to the Palo Alto Networks Support Site after you receive the electronic fulfillment email.

STEP 2 | (New license only) Select Assets > Advanced Endpoint Protections > Activate New Auth-Code.

STEP 3 | (New license only) Enter your Traps Auth-Code (found in your electronic fulfillment email) in the
Authorization Code field and then Agree and Submit.

STEP 4 | In the License column, click the download icon ( ) to download the license key.

STEP 5 | Select the version of Traps for which this license key will be used (Pre 3.3, 3.3-3.4, or 4.0) and
then click Download.

STEP 6 | Save the license key to a location you can access from the Endpoint Security Manager.

STEP 7 | Proceed to Set Up the Endpoint Security Manager.

42 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

Set Up the Endpoint Security Manager
Endpoint Infrastructure Installation Considerations on page 43
TLS/SSL Encryption for Traps Components on page 43
Configure the MS-SQL Server Database on page 45
Install the Endpoint Security Manager Server Software on page 46
Install the Endpoint Security Manager Console Software on page 49

Endpoint Infrastructure Installation Considerations

To install or upgrade the ESM components consider the following:
The ESM Server and the ESM Console must run the same version.
The ESM Server and the ESM Console support mixed versions of Traps and are also backward
compatible with earlier versions. For example, an ESM Server and ESM Console can support a mix of
Traps agents running both the current release and the previous release.
Also see: Prerequisites on page 29.

TLS/SSL Encryption for Traps Components

Traps supports Transport Layer Security (TLS) versions 1.0 and 1.2 and Secure Sockets Layer (SSL) version
3.0. TLS/SSL, which is often referred to simply as SSL, enables clients to trust the identity of the server
and the transmission of data and secures communication by encrypting traffic. Traps uses TLS/SSL as the
communication protocol for securing traffic between the following components:
ESM Server and Traps agents
ESM Console and Administrative user
ESM Console and Panorama
ESM Console and WildFire
ESM Server and Panorama
ESM Server and WildFire
BITS upload folder and Traps agents
Traps supports TLS 1.2 on Mac endpoints, and provides dual support of TLS 1.2 and 1.0 on Windows
endpoints depending on the .NET library version:
Older Windows versions (such as Windows XP), which use .NET 3.5, support TLS 1.0
Newer Windows versions, which use .NET 4.5, support TLS 1.2

Enabling SSL for Traps components is a three step-process: First, you must request or issue a certificate
for each ESM Server and ESM Console. Note that traffic between the ESM Server and WildFire does not
require any additional configuration as the ESM Server encrypts traffic using the default trusted third-party
certificates that comes with Windows. Next, you enable SSL encryption during the installation of the ESM

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 43

 Server and ESM Console. Finally, depending on the type of certificate, you deploy the certificate to your
endpoints. For detailed instructions, see the following workflow:

STEP 1 | Request or generate a certificate for each ESM componentserver and consolewith a
purpose of server and client authentication. This certificate must be one that you can export
with a password.
The certificate can have a single name or a wildcard name. A single-name certificate requires the
Common Name (CN) of the certificate to match the fully qualified domain name (FQDN) of the ESM
component (for example, server.trapsserver.com). A wildcard-name certificate enables you to use
the same certificate for multiple ESM components that share the same sub-domain (for example,
*.trapsserver.com can be used for both server.trapsserver.com and console.trapsserver.com). Wildcard-
name certificates are also useful in deployments that use multiple ESM Servers.

If you use a wildcard-name certificate, it is recommended to configure the server name

using the FQDN when installing the ESM software.

Use one of the following basic approaches to obtain certificates:

Obtain a certificate from a trusted-party CAThe benefit of obtaining a certificate from a trusted
third-party certificate authority (CA), such as GoDaddy, is that the endpoint will already trust the
certificate because Windows updates and common browsers include root CA certificates from well-
known CAs in their trusted root certificate stores.
Obtain certificates from an enterprise CAEnterprises that have their own internal root CA can use it
to issue certificates for ESM components. The benefit is that domain-joined clients probably already
trust the enterprise CA. Another benefit of this method is that the private key does not leave the
ESM component.
Generate self-signed certificatesA self-signed certificate is a certificate that is signed by the same
entity whose identity it certifies. You can use IIS Manager or any other publicly available tool to
generate a self-signed certificate and then deploy it to the endpoint.

STEP 2 | Install the ESM software and enable SSL encryption (for full installation instructions, see Install
the Endpoint Security Manager Server Software and Install the Endpoint Security Manager
Console Software).
1. During the installation of both the ESM Server and ESM Console, select the External Certificate (SSL)
option and browse to the PKCS#12 or PFX file containing the certificate and private key.

If you do not already have a PKCS#12 or PFX file, use your preferred method to
generate it. For example, to do this in IIS, you can use the Export function in the MMC
Console > Certificates snap-in. When you export the certificate and private key, it is
required to set a password to protect the private key.
2. Enter the certificate password.
The installer binds the certificate to the selected agent-ESM communication port.
If you install Traps on the ESM Server and ESM Console, and use either a self-signed or an enterprise
CA certificate, you must also install the certificate on the server as described in the following step.

STEP 3 | (Certificates issued by an enterprise CA and self-signed certificates) Install the certificate in the
trusted root certificate store (CA certificates and self-signed certificates) of the computer
account. Certificates issued by a trusted third-party CA are automatically trusted by the
endpoint due to the chain of trust and do not require installation.
1. Add the certificate to the endpoint using one of the following methods:
Copy the certificates manually.
Include the certificate in the master image for new endpoints.

44 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 Use a centralized deployment method such as an Active Directory Group Policy Object (GPO).
2. Verify that the certificate appears in the appropriate store on the endpoint.

Configure the MS-SQL Server Database

The Endpoint Security Manager requires a database that is managed over the SQL Server platform (for
supported SQL Server versions, see Database Software Requirements). The Endpoint Security Manager
uses the database to store administrative information, security policy rules, information about security
events, and other information.
Before installing the Endpoint Security Manager, configure the SQL database with the required permissions.
When using Windows Authentication as the user authentication method, the owner must have rights to Log
on as a service and be a local administrator on the ESM Server.
The following procedure is recommended as a best practice for creating and configuring the MS-SQL Server
database.

STEP 1 | Create a new database.

1. Select SQL Server Management Studio from the Start menu.
2. Click Connect to open Microsoft SQL Server Management Studio.

3. Right-click Databases and then select New Database.

STEP 2 | Configure the database settings.

The database owner that you specify must already exist as a local or domain administrator.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 45

 1. Enter the Database name.
2. Select the database Owner:
1. Click the ellipsis ( ) button.
2. Enter the object name in the format [domain\user] or Browse to an object name.
3. Select Check Names to validate the database owner.
3. Click OK and then click OK again.

STEP 3 | Verify the database owner privileges.

1. Expand the database you created and then select Security > Users.
2. Double-click dbo.

3. Select the Owned Schemas page and then select db_owner.

4. Select the Membership page and then select db_owner.
5. Click OK.

Install the Endpoint Security Manager Server Software

To install the Endpoint Security Manager (ESM) Server software:

46 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

STEP 1 | Before you begin:
Verify that the server meets the requirements described in ESM Server Software Requirements.
Obtain an authorization code from your Palo Alto Networks Account Manager or reseller and
Activate Traps Licenses.
Obtain the software from https://support.paloaltonetworks.com (TOOLS > SOFTWARE UPDATES >
Filter By: Endpoint Security Manager).

STEP 2 | Initiate the ESM Server software installation. You can also install the ESM Server using Msiexec
(see Install Traps Components Using Windows Msiexec).
1. Double click the ESMCore installation file.
2. Click Next to begin the setup process.
3. On the End User License Agreement dialog, select the I accept the terms in the License Agreement
check box and then click Next.
4. Keep the default installation folder or click Change to specify a different installation folder and then
click Next.

STEP 3 | Specify the security level for communication between the ESM Server and the Traps agents.
To encrypt communication over SSL, use a server-client certificate file (PFX format) and supply the
password for decrypting the private key.

1. Specify the ESM Server port to use for access to the server or keep the default setting (2125).
2. Select the certificate configuration method:
External Certificate (SSL)Encrypt communication between the server and the agents over SSL
(default). Then Browse to the server-client certificate and enter the password required to decrypt
the private key.
No Certificate (no SSL)Do not encrypt communication between the server and the agents (not
recommended).
3. Click Next.

STEP 4 | Configure the settings that enable communication between the ESM Server and the database.
To set up access to the database, you must specify the authentication method and a user that has
administrative privileges to administer the database. The username (and password) that you enter
depend on the type of authentication method that you select: either Windows authentication
(recommended) or SQL server authentication.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 47

 1. Enter the fully qualified domain name or IP address of the database Server Name.
2. Enter the name of the Database Name. If your SQL Server uses an instance other than the default,
you must also include the instance name in the format <instance>/<databasename>.
3. Select the method of authentication and enter the account credentials. This account must also be
added as a database owner on the database server (for more information, see Configure the MS-SQL
Server Database).
Use Windows Authentication to authenticate using a Windows domain user account that has
privileges to administer the database server and enter the Domain\User (for example, mydomain
\administrator) and Password.
Use SQL Server Authentication to authenticate using a local user that has privileges to administer
the database and enter the Login and Password.
4. (4.0.1 only) To enable secure communication between the ESM Server and the database using TLS/
SSL 1.2:
1. Select Secure DB Connection (SSL). This option enables the ESM Server to encrypt
communication between the ESM Server and the database.
2. For even stricter security, select the option to Validate SQL Server Certificate Signer. This
enables the ESM Server to validate that the certificate the database presents matches a specific
certificate. For validation to succeed, you must import the database certificate into Trusted Root
Certification Authorities.

Secure communication between the ESM Server and the database is supported with
only SQL Server Enterprise or SQL Server Standard.
5. Click Next.

If one or more ESM Servers already connect to the database, the installer prompts
you to join the database cluster of ESM Servers. If you select Yes, the installer obtains
the remaining installation settings from the database. Skip to step 7 to complete the
installation.

STEP 5 | Set the password to uninstall the Traps software.

48 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 1. Enter and then confirm an uninstall password, which must be eight characters or more. You will be
prompted for this password any time you or a user tries to uninstall Traps software.

After installing the ESM Server software, you can Change the Uninstall Password at a
later date by creating an agent settings rule using the ESM Console.
2. Click Next.

STEP 6 | Import the Traps license. If you choose not provide a Traps license during installation, you will
have read-only access to the ESM Console until you add a valid Traps license.

1. Browse to the license file and then click Open. If you do not have a license, contact your Account
Manager, reseller, or go to https://support.paloaltonetworks.com.
The installer displays license details for the license file.
2. Click Next.

STEP 7 | Complete the installation.

1. Click Install.
2. When the installation is complete, click Finish.

Install the Endpoint Security Manager Console Software

You can install the ESM Console software on a dedicated server or on the same server as the ESM Server
software.

STEP 1 | Before you begin:

Verify that the system meets the requirements described in ESM Console Software Requirements.
Obtain the software from https://support.paloaltonetworks.com (TOOLS > SOFTWARE UPDATES >
Filter By: Endpoint Security Manager).

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 49

STEP 2 | Initiate the ESM Console software installation. You can also install the ESM Console using
Msiexec (see Install Traps Components Using Windows Msiexec).
1. Double click the ESMConsole installation file.
2. Click Next to begin the setup process.
3. Select the I accept the terms of the License Agreement check box and then click Next.

STEP 3 | Specify the installation folder for the ESM Console.

Keep the default installation folder or click Change to specify a different installation folder and then click
Next.

STEP 4 | Specify the security level for communication between the administrator and the ESM Console.
To encrypt communication over SSL, use a server-client certificate file (PFX format) and supply the
password for decrypting the private key.

1. Select the certificate configuration method:

No Certificate (no SSL)Do not encrypt communication to and from the ESM Console.
External Certificate (SSL)(Recommended) Encrypt communication to and from the ESM Console
over SSL (default). Then Browse to the server-client certificate and enter the password required
to decrypt the private key.
2. Click Next.

STEP 5 | Configure the settings that enable communication between the ESM Console and the
database.
To set up access to the database, you must specify the authentication method and a user that has
administrative privileges to administer the database. The username (and password) that you enter
depend on the type of authentication method that you select: either Windows authentication
(recommended) or SQL server authentication.

50 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 Use the same database settings that you entered during the ESM Server installation.

1. Enter the fully qualified domain name or IP address of the database Server Name.
2. Enter the name of the Database Name. If your SQL Server uses an instance other than the default,
you must also include the instance name in the format <instance>/<databasename>.
3. Select the method of authentication and enter the account credentials. This account must also be
added as a database owner on the database server (for more information, see Configure the MS-SQL
Server Database).
Use Windows Authentication to authenticate using a Windows domain user account that
has privileges to administer to the database server and enter the Domain\User (for example,
mydomain\administrator) and Password.
Use SQL Server Authentication to authenticate using a local user that has privileges to administer
the database and enter the Login and Password.
4. (4.0.1 only) To enable secure communication between the ESM Console and the database using TLS/
SSL 1.2:
1. Select Secure DB Connection (SSL). This option enables the ESM Console to encrypt
communication between the ESM Console and the database.
2. For even stricter security, select the option to Validate SQL Server Certificate Signer. This
enables the ESM Console to validate that the certificate the database presents matches a specific
certificate. For validation to succeed, you must import the database certificate into Trusted Root
Certification Authorities.

Secure communication between the ESM Console and the database is supported with
only SQL Server Enterprise or SQL Server Standard.
5. Click Next.

STEP 6 | Configure the settings for the administrative user who will access the ESM Console.

1. Choose the type of authentication you want to use:

Machine The ESM Console authenticates a user or group on the local machine.
Domain The ESM Console authenticates a user or group belonging to the domain of the
machine.
2. Enter the account name for the user who will administer the server and then click Next.

STEP 7 | Specify the forensic folder destination.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 51

 1. Keep the default forensic folder path or Browse to an alternate folder location and click OK.

The installer automatically enables BITS for this folder.

2. Click Next.

STEP 8 | Complete the installation.

1. Click Install.
2. When the installation is complete, click Finish.

STEP 9 | Launch the ESM Console using one of the following methods:
Double-click the icon on the desktop.
Open the program from the Start > All Programs menu.

STEP 10 | Enter your administrator credentials.

If you did not supply your Traps license during the ESM Server installation, the ESM Console is available
in read-only mode. To enable read-write access to the ESM Console, you must add a valid Traps license
(see Add a Traps License Using the ESM Console).

52 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

Set Up the Endpoints
To set up Traps on the endpoints within your organization, see the following topics:
Recommended Traps Deployment Process
Traps Installation Options
Install Traps on Windows Endpoints
Install Traps Components Using Windows Msiexec
Install Traps on Mac Endpoints

Recommended Traps Deployment Process

The Traps software is typically deployed to endpoints across a network after an initial proof of concept
(POC), which simulates the corporate production environment. During the POC or deployment stage,
you analyze security events to determine which are triggered by malicious activity and which are due to
legitimate processes behaving in a risky or incorrect manner. You also simulate the number and types of
endpoints, the user profiles, and the types of applications that run on the endpoints in your organization
and, according to these factors, you define, test, and adjust the organizations security policy.
The goal of this multi-step process is to provide maximum protection to the organization without interfering
with legitimate workflows.
After the successful completion of the initial POC, we recommend a multi-step implementation in the
corporate production environment for the following reasons:
The POC doesn't always reflect all the variables that exist in your production environment.
There is a rare chance that the Traps agent will affect business applications, which can reveal
vulnerabilities in the software as a prevented attack.
During the POC, it is much easier to isolate issues that appear and provide a solution before full
implementation in a large environment where issues could potentially affect a large number of users.
A multi-step deployment approach ensures a smooth implementation and deployment of the Traps solution
throughout your network. Use the following steps for better support and control over the added protection.

Step Duration Plan

1. Install Traps on endpoints. 1 week Install the Endpoint Security Manager (ESM), including
an MS SQL database, ESM Console, and ESM Server, and
install the Traps agent on a small number of endpoints (3 to
10).
Test normal behavior of the Traps agents (injection and
policy) and confirm that there is no change in the user
experience.

2. Expand the Traps 2 weeks Gradually expand agent distribution to larger groups that
deployment. have similar attributes (hardware, software, and users). At
the end of two weeks you can have Traps deployed on up
to 100 endpoints.

3. Complete the Traps 2 or more Broadly distribute the Traps agent throughout the
installation. weeks organization until all endpoints are protected.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 53

 Step Duration Plan

4. Define corporate policy Up to 1 Add protection rules for third-party or in-house

and protected processes. week applications and then test them.

5. Refine corporate policy Up to 1 Deploy security policy rules to a small number of endpoints
and protected processes. week that use the applications frequently. Fine tune the policy as
needed.

6. Finalize corporate policy A few Deploy protection rules globally.

and protected processes. minutes

Traps Installation Options

You can install Traps in the following ways:
Install from the endpointIn situations where you need to install Traps on a small number of endpoints,
you can manually install the Traps software using the workflow described in Install Traps on Windows
Endpoints and Install Traps on Mac Endpoints.
Install using Windows MsiexecTo install Traps from the command line, use the Msiexec utility to
perform operations on a Windows Installer as described in Install Traps Components Using Windows
Msiexec. Using MSI deployment software is recommended to install Traps across an organization or a
large number of endpoints.
Install using application deployment softwareYou can also use the Msiexec installation options with
MSI deployment software such as a Policy System Center Configuration Manager (SCCM), Altiris, or
Group Policy Object (GPO).
Install using an action ruleIf the endpoints in your organization already have Traps installed, you can
upgrade the Traps software by configuring an action rule as described in Uninstall or Upgrade Traps on
the Endpoint.

Install Traps on Windows Endpoints

Before installing Traps on a Windows endpoint, verify that the system meets the requirements described in
Traps Software Requirements.

STEP 1 | Initiate the Traps software installation. You can also install Traps using Msiexec (see Install
Traps Components Using Windows Msiexec).

The version(s) of Traps that you install on your endpoints must be the same as or older
than the ESM Server and ESM Console version.

1. Obtain the software from your Palo Alto Networks Account Manager, reseller, or from https://
support.paloaltonetworks.com.
2. Unzip the zip file and double click the Traps installation file; choose either the x64 (64-bit) or x86 (32-
bit) version depending on your endpoints OS.
3. Click Next.
4. Select I accept the terms in the License Agreement and then click Next.

STEP 2 | Configure the Traps agents to connect to the ESM Server.

1. Provide the following information for the ESM Server:

54 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 Host NameEnter the FQDN or IP address of the ESM Server.
PortChange the port number, if required (default is 2125).
Select SSL to encrypt communication to the server (default) or No SSL to not encrypt
communication (not recommended).
2. Click Next > Install.

STEP 3 | Click Finish.

We recommend that you restart the endpoint after completing the installation.

Install Traps on Mac Endpoints

Before you can install or upgrade Traps for Mac, you must download the software from the Support portal
and then generate an installation package from the ESM Console. The installation package specifies the
IP address and port settings the agent will use to connect to the ESM Server. To generate the installation
package you must be assigned a role which enables the Installation Package privilege. Otherwise, this
feature is disabled (hidden completely from view) or read-only.
Use the following instructions to create and install the package directly on the endpoint:

STEP 1 | Download the Traps for Mac software ZIP file from the Supportportal.
The Traps for Mac software version must not exceed the current ESM version. For example, if you use
ESM 4.0.0, you cannot install Traps for Mac 4.0.2. Instead use Traps for Mac 4.0.0.

STEP 2 | Generate the installation package. This package specifies the ESM Server or ESM Servers to
which the agent can connect for the first time. After the first successful connection, the agent
receives a list of all available ESM Servers to use for future connections.
1. From the ESM Console, select Settings > Agent > Installation Package.
2. From the action menu , select Generate Package.
3. Select the ESM Server to which the Traps agent will first connect. The ESM Console automatically
populates the list with any enabled ESM Servers (to review your servers, select Settings > ESM >
Multi ESM).

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 55

 If you use a multi-ESM deployment, we recommend that you select All to include all available ESM
Servers with the installation package. This ensures the agent can try other ESM Servers when the
primary ESM Server is unreachable.
If you only use one ESM Server or prefer to force the agent to establish the initial connection with
a specific ESM Server (such as in a regional deployment), select the specific ESM Server from the
list.
4. Browse to the Traps for Mac software package you downloaded in the first step.
5. Click Generate.

STEP 3 | Verify the status of the installation package.

When the installation package is available, the ESM Console displays a new record in the Installation
Package table indicating the time the package was created and a link to Download the installation
package.
To view the status of the installation package, you can also filter the ESM logs (Monitor > ESM >
Logs) for a Report Type of Installation Package. The log message indicates whether the ESM Console
successfully generated the package.

STEP 4 | When the installation package has finished generating, save the installation package.
1. Select Settings > Agent > Installation Package.
2. Select the Download link next to the installation package and save it to a location that you can reach
from the Mac endpoint.

STEP 5 | Install Traps for Mac on the endpoint. Alternatively, you can use your preferred software
deployment tool to distribute the installation package to multiple Mac endpoints.

56 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 To install Traps for Mac on the endpoint using the installation package:
1. Open the installation package and double click the Traps.pkg file to launch the installer.
2. Click Continue to proceed with the installation.
3. If prompted to confirm the destination, click Continue.
4. Click Install to begin the installation.
5. Enter the Username and Password credentials of the administrator with access to install software on
the endpoint, and then click Install Software.

STEP 6 | To use SSL for secure communication between the Traps agent and the ESM Server, add the
trusted root CA certificate of the ESM Server on the Mac endpoint.

You must have administrative privileges on the endpoint to perform this step.

1. Export the trusted root CA certificate from the ESM Server and copy it to a location which you can
access from the Mac endpoint.
2. From a command prompt, use the following command to add the certificate with Always Trust
settings:

sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/

System.keychain <full_path_to_certificate_in_PEM_or_DER_format>
3. To verify that the trusted root CA certificate was added to the Keychain library, open Keychain
Access (Applications > Utilities > Keychain Access) and view the System keychains.

STEP 7 | After the installation completes, verify your connection.

1. To open the Traps console, click the Traps icon in the menu bar, and select Open Console.
2. Click Check In Now to initiate a connection with the ESM Server. If successful, the Last Check-In
field updates to display the recent check-in date and time.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 57

Install Traps Components Using Windows
Msiexec
As an alternative to using the Windows installers, you can use Windows Msiexec to install the ESM Server
and ESM Console on Windows servers, and the Traps agent on Windows endpoints. Msiexec provides
full control over the installation process and allows you to install, modify, and perform operations on a
Windows Installer from the command line interface (CLI). You can also use MSIXEC to log any issues
encountered during installation.
Additionally, to install Traps on multiple endpoints for the first time, you can use Msiexec in conjunction
with a System Center Configuration Manager (SCCM), Altiris, Group Policy Object (GPO), or other
MSI deployment software. After successfully installing Traps on an endpoint and establishing an initial
connection with the ESM Server, you can upgrade or uninstall Traps from one or more endpoints by
creating an action rule (see Uninstallor Upgrade Traps on the Endpoint).
Before installing Traps, verify that the system meets the requirements described in Traps Software
Requirements.
Install Traps Components
Uninstall Traps Components

Install Traps Components

Use the following workflow to install Traps components (the ESM Server, the ESM Console, and the Traps
agent) using Msiexec.

STEP 1 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 2 | Run the msiexec command followed by one or more of the following options or properties:
Install, display, and logging options:
/i <installpath>\<installerfilename>.msiInstall a package. For example,
msiexec /i c:\install\traps.msi.
/qnDisplays no user interface (quiet installation). At minimum, you must also specify the host
server name or IP address using the CYVERA_SERVER property.
/L*v <logpath>\<logfilename>.txtLog verbose output to a file. For example, /L*v c:
\logs\install.txt.
For a full list of Msiexec parameters, see https://www.microsoft.com/resources/documentation/
windows/xp/all/proddocs/en-us/msiexec.mspx
Public properties:
CYVERA_SERVER=<servername>Primary host server name or IP address (default is
ESMserver)
CYVERA_SERVER_PORT=<serverport>Primary host server port (default is 2125)
USE_SSL_PRIMARY=[0|1](Quiet installation only) Set encryption preferences on the primary
server by specifying 0 to not use SSL (not recommended) or 1 to use SSL (default)

58 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

 For example, to install Traps without a user interface, specify a server named TrapsServer that does not
use SSL encryption on a port other than the default (for example on port 5212, a non-standard port), and
create an installation log in C:\temp, enter the following:

msiexec /i c:\install\traps.msi /qn CYVERA_SERVER=TrapsServer

USE_SSL_PRIMARY=0 CYVERA_SERVER_PORT=5212 /l*v C:\temp\trapsinstall.log

We recommend that you restart the device after completing the installation.

Uninstall Traps Components

Use the following workflow to uninstall Traps components (the ESM Server, the ESM Console, and the
Traps agent) using Msiexec.

STEP 1 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 2 | Run the msiexec command followed by one or more of the following options or properties:
Uninstall and logging options:
/x <installpath>\<installerfilename>.msiUninstall a package. For example,
msiexec /x c:\install\traps.msi.
/L*v <logpath>\<logfilename>.txtLog verbose output to a file. For example, /L*v c:
\logs\uninstall.txt.
For a full list of Msiexec parameters, see https://www.microsoft.com/resources/documentation/
windows/xp/all/proddocs/en-us/msiexec.mspx
Public properties:
UNINSTALL_PASSWORD=<uninstallpassword>Specify the administrator password.
To uninstall Traps and log verbose output to a file called uninstallLogFile.txt, enter the following
command:

msiexec /x c:\install\traps.msi UNINSTALL_PASSWORD=[palo@lt0] /l*v c:

\install\uninstallLogFile.txt

You must specify the UNINSTALL_PASSWORD property to successfully uninstall a package.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 59

Verify a Successful Installation
You can verify the success of the ESM server and endpoint installations by verifying connectivity between
the server and each endpoint from both sides of the connection.
Verify Connectivity from the Endpoint on page 60
Verify Connectivity from the ESM Console on page 60

Verify Connectivity from the Endpoint

After successfully installing Traps, the Traps agent should be able to connect to the server that is running
the Endpoint Security Manager.

STEP 1 | Launch the Traps Console:

From the Windows taskbar, double-click the Traps icon (or right-click the icon and select Console).
From the Mac taskbar, click the Traps icon and select Open Console.
Run CyveraConsole.exe from the Traps installation folder.

STEP 2 | Verify the status of the server connection. If Traps is connected to the server, the Connection
status reports that the connection is successful. If the Traps agent is unable to establish a
connection with the primary or secondary server, the Traps Console reports a disconnected
status.

STEP 3 | Verify Connectivity from the ESM Console.

Verify Connectivity from the ESM Console

After successfully verifying that the endpoint can reach the ESM Server, verify that the endpoint appears in
the list of computers on the Monitor > Agent > Health page of the ESM Console.

STEP 1 | From the ESM Console, select Monitor > Agent > Health.

60 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure

STEP 2 | Locate the name of the endpoint in the list of computers and verify the status. An icon
indicates that Traps is running on the endpoint. To view additional details about the endpoint,
select the endpoint row.

TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure 61

62 TRAPS ADMINISTRATOR'S GUIDE | Set Up the Traps Infrastructure
VDI
> VDI Overview
> VDI Installation Considerations
> Set Up Traps in a VDI Environment Overview
> Set Up the Golden Image
> Configure Traps Settings
> Tune and Test the VDI Policy

63
64 TRAPS ADMINISTRATOR'S GUIDE | VDI
VDI Overview
Your rapidly changing business environment demands a flexible infrastructure to support the evolving
desktop, application, and data access requirements of your staff. By implementing a virtual desktop
infrastructure (VDI), you can empower your employees to work independent of location using a variety of
devices.
An individuals user interface in a virtualized environment is called a virtual desktop. Usually, the virtual
desktop is stored on a remote server rather than locally. Desktop virtualization software separates the
physical machine from the software and presents an isolated operating system for users. When a user logs
on to a VDI infrastructure, the infrastructure supplies the user a hosted desktop image.
A VDI environment usually involves running user desktops inside virtual machines that are hosted on
datacenter servers. In a VDI environment, each user is allotted a dedicated VM that runs a separate
operating system. This is different than a specific VM to which users can connect and from virtualized
applications that run in a regular environment.
Although a VDI solution presents many desktop security advantagesincluding centralized control, reduced
complexity, and efficient management of user access and privilegesit is critical to ensure that the entire
VDI is secure. Securing this new, centralized environment is increasingly difficult. A single IP address can
represent thousands of different users all accessing their applications and data using a variety of devices.
Users can also have access to other applications in your data center besides their virtual desktop. By using
Traps to secure your VDI environment, you can take advantage of the following benefits:
Advanced endpoint protection as part of the Traps solution that prevents sophisticated vulnerability
exploits and unknown malware-driven attacks.
A highly scalable, lightweight Traps agent that uses an innovative new approach for defeating attacks
without requiring any prior knowledge of the threat.
Software that is not dependent on scanning or maintaining external updates.
The following topics describe the VDI deployments in more detail:
Virtualized Applications and Desktops
VDI Modes

Virtualized Applications and Desktops

To secure endpoints in a VDI environment, you can install Traps on a variety of virtualized applications
and desktops. To determine which versions are supported, refer to the Traps section of the Palo Alto
Networks Compatibility Matrix.

VDI Modes
A VDI environment can run in the following modes:
Non-Persistent VDI Mode
Persistent VDI Mode

Non-Persistent VDI Mode

In non-persistent VDI mode, each session is temporary. When a user accesses a non-persistent virtual
desktop and logs out at the end of the day, none of their settings or dataincluding desktop shortcuts,
backgrounds, or new applicationsare preserved. At the end of a session, the virtual desktop is wiped
clean and reverts back to the original pristine state of the master image. The next time the user logs in, they
receive a fresh image.

TRAPS ADMINISTRATOR'S GUIDE | VDI 65

 When you install Traps in non-persistent VDI mode, the machine exhibits the following behavior:
LicensingWith non-persistent virtual desktops, the Traps agent receives a licenses from the pool of
available endpoint licenses. The ESM automatically revokes the license when the user logs off, the agent
is uninstalled, the session ends, or when the VDI is inactive for two consecutive heartbeats plus 25
minutes. Revoking the license frees it up for use by another Traps agent.
ConnectivityWhen the user logs on to the VDI machine, the Traps agent connects to the ESM Server
to receive the license and to obtain the relevant updates. The Traps agent continues to communicate
with the ESM Server throughout the life cycle of the VDI instance. The Traps agent only protects the
machine when a user is logged in. When the user is logged out, the Traps agent disconnects from the
ESM Server. During this time, Traps does not receive updated policies or verdicts, and does not send
heartbeat communication to the ESM Server.
Verdict updatesWhen you identify the master image as a VDI, the ESM tracks all VDI machines that
are spawned from the master image. When a verdict for a file that was seen on the master image
changes in the ESM Server cache, the ESM Server sends the changed verdict to all machines that were
spawned by the original VDI machine, regardless of whether these machines opened the relevant file or
not.
StorageWith non-persistent VDI, many VDI solutions allow you to choose either non-persistent or
persistent storage. With non-persistent storage, the user settings and data are stored for the length of
the session and are wiped clean when the session ends or a user logs out. With persistent storage, you
can select folders or specific locations that persist after the session ends.

Persistent VDI Mode

A persistent virtual desktop is a one-to-one mapping of a virtual machine to a user and each virtual desktop
stores and operates using its own disk image. In this model, a persistent desktop keeps all configuration
changes and personalization settings a user makes during a session (such as, background changes, saved
shortcuts, and newly installed applications).
When the user ends a session and logs out of the virtual desktop, the virtual machine preserves any and all
changes and the next time the user logs on to the desktop, those changes are still in effect.
The process of deploying Traps in persistent VDI mode is very similar to deploying Traps on a standard
server or workstation. To install the Traps agent, you can install the Traps software on the golden imagee
and run it on the virtual desktop the same as any other VDI application. When you install Traps in persistent
VDI mode, the machine exhibits the following behavior:
LicensingJust as in a standard deployment, Traps receives an agent license from the available pool
of licenses. Traps retains the license throughout the life cycle of the VDI instance, however, if the VDI
instance is inactive for the length of time specified by the License Revocation Period (by default 90
days), the ESM Server automatically revokes the license thereby freeing it up for use by another Traps
agent.
ConnectivityWhen the user logs on to the VDI instance, the Traps agent connects to the ESM Server
to receive the license and to obtain the relevant updates. The Traps agent continues to communicate
with the ESM Server throughout the life cycle of the VDI instance and continues to protect the machine
when a user logs out. During this time, Traps continues to receive updated policies or verdicts, and sends
heartbeat communications to the ESM Server.
Verdict updatesAs with a standard (non-VDI) endpoint, the ESM Server sends verdict updates to
machines in persistent VDI mode only if the file ran on the endpoint previously.
StorageWith a persistent VDI, each user runs a desktop session independently. The settings for users
are typically saved to the logical desktop while the user data is stored on a separate logical drive. Both
the settings and data remain after the user session ends.

66 TRAPS ADMINISTRATOR'S GUIDE | VDI

VDI Installation Considerations
Optimize the default session policy on the VDI test pool to assure stable session spawning when the VDI
is recompiled.
Every new VDI creation will start with the initial policy as configured on the golden image. When the
golden image is active and communicating with the ESM Server, test the policy on the VDI test pool and
push it to the VDI Traps agents. Then fine tune the policy.
Issues on restricted non-persistent sessions are harder to investigate because there is no forensic data
after the session closes. Consider the following options to ensure forensic data is available:
Configure an agent setting rule on all non-persistent hostnames to enable the Traps agent to Send
the memory dumps automatically.
Reproduce the issue on a persistent session to collect logs and memory dumps and allow additional
troubleshooting.
Set a fixed number of session hostnames (not random) as licenses are issued by the ESM according to
hostname. All naming conventions are supported.
The ESM Server automatically revokes a license when an agent logs off of a VDI session. In cases where
the VDI session is not properly closed, the ESM server waits for a timeout before automatically revoking
the license to make it available for other agents. If another VDI session needs to use the license before
the license revocation period expires, use the ESM Console to forcefully Remove an Endpoint from the
ESM Console. This action returns the license to the license pool and removes the VDI session from the
ESM Console.
After you upgrade the Traps agent on the golden image from Traps 3.4 or earlier releases, you must
mark the golden image as a VDI (see Configure the Golden Image).

TRAPS ADMINISTRATOR'S GUIDE | VDI 67

Set Up Traps in a VDI Environment Overview
Use the following workflow to set up Traps in a VDI environment.

STEP 1 | Review the installation considerations and prerequisites of the software.

Endpoint Infrastructure Installation Considerations
Prerequisites
VDI Installation Considerations

STEP 2 | Configure the database server.

Database Software Requirements
Configure the MS-SQL Server Database

STEP 3 | Set up the ESM Server.

ESM Server Software Requirements
Install the Endpoint Security Manager Server Software

STEP 4 | Set up the ESM Console.

ESM Console Software Requirements
(Optional) TLS/SSL Encryption for Traps Components
Install the Endpoint Security Manager Console Software

STEP 5 | Allocate additional licenses to the general agent license pool, if needed.
Add a Traps License Using the ESM Console

STEP 6 | Install Traps on the golden image with the default policy.
Configure the Golden Image

STEP 7 | Configure additional Traps settings based on your VDI deployment scenario.
(Recommended) Configure Traps for a Non-Persistent Storage Scenario
or
Configure Traps for a Persistent Storage Scenario

STEP 8 | Configure the initial policy for the golden image.

If your organization supports a mixed environment of VDI and non-VDI instances, apply the Condition
for VDI Machine to each rule. This ensures that the rules apply to only the VDI instances.
Configure Traps to clear all prevention data and history from the agent. To do this, create an agent
action rule (see Manage Data Collected by Traps).
Enable Traps to send memory dumps automatically. To do this, create an action rule (see Define
Memory Dump Preferences).

STEP 9 | Deploy the VDI test pool.

Tune and Test the VDI Policy

68 TRAPS ADMINISTRATOR'S GUIDE | VDI

STEP 10 | Recompile the golden image.
1. Restart the golden image.
2. Verify that the golden image can connect to the ESM Server.
3. Shut down the golden image and then recompile it.

TRAPS ADMINISTRATOR'S GUIDE | VDI 69

Set Up the Golden Image
To set up a virtual machine, you must configure a template policy known as a golden image. The settings in
the golden image are used to create each new VDI instance. To configure the policy for the golden image,
first collect all portable executable (PE) files using the Windows Sysinternals utility called Sigcheck. Then
you can use the Traps VDI tool (either the graphical interface or the command-line interface) to create a
WildFire cache file containing the verdicts for all the PE files detected on the golden image including any
that WildFire determined to be malicious. By replacing the original cache file with the new file, you can
avoid many initial unknown verdicts on the VDI instance. You can also use the Traps VDI tool to identify the
golden image as a VDI instance in the Windows registry.
After identifying the golden image as a VDI instance, the ESM Console will recognize the client and use the
floating license model to allocate a license.
Prerequisites for Configuring the Golden Image
Use the Traps VDI Tool to Configure the Golden Image
Traps VDI Tool CLI

Prerequisites for Configuring the Golden Image

Use the following workflow to prepare the golden image.

STEP 1 | Install any software that you plan to have on the VDI instances.

If after completing the process to configure the golden image, you need to install
additional software, you must recreate the WildFire cache file using the Traps VDI tool.
This ensures that Traps obtains verdicts for the new software.

1. Install Traps on the golden image (see Install Traps on Windows Endpoints).
2. Install additional required software.

STEP 2 | Verify that the Traps agent on the golden image can access the ESM Server.
On the Traps agent, click Check In Now to obtain the latest verdicts from the ESM Server. If the ESM
Server is reachable, the status on the console displays Connected.

STEP 3 | Use Cytool to stop Traps services (including local analysis) on the endpoint.
See Start or Stop Traps Runtime Components on the Endpoint. Note that the Traps Reporting Service
remains running.

STEP 4 | Collect all PE files available on the golden image using Sigcheck. This tool creates a file for you
to use as input for the Traps VDI tool.
1. Download Sigcheck (a Windows Sysinternals utility) from https://technet.microsoft.com/en-us/
sysinternals/bb897441.aspx.
2. Open a command prompt as an administrator and navigate to the directory to which you downloaded
Sigcheck.
3. Run Sigcheck recursively to find executable files regardless of extension and output the hashes in
comma-separated format to a folder and file name of your choice.

The Sigcheck parameters are subject to change. To display available usage

guidelines, run the sigcheck command without options.

The following examples show the commands you can use in two different versions of Sigcheck:

70 TRAPS ADMINISTRATOR'S GUIDE | VDI

 Sigcheck version 2.54

sigcheck /s /c /e /h C:\ > C:\temp\outfilename.csv

Sigcheck version 2.2

sigcheck /accepteula -s -h -e -c C:\ > C:\temp\outfilename.csv

Configure the Golden Image

To avoid starting your VDI with a cache of unknown executable files, use the VDI tool to request verdicts
for all known PEs on your golden image.

There are two versions of the VDI tool: 32-bit and 64-bit. Use the version of VDI tool that
matches the VDI architecture.

STEP 1 | Before you begin:

See Prerequisites for Configuring the Golden Image.
To ensure that the Traps VDI tool can obtain verdicts for all unknown files, we also recommend that
you verify the ESM Server can access WildFire (https://wildfire.paloaltonetworks.com).

STEP 2 | Use the Traps VDI Tool to obtain verdicts for all PE files (collected in 4).

A command-line version of the Traps VDI tool is also available. See Traps VDI Tool CLI.

The Traps VDI tool communicates with the ESM Server to request any verdicts the server has stored
in its server cache. The Traps VDI tool then creates a WildFire cache which can contain any of the
following verdicts for each hash: malicious, benign, or unknown. A hash has an unknown verdict if the
ESM Server has not submitted the sample to or received an updated verdict from WildFire.

1. Open the Traps VDI tool.

2. Configure the following settings:

TRAPS ADMINISTRATOR'S GUIDE | VDI 71

 ESM server addressIP address or hostname of the ESM Server used for checking the hashes.
This server must be able to connect to WildFire.
ESM server SSL bindingSet the value to True if the server uses an SSL binding (default is False).
Input filePath of the comma-separated value (CSV) file that you created in 4 that contains all the
hashes.
PasswordEnter the agent's uninstall password. This password is required to read data from
protected locations when Service Protection is enabled.
ESM server portPort number for the ESM server (default is 2125).
Hash bulk sizeHashes will be reported to the server in fragments of this size (default is 300;
range is 1 to 500).
Tool timeout in hoursTime in hours to wait for the Traps VDI tool to finish obtaining verdicts.
If the Traps VDI tool exceeds the timeout, it stops generating the WildFire cache (default is 24
hours).
Wait for WildFire verdictsSelect False to skip uploading unknown hashes and creating the
cache file.
WildFire verdicts check intervalTime in minutes between inquiries to check for new verdicts
(default is 10).
Write malware to cacheSelect True to write malware verdicts to the cache file (default is False).
3. Click Start.
The Traps VDI tool uses the results of the verdict lookup to create the WildFire cache of verdicts.
4. Wait two hours for the ESM Server to query WildFire for any unknown verdicts and then proceed
to the next step. During this time, the ESM Server populates the server cache with any verdicts for
hashes WildFire has previously analyzed.

STEP 3 | Submit any remaining unknown executable files for analysis.

The Traps VDI tool uploads the files to the ESM Server which then sends the files to WildFire for
inspection. After the ESM Server submits the samples, the server queries WildFire every 10 minutes for
updated verdicts. The entire process can take up to 24 hours to obtain verdicts for all unknown files.
1. Open the Traps VDI tool.
2. Change the Wait for WildFire verdicts setting to True. This setting enables the Traps VDI tool to
send any remaining unknown executable files and wait for the WildFire verdict.
3. Click Start.
After the verdict lookup is complete, the Traps VDI tool recreates the WildFire cache containing the
hashes and their verdicts.

STEP 4 | Review any PE files that WildFire determined to be malicious.

1. From the ESM Console, go to the Policies > Malware > Hash Control page.
2. Use the Hash Control search conditions to identify malware detected on the golden image:

3. Perform one of the following actions for each malicious PE file:

Remove the malicious PE file from the golden image.
If you believe the WildFire verdict is incorrect:
1. Override the verdict for the PE file on the Hash Control page of the ESM Console.
2. To ensure that the Traps agent receives any verdict overrides, run the Traps VDI tool with
the Wait for WildFire verdicts setting to True. This enables the Traps VDI tool to obtain the
changed verdicts from the ESM Server and typically finishes within ten minutes.

STEP 5 | Identify the golden image as a VDI instance. The method by which you identify the golden
image depends on the VDI mode.

72 TRAPS ADMINISTRATOR'S GUIDE | VDI

 Non-persistent modeIn non-persistent mode, you must mark the master image from the Traps VDI
tool. This ensures that the ESM associates the spawned machines with the master to facilitate verdict
updates for files that were found on the master. In addition, marking the master image from the Traps
VDI tool ensures the ESM revokes licenses when the session is inactive or ends.
1. On the golden image, open the Traps VDI tool.
2. Click the Menu in the top left corner and select Mark as VDI.
3. Enter the Traps uninstall password and click Mark as VDI.
The tool identifies the machine in the Windows registry as a VDI instance.
Persistent modeIn persistent mode, you must configure the machine as a golden image from the ESM
Console. This ensures the ESM treats any spawned sessions as independent endpoints and prevents the
ESM from revoking the license according to the guidelines for non-persistent mode.
1. Select Monitor > Agent > Health.
2. Select the name record for the VDI instance.
3. From the action menu , select Set As Master Image. The ESM Console updates the type of
endpoint to Master Image.

Traps VDI Tool CLI

The Traps VDI Tool requests verdicts for all the PE files detected on the golden image and outputs the
verdicts to a WildFire cache file. You can use the command-line interface (CLI) version of the Traps VDI
Tool to automate the creation of this file.
Consider the following usage guidelines for the Traps VDI Tool CLI:
If you run the Traps VDI Tool with at least one command line argument, it will run in unattended mode
(no user interface). If you issue the TrapsVdiTool command without any arguments, the user interface
opens.
By default, arguments with flag valuesyes or nodefault to yes. Therefore, to use the default value,
you can specify the argument without the value (e.g. use -ssl instead of -ssl:y).
If a path value contains one or more spaces, surround the entire path argument with double quotes, for
example: "-i:c:\temp\sig file.csv"
You cannot use the Traps VDI Tool to check hashes and mark the computer as a VDIusing the -m
argumentat the same time. Therefore, you must execute these actions separately.
To write output to a log file, use the > redirect to send output to a filename of your choice, for example:
TrapsVdiTool -m > TrapsVDI.log

STEP 1 | Download and unzip the Traps VDI Tool on the golden image.

STEP 2 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 3 | Navigate to the folder that contains the Traps VDI Tool CLI:

C:\Users\Administrator>cd C:\TrapsVDItool

STEP 4 | View usage and options for the DB Configuration Tool:

TRAPS ADMINISTRATOR'S GUIDE | VDI 73

 c:\TrapsVDItool> TrapsVdiTool -help
TrapsVdiTool -i:path [-o:path] [-e:address] [-p:port] [-ssl] [-b:size]
[-to:
hours] [-v] [-c:minutes] [-r] [-m] [-silent] [-s:password]
TrapsVdiTool -m:password

-help Displays the help screen.

-silent Perform tasks in silent mode (no log displays).

-i:path Input file (must be CSV). Specifies the path of the

file
produced by the sigcheck tool. No default. Surround the entire path
argument with double quotes to specify a path that contains spaces, for
example:
"-i:c:\temp\sig file.csv".
-o:path Output file path. Specifies the full file path.
Default:
current directory. Surround the entire path argument with double quotes to
specify a path that contains spaces, for example:
"-o:C:\temp folder\WildFireCache.xml".
-e:address Specifies the ESM server address (FQDN or IP).
Default:
ESMSERVER
-p:port Specifies the ESM server port. Default: 2125
-ssl[:flag] ESM server SSL binding. Indicates use of secured
server connection. 'y' for using SSL, 'n' otherwise. Default: n
-b:size Hash bulk size. Specifies the bulk size for hash
transfers. Default: 300
-to:hours Tool timeout in hours. Limits execution time to
specified number of hours. Default: 24
-v[:flag] Wait for WildFire verdicts. Indicates if should wait
for
WildFire verdicts. 'y' for waiting, 'n' - otherwise. Default: n
-c:minutes Specifies WildFire verdicts check interval in
minutes. Default: 10
-r[:flag] Instructs the tool to continue from where it left
off previously. Default: n
-w[:flag] Write malware verdicts to cache. Default: n
-g[:flag] Write grayware verdicts to cache. Default: y
-s:password The agent's uninstall password. Required to read
data from protected locations when Service Protection is enabled.
-m: Instructs the Traps VDI Tool to identify this computer as VDI
using
the uninstall password and skips performing hash checks. No default. Do not
use
this option if you want the Traps VDI Tool to perform hash checks.

CLI execution examples.

TrapsVdiTool -i:c:\temp\sig.csv -e:192.168.70.100 -ssl -to:1

Submits the list of executable files in the 'c:\temp\sig.csv' input
file t
o the ESM Server with the IP address 192.168.70.100
over a secured connection and limits the execution time to 1 hour.
All the other arguments will be set to their default values.

TrapsVdiTool "-i:c:\temp\sig file.csv" -v -w

Submits the list of executable files in the 'c:\temp\sig file.csv'
input f
ile to the default ESMServer and waits for all

74 TRAPS ADMINISTRATOR'S GUIDE | VDI

 WildFire verdicts before writing them to cache.

TrapsVdiTool -s:password -m
Identify the computer as VDI without performing hash checks.

STEP 5 | Specify arguments to create the WildFire cache file or to mark the golden image as a VDI
instance. For example:
TrapsVdiTool -i:c:\temp\sig.csv -e:192.168.70.100 -ssl -to:1

The Traps VDI Tool requests verdicts for the hashes in the c:\temp\sig.csv input file, from the ESM
Server with the IP address 192.168.70.100, over a secure connection, and limits the execution time
to 1 hour.
All the other arguments are set to their default values.
TrapsVdiTool "-i:c:\temp\sig file.csv" -v -w

The Traps VDI Tool requests verdicts for the hashes in the c:\temp\sig file.csv input file from
the default ESM Server, and creates the cache file only after it has received verdicts for all hashes.
Note the file path is enclosed in quotes because the filename contains a space.
TrapsVdiTool -m:password

The Traps VDI Tool identifies the golden image as a VDI instance without performing hash checks.

TRAPS ADMINISTRATOR'S GUIDE | VDI 75

Configure Traps VDI Settings
Before configuring additional Traps settings, you must Set Up the Golden Image. Then configure settings
according to your type of VDI deployment:
Configure Traps for a Non-Persistent Storage Scenario
Configure Traps for a Persistent Storage Scenario

Configure Traps for a Non-Persistent Storage Scenario

In a non-persistent storage scenario, you must configure the Traps service dependency on the
Spooler Service (or any of the other last loading services) per the following Microsoft KB http://
support.microsoft.com/kb/193888.

STEP 1 | Open the Windows Registry and locate the CyveraService key in HKEY_LOCAL_MACHINE
\SYSTEM\CurrentControlSet\Services\

STEP 2 | Double-click the DependOnService multistring.

STEP 3 | Add Spooler to the Value data list.

STEP 4 | Click OK.

Configure Traps for a Persistent Storage Scenario

If utilizing a VDI machine to offload to a local storage area, you need to make additional changes to the
golden image, including changes to the Traps service properties and the startup and shutdown scripts.
STEP 1 | Create a symbolic link from the machine's standard drive to the machine's local storage each
time the VDI boots.
On the golden image, run the Startup Script using GPO or schedule it to run as a task or local policy.
To configure GPO for startup scripts:
1. Run gpmc.msc (Group Policy Management) on your domain controller and then create a new GPO.
2. Give the GPO a meaningful name and click OK.
3. Right-click on the newly created GPO and select Edit.
4. In the left pane of the Group Policy Management Editor, navigate to Scripts (Startup/Shutdown), and
then go to the right pane and double-click Startup.
5. Click Add, navigate to your script, select your script, and click OK.

76 TRAPS ADMINISTRATOR'S GUIDE | VDI

 6. Close both Group Policy Management snap-ins.

STEP 2 | Reset the services state before the image is sealed and migrated into a test or production
environment.
On the golden image, create a batch file using the Shutdown Script and then run it.

STEP 3 | Configure Traps services.

1. Open services.msc: Click Start > Run, enter services.msc, and then press Enter.
2. Right-click the Traps service and select Properties.
3. From the service Startup type drop-down, select Manual.
4. Click Apply and OK.
5. Repeat the process for the Traps Dump Analyzer Service and Traps Reporting Service.

Startup Script

set drivepath=D:\
set datapath=%drivepath%\ProgramData\Cyvera
set policypath=%ProgramData%\CyveraNotInUse\LocalSystem\Data
\ClientPolicy.json

IF EXIST %drivepath% (
IF EXIST %ProgramData%\Cyvera (
rename %ProgramData%\Cyvera CyveraNotInUse
)
%windir%\system32\cmd.exe /c mklink /J %ProgramData%\Cyvera %datapath% 2>&1
IF NOT EXIST %datapath% (
mkdir %datapath%
)
IF NOT EXIST %datapath%\Everyone\Data (
mkdir %datapath%\Everyone\Data
)
IF NOT EXIST %datapath%\Everyone\Temp (
mkdir %datapath%\Everyone\Temp
)
IF NOT EXIST %datapath%\LocalSystem (
mkdir %datapath%\LocalSystem
)
IF EXIST %datapath%\LocalSystem\ClientPolicy.* (
del /F %datapath%\LocalSystem\ClientPolicy.*
)
IF NOT EXIST %datapath%\LocalSystem\Data (
mkdir %datapath%\LocalSystem\Data
copy %policypath% %datapath%\LocalSystem\Data\ClientPolicy.json
)
IF NOT EXIST %datapath%\Logs (
mkdir %datapath%\Logs
)
IF NOT EXIST %datapath%\Prevention (
mkdir %datapath%\Prevention
)
IF NOT EXIST %datapath%\Quarantine (
mkdir %datapath%\Quarantine
)
IF NOT EXIST %datapath%\Administrators\Temp (
mkdir %datapath%\Administrators\Temp
)
)

TRAPS ADMINISTRATOR'S GUIDE | VDI 77

 sc start cyserver
sc start cyveraservice
net start tlaservice

Shutdown Script

::Stop Cyvera services

net stop CyveraService
net stop CyServer
net stop tlaservice
rd c:\ProgramData\Cyvera /q
ren c:\ProgramData\CyveraNotInUse Cyvera

net start CyveraService

net start CyServer

78 TRAPS ADMINISTRATOR'S GUIDE | VDI

Tune and Test the VDI Policy
After you configure the golden image, tune and test the policy using the following workflow.

STEP 1 | Install Traps on a test machine (either the golden image or a non-VDI instance) and fine-tune
the exploit and malware protection policies.
Use the built-in VDI condition to apply rules to VDI instances only.

STEP 2 | Use the golden image to spawn a small pool of persistent sessions (2 or 3). Deploy the sessions
in a production environment and imitate the expected day-to-day user behavior, such as
browsing, development, and dedicated application usage).

STEP 3 | Gather additional information during this period to further optimize the default session policy
and test any special restrictions applied to the non-persistent sessions. Typically, clients
deployed in persistent mode enable better forensics collection than clients deployed in non-
persistent mode.

STEP 4 | Resolve any stability issues on the test machine and on the test VDI pool that were caused by
the exploit or malware protection policies.

STEP 5 | After the VDI server spawns a session from the golden image and connects to the ESM
Server, disconnect the golden image. Then revise the VDI policy so that WildFire integration
is enabled, EPM Injection is set according to the configuration tested on the golden image,
heartbeat and reporting settings use longer intervals (60 minutes is recommended), and
memory dumps are sent automatically.
Traps will replace the initial golden image with the revised VDI policy. Changing the VDI policy affects all
spawned session on the next restart.

STEP 6 | Log into the ESM Console and verify the health of the VDI instances on the Monitor > Agent >
Health page. If your organization uses a mixed environment, you can filter the machine Type
column to show only VDI instances. The status of the VDI instances should be connected.

TRAPS ADMINISTRATOR'S GUIDE | VDI 79

80 TRAPS ADMINISTRATOR'S GUIDE | VDI
Administer the ESM Server
> Manage ESM Server Settings on page 83
> Manage ESM Console Settings on page 85
> Manage Multiple ESM Servers on page 86
> Traps Licenses on page 89
> Manage Administrator Access to the ESM Console on page 91
> Export and Import Policy Files on page 100

81
82 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server
Manage ESM Server Settings
The ESM Server facilitates communication between Traps agents and WildFire.
The ESM Server periodically communicates with WildFire to:
Send unknown files for analysis
Request verdicts associated with executable files and files containing macros
Submit requests to reanalyze a file
The ESM communicates with Traps agents to perform three primary tasks:
Retrieve the operational status of the agent
Obtain reports on processes running on the endpoint
Send the latest security policy.
You can change the frequency of these communications between the server and the endpoint using the
Database (DB) Configuration Tool (see Configure ESM Server Settings Using the DB Configuration Tool) or
using the ESM Console.

STEP 1 | From the ESM Console, select Settings > ESM > Settings.

STEP 2 | Configure any of the following settings for the ESM Server:
Quarantine Network Path(Traps 3.1 and earlier versions) Default forensic folder to use when the
Traps agent cannot reach the folder associated with the ESM Server to which the agent is connected.
Inventory Interval (Minutes)Enter the frequency at which Traps sends a list to the ESM Server to
report the applications that are running on the endpoint.
Heartbeat Grace Period (Seconds)Enter the allowable grace period for a Traps agent that has not
responded (range is 300 to 86,400; default is 4200).
Forensic Folder URLBITS-enabled forensic folder URL.

To encrypt forensic data, we strongly recommend that you use SSL to communicate
with the forensic folder. To use SSL, include the fully qualified domain name (FQDN)
and specify port 443 (for example, HTTPS://ESMserver.Domain.local:443/
BitsUploads). If you do not want to use SSL, specify port 80 (for example, http://
ESMSERVER:80/BitsUploads).
Keep-alive Timeout (Minutes)Period of time (in minutes) after which the ESM sends a keep-alive
message to an external logging platform (range is 0 or greater; default is 0). The keep-alive message
alerts the external logging platform that the ESM component is up and collecting logs. The ESM
Console indicates the time at which each ESM Server sent the last keep-alive message in the Last
Heartbeat field on the additional details view of the ESM Server on the Settings > ESM > Multi ESM
page.
Update From Server Package AddressExternally accessible URL of the ESM Console used to host
upgrade packages for Traps agents. By default, when you configure an action rule to upgrade the
Traps software, the rule is configured to use the ESM Console hostname. If the ESM Console is
accessible by the DNS record only and not by the default ESM Console hostname, use this field to
specify a URL beginning with an HTTP or HTTPS prefix followed by the DNS record.

If you do not specify a server URL in this field, the action rule to upgrade agents uses
your current session to determine the SSL preference. For example, if you log into the
ESM Console using HTTP and create an action rule to upgrade the agents, the agents
receive an upgrade path with an HTTP prefix. If you log in using HTTPS, the agents
receive an HTTPS prefix.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 83

 Use DNS For Address ResolutionSelect this option to enable DNS for address resolution. By
default, this option is disabled to prevent excessive DNS error logging.
Automatic RevocationBy default, the ESM Server automatically revokes a license from an agent
after a period of 90 days. To change the Revocation Period, enter a value from 30 to 365 days. Or,
to prevent the ESM Server from revoking the license, clear the option for Automatic Revocation.
When Automatic Revocation is disabled, the ESM Server does not revoke the license regardless of
the length of time in which the Traps agent has not established communication with the ESM Server.

STEP 3 | (Optional) For deployments that use multiple ESM Servers, you can also configure each ESM
Server to communicate with WildFire through a proxy server.
1. Select Settings > ESM > Multi ESM.
2. Select the row for the ESM Server for which you want to configure proxy communication. The ESM
Console displays the settings associated with the server.
3. Select Edit.
4. Enable Proxy communication.
5. Enter the FQDN or IP address of the proxy server in the Proxy Host/IP field and a Proxy Port
number (default is 8080). Optionally, enable Proxy Authentication and then enter the Username
and Passwordusing only ISO-8859-1 charactersthe ESM Server will use to authenticate with the
proxy server.
6. Save your changes to the ESM Server settings.
7. Repeat this process to configure proxy configuration for other ESM Servers, if desired. You can
configure the same proxy settings across multiple ESM Servers, or configure proxy settings that are
unique to each server.
For more information, see Manage Multiple ESM Servers.

STEP 4 | Save your changes.

84 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Manage ESM Console Settings
From the ESM Console on page 13, you can configure the following settings for the server that hosts the
console:
Dashboard display period
User authentication mode used to authenticate users who log in to the ESM Console, either machine or
domain
Proxy server to facilitate communication between the ESM Console and WildFire.

STEP 1 | From the ESM Console, select Settings > ESM > Settings.

STEP 2 | Configure any of the following settings for the ESM Console:
Dashboard Display Period (Days)Number of days used to generate dashboard charts and graphs.
By default, the ESM Console displays information collected over the past 30 days (range 1-10,000).
User Authentication ModeMethod to authentication ESM Console users, either Machine (local), or
Domain.
ProxyEnter the FQDN or IP address of the proxy server in the Proxy Host/IP field and a Proxy Port
number (default is 8080). Optionally, enable Proxy Authentication and then enter the Username and
Passwordusing only ISO-8859-1 charactersthe ESM Console will use to authenticate with the
proxy server.

STEP 3 | Save your changes.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 85

Manage Multiple ESM Servers
To support large scale or multi-site deployments, you can configure and manage multiple Endpoint Security
Manager (ESM) Servers from the ESM Console. Each ESM Server connects to a shared database that stores
security policies and information about Traps agents and events and can upload forensic data to a dedicated
forensic folder. Adding additional ESM Servers allows you to scale the number of Traps connections that
can connect to your network.
Known Limitations with Multi-ESM Deployments on page 86
What Logic Does the Agent Use When Selecting an ESM Server? on page 86
Activate, Disable, or Delete an ESM Server on page 87

Known Limitations with Multi-ESM Deployments

In a multi-ESM deployment, each ESM Server must meet the requirements specified in ESM Server
Software Requirements on page 35. Multi-ESM deployments also have the following limitations:
Load balancingTo use a load balancer to manage traffic between multiple ESM Servers, you must
specify the IP address of the load balancerinstead of the ESM Serverwhen you install the Traps
agent. The Traps agents can then establish connections through the load balancer instead of attempting
to connect directly to an ESM Server.
IP addressingEach ESM Server must have a static IP address.
ScalingYou can install a maximum of five ESM Servers. To install additional servers, contact your Sales
Engineer.

What Logic Does the Agent Use When Selecting an ESM Server?
At regular heartbeat intervals, the Traps agent receives a list of all known ESM Servers. To evaluate the
ESM Server to which the agent will connect, Traps considers the priority and TTL (in terms of number of
hops) for each server. Traps prioritizes the list of ESM Servers by internal IP address (priority 1), external
IP address (priority 2), followed by the ESM Server specified during the agent installation (priority 3). For
example, consider the following scenario with four ESM Servers:

ESM Server Internal Address TTL External Address TTL

A 2 3

B 1 4

C 2 5

D (default install) 2 5

After evaluating the TTL value for each ESM Server, Traps builds an ordered list:
Priority=1, TTL=1, Latency=10.00ms, Address=https://
esmserverB.example.com:2125/
Priority=1, TTL=2, Latency=20.00ms, Address=https://
esmserverA.example.com:2125/
Priority=1, TTL=2, Latency=20.00ms, Address=https://
esmserverC.example.com:2125/

86 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

 Priority=2, TTL=3, Latency=30.00ms, Address=https://10.31.32.1:2125/
Priority=2, TTL=4, Latency=40.00ms, Address=https://10.31.32.2:2125/
Priority=2, TTL=5, Latency=50.00ms, Address=https://10.31.32.3:2125/
Priority=3, TTL=2, Latency=20.00ms, Address=https://
esmserverD.example.com:2125/
In this example, ESM Server B has the lowest TTL value (fewest number of hops) and highest priority. If
Traps cannot establish a connection to ESM Server Bthe preferred ESM Serverit moves on down the list
until it is able to successfully establish an ESM Server connection.
In the event of a tiewhere two ESM Servers have the same priority and the same TTL valuethe Traps
agent selects a server at random.
If no ESM Servers are reachable (the ESM Server list is empty), the agent status changes to No Connection.
After a period of inactivity, the agent tries to connect again (by default once every minute or as specified in
an Agent Settings communication rule). The Traps agent also periodically verifies the integrity of the ESM
Server list (by default once every hour or as specified in an Agent Settings communication rule). The Traps
agent can also immediately validate the list of ESM Servers when any of the following occur:
The network address of the endpoint changes
The endpoint resumes or restarts
The IP address for an ESM Server changes
A manual Check-In Now is initiated from the Traps console
A communication request from the agent to the server times out or fails

If you remove or temporarily disable an ESM Server, the ESM Console removes the ESM
Server from the list of available ESM Servers and pushes it to Traps agents at the next
heartbeat. However, if you specified the (now disabled) ESM Server during the Traps
installation, those agents retain the (priority 3) ESM Server in the list of available ESM
Servers to which they can connect.

Activate, Disable, or Delete an ESM Server

After installing each ESM Server (see Install the Endpoint Security Manager Server Software), the ESM
Console displays identifying information about each server on the Settings > ESM > Multi ESM page.

You can modify the configuration settings for the ESM Servers at any time. You can also temporarily
disable, activate, or remove an ESM Server, as needed.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 87

 Action Steps

Configure ESM Server See Manage ESM Server Settings.

Settings

Disable an ESM Server Select Disable Selected from the action menu at the top of the page.
The ESM Console changes the status of the server to Disabled. This action
temporarily removes the ESM Server from the available server pool of
ESM Servers to which the Traps agents can connect; However, if the ESM
Server was specified during the Traps installation, the agent retains the
ESM Server on its list of available servers.
This option also allows you to reactivate the ESM Server at a later date.

Delete an ESM Server To remove an ESM Server from service, select Delete Selected from the
action menu at the top of the page. This action permanently removes
the ESM Server from the ESM Console and from the available server
pool of ESM Servers to which the Traps agents can connect; However,
if the ESM Server was specified during the Traps installation, the agent
retains the ESM Server on its list of available servers. You cannot reactive
a deleted ESM Server unless you first reinstall it.

Activate an ESM Server Select Activate Selected from the action menu at the top of the page.
This action adds the disabled ESM Server back in to the available servers
pool.

88 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Traps Licenses
A Traps license enforces the expiration date and maximum number of endpoints that you can manage
(agent pool size) from the ESM Console. The license entitles you to manage the endpoint security policy,
enable WildFire, and obtain support. Each database instance requires a valid Traps license.
When a Traps agent attempts to check in with the ESM Server for the first time, the ESM Server allocates
the agent a license from a shared pool of licenses. All endpoints regardless of typeserver, workstation, or
VDIreceive a license from the shared license pool.
When the Traps agent is inactive and has not communicated with the ESM Server within the configurable
license revocation period, the ESM Server automatically revokes a license from the Traps agent. If the
Traps agent subsequently sends a heartbeat communication to the ESM Server and successfully connects,
the ESM Server treats the agent as new and allocates the agent a new license from the pool of available
licenses.
After a license for an agent (and the two-day grace period) expires, Traps protection is disabled.
To purchase licenses, contact your Palo Alto Networks Account Manager or reseller.

In earlier Traps releases, the ESM Console maintained separate license pools for each
type of endpoint. To extend or allocate additional licenses to Traps agents running versions
earlier than Traps 4.0, make sure you select the appropriate agent version when requesting
new licenses from the Support portal.

You can manage licenses in the following ways:

View license utilizationUse the License Capacity chart on the Dashboard to view the current utilization
of all licenses across all workstations, servers, and VDIs.
Add a Traps licenseUse the Settings > License page to add support for additional features or users. See
Add a Traps License Using the ESM Console. You can also add a license using the DB Configuration tool
(see Add a Traps License Using the DB Configuration Tool).
Adjust the automatic license revocation periodThe ESM Server automatically revokes a license from an
agent after a period of inactivity. For Traps 4.0 agents, the default revocation period is 90 days. For older
Traps agents, the default revocation period is seven days. To change the defaults, modify the License
Revocation Period from the Settings > ESM > Settings page. For more information about ESM Server
Settings, see Manage ESM Server Settings.
Detach a licenseTo detach a license from an endpoint, you can Remove an Endpoint from the ESM
Console. This action immediately frees up the license for use by another Traps agent and returns it to
the available pool of licenses and removes the endpoint from the default view on the Health page.

Add a Traps License Using the ESM Console

Before you can start using Traps to protect your endpoints, you must install a valid Traps license. To
manage licenses, you must be assigned a role with Licensing privileges enabled.

STEP 1 | Before you begin: Obtain a license from your Palo Alto Networks Account Manager or reseller.

STEP 2 | Select Settings > Licensing and then Add a new license.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 89

STEP 3 | Browse to and then Upload the license file. The ESM Console displays information about the
new license, including the license features, the agent pool size, the number of endpoints to
which the license has been issued, the date you added the license, and the date the license
expires.

STEP 4 | (Optional) To verify the Traps license utilization, select Dashboard and view the License
Capacity.

STEP 5 | (Optional) To export the license information to a CSV file, select Settings > Licensing, click the
action menu , and then select Export Logs.

STEP 6 | (Optional) By default, the ESM Server automatically revokes the license from an agent which
has not connected to an ESM Server within a 90-day period. To change the number of days in
which the ESM Server revokes a license or to prevent Automatic Revocation, see Manage ESM
Server Settings.

Add a Traps License Using the DB Configuration Tool

Using the Database (DB) Configuration Tool, you can manage basic ESM Server settings, including the
ability to install a license. You can access the DB Configuration Tool using a Microsoft MS-DOS command
prompt that you run as an administrator. The DB Configuration Tool is located in the Server folder on the
ESM Server.

All commands you run using the DB Configuration Tool are case sensitive.

STEP 1 | Before you begin: Obtain a license from your Palo Alto Networks Account Manager or reseller.

STEP 2 | Open a command prompt as an administrator in either of two ways:

Select Start > All Programs > Accessories, right-click Command prompt, and then select Run as
administrator.
Select Start and in the Start Search box, type cmd but do not press Enter, yet. Then, to open the
command prompt as an administrator, press Ctrl+Shift+Enter.

STEP 3 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator>cd C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server

STEP 4 | Upload the new license:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig importLicense C:\<PathtoLicenseFile>\<LicenseFilename>.xml

The DB Configuration Tool uploads the license file. To verify the license using the ESM Console, see Add
a Traps License Using the ESM Console.

90 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Manage Administrator Access to the ESM
Console
When you install the Endpoint Security Manager (ESM) Console, you specify the administrative account and
type of authentication the administrator will use to access the console. The ESM Console can authenticate
users defined on the local ESM Console server or by using domain accounts (including groups and
organizational units) defined in Active Directory (AD). After installation, you can change the authentication
mode, customize roles with access privileges, and assign those roles to administrative accounts.
Administrative Roles
Administrative Privileges
Administrative Users
Administrative Authentication
Configure Administrative Accounts and Authentication

Administrative Roles
Role-based access control (RBAC) enables you to use preconfigured or define custom roles to assign access
rights to administrative users. Each role extends specific privileges to users you assign to the role and
each privilege defines access to specific configuration settings and pages within the ESM Console. By
customizing a role and assigning specific privileges, you can enforce the separation of information among
functional or regional areas of your organization to protect the privacy of data on the ESM Console.

The way you configure administrative access depends on the security requirements of your organization.
Use roles to assign specific access privileges to administrative user accounts. By default, the ESM Console
has built-in roles with specific access rights that cannot be changed. When new features are added to the
product, the ESM Console automatically adds new features to the default role definitions. The following
table lists built-in roles and the access privileges associated with each:

Role Privileges

Superuser Full read-write access to the ESM Console.

IT Administrator Read-write access to monitor and configuration settings pages and read-only
access to all other pages in the ESM Console; does not include the ability to
disable all protection.

Security Administrator Read-write access to policy configuration, monitoring, and settings pages in
the ESM Console, including the ability to disable all protection. This role also
includes read-only access to the agent health pages but no access to the server
health or licenses pages.

While you cannot change the privileges associated with the built-in roles, you can create custom roles that
provide more granular access control over the functional areas of the web interface. For these roles, you

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 91

 can assign read-write access, read-only access, or no access to all the ESM Console configuration functions
and pages.
An example use of a custom role is security administrators who need to be able to view logs about the
status of endpoints but who do not need to configure security rules.

Administrative Privileges
For each custom administrative role that you create, you can select the privileges and levels of access for
each privilege. The levels of access for each privilege are:
EnableAllow read/write access to a page in the ESM Console.
DisableHide access to a page.
Read OnlyAllow a user to view but not modify a page.
The following table describes the privileges that you can customize for each role.

Privilege Description

Is Active Users whom are assigned this role can log in to the ESM
Console.

Enable License Notifications The ESM Console displays license notifications to users
who have this privilege enabled when a license is due to
expire or has expired.

Dashboard Access to the main ESM Console Dashboard.

Security Events Access to the Security Events page.

Policies Access to all policy pages.

Exploit Access to all exploit protection rule pages where you can
view user-defined and default exploit protection rules. If
your access permits, you can also configure new or modify
existing rules and processes. For more granular control,
configure access by Exploit page:
Protection Modules (Application Protection Modules)
Kernel Protection Modules
Process Management

92 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Privilege Description

Malware Access to all malware protection rule pages where you

can view user-defined and default restriction rules and
settings, malware protection rules, WildFire rules, and
verdicts associated with files opened on your endpoints. If
your access permits, you can also configure new or modify
existing rules and configure administrative hash overrides.
For more granular control, configure access by Malware
page:
Restrictions
Restriction Settings
Protection Modules
WildFire
Hash Control

Forensics Access to the forensics management page and the agent

query. For more granular control, configure access by the
individual Forensics pages:
Forensics
Agent Query

Disable All Protection Access to halt all Traps protection rules.

Setting this privilege to read-only access

functions the same as setting the access
to disable. In both cases, the ESM
Console hides the option from view.

Monitor Access to all monitoring pages.

Agent Access to all agent monitoring pages. For more granular

control, configure access by the individual Agent pages:
Health
Logs

ESM Access to all ESM monitoring pages. For more granular

control, configure access by the individual ESM pages:
Health
Logs

Data Retrieval Access to the data retrieval monitoring page where you
can monitor the status of data uploaded to the ESM
Server, and export or delete data.

Settings Access to configure or view any of the ESM, Agent,

Conditions, or Licensing settings pages.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 93

 Privilege Description

ESM Access to configure any of the ESM settings. For more

granular control, configure access by any of the ESM
settings pages:
Settings
WildFire
Syslog
Email
Panorama
Multi ESM
Content Updates

Agent Access to configure any of the agent settings or action

rules or to create installation packages for Mac endpoints.
For more granular control, configure access by any of the
settings pages:
Settings
Actions
Installation Package (Mac endpoints only)

Conditions Access to view and create conditions that you can use in
policy rules.

Licensing Access to view and manage Traps licenses.

Administrative Users
An administrative user is a local or domain user account that has access to specific administrative or
reporting functions on the ESM Console. Using role-based access control (RBAC), you can assign specific
privileges and responsibilities to a role and then assign that role to one or more users who require the same
access permissions.

As a best practice, create a separate administrative account for each person who
needs access to the ESM Console. This provides better protection against unauthorized
configuration (or modification) and enables logging of all actions for each individual
administrator.

Use the ESM Console to assign administrative access to any of the following account types:

94 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

 Account Type Description

User (Machine or domain authentication) Existing domain or local user account

used to log into the ESM Console. The ESM Console authenticates the user in
one of two ways:
Domain authenticationauthenticates using the credentials stored in
Active Directory.
Machine authenticationauthenticates using the credentials stored on the
local system on which the ESM Console is installed.

Group (Domain authentication only) Extends administrative access to all members

of a security group and uses the authentication credentials defined in Active
Directory to authenticates the user.

Organizational Unit (Domain authentication only) Extends administrative access to all members
of an organizational unit and uses the authentication credentials defined in
Active Directory to authenticates the user.

The ESM Console does not retain credentials for any administrative account. To change the
credentials of an administrative account, you must modify them on the local machine if using
machine authentication or in Active Directory if using domain authentication.

Administrative Authentication
When you install the ESM Console, you specify the administrative user and type of authentication that
the ESM Console uses to authenticate administrative users. You can change these preferences using
the Database (DB) Configuration Tool on page 323 (see Configure Administrative Access to the ESM
Console Using the DB Configuration Tool on page 324) or using the ESM Console (see Configure the
Authentication Mode on page 98). You can also specify a preexisting authentication group to use for
administrative access. By default, no groups are specified.
You can configure the following types of administrator authentication:

Account Type Description

Domain Uses accounts defined in Active Directoryincluding users, groups, or

organizational unitsfor administrative access.

Machine Uses accounts that are local to the ESM Console server for administrative
access.

Configure Administrative Accounts and Authentication

Configure Administrative Roles on page 96
Configure Administrative Users, Groups, or Organizational Units on page 97
Configure the Authentication Mode on page 98
Change the Ninja-Mode Password on page 98

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 95

Configure Administrative Roles

From the Administration > Roles page, you can see all the built-in and custom roles for your organization.
Creating custom roles enables you to tailor the access permissions around the security requirements for
your organization.
Each role shows the role name and description, the number of users that are assigned to the role, and the
date the role was created. Selecting the row for a role expands that row to display additional details and
actions. The actions you can perform on the role vary for both built-in and custom roles.
While you cannot modify or delete any of the built-in roles, you can view the access privileges that are
associated with the role. You can, however, add, modify, or delete a custom role. You can also block any
role to prevent users that are assigned to that role from logging in to the ESM Console. Similarly, deleting
a custom role removes the access privileges associated with that role from the ESM Console and prevents
users from logging in to the ESM Console if they are assigned to that role. The ESM Console displays
blocked roles with a red icon in the status column.

STEP 1 | From the ESM Console, select Settings > Administration > Roles. The ESM Console displays all
built-in and customized roles for your organization.

STEP 2 | Select and then Edit an existing role, or Add a new one.

STEP 3 | Define the Role Name and enter a Description.

STEP 4 | Select the Is Active option to enable the role or deselect the option to disable the role.

STEP 5 | Select a privilege to toggle through the different levels of access for that privilege. By default,
all privileges are disabled. Selecting the privilege once changes the setting to Read Only
access; selecting the privilege again changes the access level to read-write access (Enable); and
selecting the privilege from an enabled state disables the privilege.

STEP 6 | Click Save. The ESM Console displays the new or modified role in the table.

STEP 7 | Assign the role to a user. See Configure Administrative Users, Groups, or Organizational Units
on page 97.

96 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Configure Administrative Users, Groups, or Organizational Units

From the Settings > Administration > Users page, you can view all the accounts that provide administrative
access to the ESM Console. An account can be a user, a group, or an organizational unit. To provide
administrative access to a group or organizational unit, the account must exist on the domain. To provide
administrative access to a user, you can add either a user on the local machine or a user on the domain. The
ESM Console uses the domain or the credentials defined on the local machine to authenticate the user.

As a best practice, create a separate account for each user that requires access to the ESM
Console.

For each account, the ESM Console displays the account status (Blocked or Unblocked), the account Name,
the assigned Role, and the date that the account was created. Selecting the row for an account will expand
the row to display additional details and actions, including who created the role (System, DbConfig, or the
administrative account that is logged into the ESM Console). The actions you can perform on a role vary
depending on where the role was created. If you have permissions to do so, you can edit, block, unblock, or
delete any account created by other administrative users but you cannot block or delete accounts that were
created from DBconfig.
Blocking an account prevents that account from logging in to the ESM Console. Similarly, deleting an
account removes the account and settings from the ESM Console and prevents the account from logging in
to the ESM Console. When a role that is associated with an account is blocked, the ESM Console displays
the Role as <role name> (inactive). When a role that is associated with an account is deleted, the
ESM Console displays the Role as N/A (inactive). The ESM Console also displays blocked accounts
with a red icon in the status column and indicates a deleted or blocked role with a red icon next to the
Role name.

STEP 1 | From the ESM Console, select Settings > Administration > Users. The ESM Console displays
the accounts for your organization, including users, groups, and organizational units.

If you cannot log into the ESM Console, use the Database (DB) Configuration Tool on
page 323 to verify, and optionally change, the users and groups that have access to the
ESM Console (see Configure Administrative Access to the ESM Console Using the DB
Configuration Tool on page 324).

STEP 2 | Click Add User, Add Group, or Add Organizational Unit to create a new account. Alternatively,
select the row of an existing account and click Edit to modify the account settings. From this
view, you can also Block, Unblock, or Delete an account.

STEP 3 | Enter the Name of an existing account. If you are using machine authentication, you can only
add existing users on the local machine. If you are using domain authentication, you can add
any existing domain user, group, or organizational unit.

The ESM Console truncates usernames over 20 characters. As a result, users must log in
to the ESM Console using only the first 20 characters of their username.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 97

STEP 4 | Select the Is Active option to enable the account or clear the Is Active option to disable the
account.

STEP 5 | Select the role from the list to assign access privileges to the account. To create a new role, see
Configure Administrative Roles on page 96.

STEP 6 | Save your changes. The ESM Console displays the new or modified account in the table.

Configure the Authentication Mode

When you install the ESM Console, you specify the administrative account and type of authentication that
administrators will use to access the console. You can change these preferences using the ESM Console as
follows:

STEP 1 | From the ESM Console, select Settings > ESM > Settings.

If you cannot log into the ESM Console, use the Database (DB) Configuration Tool on
page 323 to verify, and optionally change, the authentication mode (see Configure
Administrative Access to the ESM Console Using the DB Configuration Tool on page
324).

STEP 2 | Select the Authentication Mode:

Machineauthenticates users using a local account
or
Domainauthenticates users using Active Directory.

STEP 3 | Save your changes.

Change the Ninja-Mode Password

To view and modify advanced settings in the ESM Console, you must enter the ninja-mode password. To
change the password, use the DB Configuration Tool.

STEP 1 | Open a command prompt as an administrator in either of two ways:

Select Start > All Programs > Accessories, right-click Command prompt, and then select Run as
administrator.
Select Start and, in the Start Search box, type cmd but do not press Enter, yet. Then, to open the
command prompt as an administrator, press Ctrl+Shift+Enter.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server

STEP 3 | (Optional) View the existing server settings:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server show
PreventionsDestFolder = \\ESMServer\Quarantine
InventoryInterval = 284
HeartBeatGracePeriod = 300
NinjaModePassword = Password2

98 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

STEP 4 | Specify the new ninja-mode password.

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server NinjaModePassword <password>

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 99

Export and Import Policy Files
From each rule management page on the ESM Console, you can import and export rules. This enables you
to:
Back up user-defined rules before migrating or upgrading to a new version of the ESM Console.
Back up user-defined rules before deploying a policy to multiple independent ESM Consoles.
Import user-defined rules from another ESM Console (running the same version).
Update your default security policy with the latest recommendations and best practices from Palo Alto
Networks.
The ESM Console supports the ability to import both user-defined rules and default security rules.
When you import a policy file that contains multiple types of rules, the ESM Console automatically
determines the rule type and distributes the rules to their respective rule management pages. When you
export a policy or set of rules, you can only export user-defined rules of the same type. This is because you
must select the rules from a single rule management page when you perform the export. When you export
rules, the ESM Console saves them to an XML file in the location of your choice.
When you import user-defined rules, the ESM Console appends the rules to the existing policy and assigns
each rule a unique ID number. When you install a content update to import the latest default security rules,
the ESM Console overwrites the existing rules with the updated policy. When available, you can download
the latest default security policy from the Dynamic Updates section of the Support portal.
User-Defined Rules on page 100
Content Updates on page 101

User-Defined Rules
A user-defined rule is a rule that youor additional administrators with access to the ESM Consolecreate
to manage the Traps security policy and agent settings, or to perform specific actions on the endpoint. A
user-defined rule can inherit or override the default security policy.

Export user-defined rules.

1. Select the policy management page for the set of rules you are exporting. For example, Policies >
Exploit > Protection Modules.
2. Select the check box next to the rule(s) you want to export or use the check box at the top of the
column to select all rules.
3. From the action menu at the top of the table, select Export Selected. The ESM Console saves the
selected rules to an XML file.

Import user-defined rules.

1. Select the policy management page for the set of rules you are exporting. If your policy file contains
rules of different types (for example, exploit protection and malware protection rules), you can
choose any rule management page. For example, select Policies > Exploit > Protection Modules.
2. Select Import Rules from the action menu at the top of the table.

100 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

 3. Browse to the policy file, and then click Upload.
The ESM Console appends the new rules to the current policy.

Content Updates
Content updates allow you to easily update your default security policy and settings. Content updates equip
the ESM Console with the most up-to-date best practices and threat information for accurate exploit and
malware protection and can include changes or additions to:
Compatibility rules for third-party products and platforms
Condition objects
Protected processes
Restriction settings
Trusted signers
Local static analysis logic
These files are packaged in a ZIP file and are hosted on the Support portal.
To manage content updates, use the following workflows:
Install a Content Update on page 101
Revert to the Previous Content Update on page 102

Install a Content Update

Content updates are categorized on the Support portal by ESM version. To update the default policy of the
ESM Console, you must use a content update for your ESM version. After you install a content update, the
ESM Server transparently distributes any changes to the default policy to your endpoints. This occurs at the
next heartbeat communication with the endpoint.

STEP 1 | Log in to the ESM Console and select Settings > ESM > Content Updates.

STEP 2 | To open the Support portal, do one of the following:

Select Support Site on the ESM Console.
Open a new browser window and navigate to the DYNAMIC UPDATES page on the Support portal.

STEP 3 | Identify the content update for your ESM version (typically the latest available content update
version), and then review the associated Release Notes.

STEP 4 | Download the content update package to a location that is accessible from the ESM Console.

STEP 5 | From the ESM Console, select Update Content, Browse to the content update package, and
Apply.

If the content update is older than the current version, the ESM Console displays a
warning message.

TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server 101

 After the ESM Console installs the content update, it displays details including version number, release
date, and the date on which you installed the content package. You can also view the installed content
update version from the footer on each page of the ESM Console. For example, if the ESM Console
displays the version as v3.4.0.15481, 5-353, the installed content update version is 5-353.

Revert to the Previous Content Update

For convenience, the ESM Console maintains up to two content updates at a time: the current update and
the previous update. From the Content Updates page, you can view information about the content updates,
roll back to previous content update versions, or install a new (or older) version of a content update. To
revert to an older version of a content update, you must download the package from the Support portal and
install it as you would a new update.

STEP 1 | Log in to the ESM Console and select Settings > ESM > Content Updates.

STEP 2 | Review the Release Notes for the previous content update as needed and then Revert.
The ESM Console restores the previous set of default policy rules and distributes them to the endpoints
at the next heartbeat communication.

102 TRAPS ADMINISTRATOR'S GUIDE | Administer the ESM Server

Monitoring
The ESM Console provides information that is useful for monitoring the servers, endpoints,
and security policy for your organization. You can monitor the logs and filter the information to
interpret unusual behavior on your network. After analyzing a security event, you can choose
to create a custom rule for the endpoint or process. The following topics describe how to view
and monitor reports on the security health of the endpoints.

> Maintain the Endpoints and Traps on page 105

> Use the Endpoint Security Manager Dashboard on page 106
> Monitor Security Events on page 107
> Monitor the Endpoints on page 111
> Monitor the ESM Servers on page 116
> View the Rule Summary on page 117
> Monitor Forensics Retrieval on page 118

103
104 TRAPS ADMINISTRATOR'S GUIDE | Monitoring
Maintain the Endpoints and Traps
On a daily or weekly basis, perform the following actions:
Examine the Dashboard to verify that the Traps agent is active on all endpoints. See Use the Endpoint
Security Manager Dashboard.
Review Security Events reported by Traps. After analyzing a security event, you might want to do any of
the following tasks:
Investigate whether the indicators are related to malicious executable files and then use the Agent
Query to search for artifacts on Windows endpoints.
Disable rules temporarily that interfere with day-to-day work. In cases where a security event does
not indicate an attack and is interfering with day-to-day work, you can disable an exploit protection
or restriction rule on a specific endpoint. See Exclude an Endpoint from an Exploit Protection Rule.
Patch, upgrade, or fix a bug in software that indicates erroneous behavior or a security vulnerability.
Patching or upgrading third-party applications or fixing bugs in applications that are developed in-
house can reduce the number of security events reported to the ESM Console.
Activate protection for an unprotected application. See View, Modify, or Delete a Process.
Review post-detection events and take additional action to remediate the endpoint.
Examine the Monitor pages and investigate reports of crashes and security events.
If you configured your ESM Console to Collect New Process Information, review unprotected processes
and decide whether to enable protection on them. See View, Modify, or Delete a Process.
After a change in the organization or in available Traps software versions, you can:
Add a newly-installed application to the list of protected processes. See Add a New Protected Process.
Install Traps on a new endpoint. See Install Traps on Windows Endpoints and Install Traps on Mac
Endpoints.
Upgrade the Traps agent version on endpoints. See Uninstall or Upgrade Traps on the Endpoint.
Allocate additional licenses for Traps agents. See Add a Traps License Using the ESM Console.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 105

Use the Endpoint Security Manager Dashboard
The Dashboard is the first page that you see when you log into the ESM Console. The Dashboard provides
a collection of charts and graphs that display information about the status of the Traps agents that are
managed by your Endpoint Security Manager. By default, the ESM Console displays information collected
over the past 30 days. To change the display period, see Manage ESM Console Settings on page 85.

The following table describes each chart:

Dashboard Chart Description

SERVICE STATUS Displays the status of the Traps agent instances installed on the
endpoints by number and percentage. Possible statuses are:
RunningThe agent is running.
StoppedThe agent service has been stopped.
DisconnectedThe server hasn't received a heartbeat message from
the agent for a preconfigured amount of time.
ShutdownThe endpoint has been shut down.

COMPUTER Displays the version of the Traps agent instances installed on the
DISTRIBUTION AND endpoints by number and percentage.
VERSION

LICENSE CAPACITY Displays the Traps license utilization for the server and client by number
of used and available licenses.

MOST TARGETED Displays applications that have the highest distribution of preventions.
APPLICATIONS

MOST TARGETED Displays endpoints that have the highest distribution of preventions.
COMPUTERS

MOST TARGETED Displays preventions that have the highest distribution per end user.
USERS

106 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

Monitor Security Events
Use the Security Events page and tabs to manage alerts and detect new threats.
Use the Security Events Dashboard on page 107
View the Security Event History on an Endpoint on page 109
Exclude an Endpoint from an Exploit Protection Rule on page 194

Use the Security Events Dashboard

Use the Security Events dashboard (Security Events > Summary) to monitor high-level information about
security events that occur on the endpoints in your organization. From this view, you can see the number
of events that have occurred in the last day, week, or month. The Security Events Dashboard displays both
events where exploit attempts were blocked and events that triggered only notifications.
The following table describes the different areas of the dashboard in more detail.

Dashboard Component Description

THREATS Displays all the threats to protected processes and executable files that have
occurred in your network. For convenience, you can click any rule type to
view additional details about events of that type. You can also click on the
number of events that have occurred to view only those events. For more
information, see Manage Security Events.

SECURITY ERROR LOG Displays all of the errors and recent issues that Traps reports about the
endpoints in your organization. Click any error type or on the number of
security errors to view a filtered list of errors from the Monitor > Security
Errors Log page. For more information, see View Security Error Log Details.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 107

Manage Security Events
Select Security Events > Threats to display a list of threats that have occurred in your network. The default
view of the threats page includes all prevention and notification events. The menu on the side of the
Threats page also provides links to filtered lists of threats by event (Preventions and Notifications) and also
by rule type.

The standard details view of the Threats page displays a table of security events with fields displayed along
the top. Selecting an event in the Threats table expands the row to reveal additional details about the
security event. In addition to viewing details about threat events, you can create and view notes about the
event, retrieve log data about the event from the endpoint, or create an exclusion rule to allow the process
to run on a particular endpoint.

Filter for specific events

Use the search field to search for users or endpoints, or use the filters at the top of each column to
narrow the results.

View additional details about the event

Select the row for the event. The row expands to reveal additional details about the security event.

For details on the fields in the security events table, refer to the online help.

Export events to a comma separated values (CSV) file.

1. Select the checkbox for each event that you want to export.
2. Click the action menu , and select Export Selected. The ESM Console generates the CSV file
containing the selected records.

Delete events.
1. Select the checkbox for each event that you want to export.
2. Click the action menu , and select Delete Selected. The ESM Console removes the records from all
Security Events pages.

(WildFire events only) View the WildFire Report for an executable file
From the expanded view of a security event, click WildFire Report.

108 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

 (WildFire events only) Jump to the Hash Control entry for the executable file.
From the expanded view of a security event, click Hash Control.

Retrieve prevention data from the endpoint.

From the expanded view of a security event, click Retrieve Data. The ESM Console uses the prevention
key and trigger information to request data about the prevention event from the agent. After the
information is sent to the forensic folder, you can view information about the download from the
Monitor > Data Retrieval page.

View administrative notes about the event

From the expanded view of a security event, click View Notes to view notes that you or other
administrators entered about the security event. If there are no notes, this option is grayed out.

Create an administrative note about the event

From the expanded view of a security event, click Create Note to record information about the security
event for follow-up at a later time or date.

(Exploit events only) Create a rule to exclude an endpoint from exploit protection.
From the expanded view of a security event, click Create Rule to create an exploit protection rule that
excludes the endpoint from the exploit protection rule that prevented the process from running. The
rule uses the details from the security event to populate a rule with settings that allow a process to run
on a specific endpoint.

View Security Error Log Details

Select Monitor > Security Error Log to display events related to the behavior of the agent and the security
of the endpoint. The events include changes in service such as the start or stop of a service. On rare
occasions, the Security Error Log can also show issues encountered during the protection of a process
where an injection fails or crashes.

For details on the fields in the Security Error Log table, refer to the online help.

View the Security Event History on an Endpoint

When a user launches a process on the endpoint, Traps injects code into the process and activates a
protection module known as an Exploit Protection Module (EPM) into the process. The endpoint security
policy rules determine which EPMs are injected into each process. During the injection, the process name
appears on the console in red. After the injection completes successfully, the console logs the security
event on the Events tab.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 109

 Each security event on the Events tab displays the date and time of the event, name of the affected
process, and EPM that was injected into the process. Typically, the mode indicates whether or not Traps
terminated the process or only notified the user about the event.

STEP 1 | Launch the Traps Console:

From the Windows tray, right-click the Traps icon and select Console, or double-click the icon.
Run CyveraConsole.exe from the Traps installation folder.
The Traps Console launches.

STEP 2 | View the security events:

1. Select Advanced > Events to display the security events on the endpoint.
2. Use the up and down arrows to scroll through the list of events.

110 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

Monitor the Endpoints
View Endpoint Health Details on page 111
View Notifications About Changes in the Agent Status on page 111
View the Status of the Agent from the Traps Console on page 112
View the Rule History of an Endpoint on page 113
View Changes to the Security Policy from the Traps Console on page 113
View the Service Status History of an Endpoint on page 114
Remove an Endpoint from the ESM Console on page 114

View Endpoint Health Details

From the ESM Console, select Monitor > Agent > Health to display a list of endpoints in the organization
and their corresponding security state.

The standard details view of the Health page displays a table of endpoints with fields displayed along
the top. Selecting an endpoint in the Health table expands the row to reveal additional details about the
endpoint and actions that you can perform. You can also export the logs to a CSV file by clicking the menu
icon , and selecting Export Logs.
For details on the fields in the Agent > Health table, refer to the online help.

View Notifications About Changes in the Agent Status

Use the Monitor > Agent > Logs page to view notifications about changes in agent status including starting
or stopping services, systems, and processes.

STEP 1 | From the ESM Console, select Monitor > Agent > Logs.

STEP 2 | To view the table entries, use the paging controls on the top right of each page to view
different portions of the table.

STEP 3 | (Optional) To sort the table entries, select the column heading to sort by ascending order. Select
the column heading again to sort by descending order.

STEP 4 | (Optional) To filter the table entries, click the filter icon to the right of the column to specify
up to two sets of criteria by which to filter the results.

STEP 5 | (Optional) To export the logs to a CSV file, click the menu icon , and then select Export Logs.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 111

View the Status of the Agent from the Traps Console
The console displays active and inactive services by displaying a or to the left of the service type.
Select the Advanced tab to display additional tabs along the top of the console. The tabs allow you to
navigate to pages that display additional details about security events, protected processes, and updates to
the security policy. Usually, a user will not need to run the Traps Console, but the information can be useful
when investigating a security-related event. You can choose to hide the tray icon that launches the console,
or prevent its launch altogether. For more information, see Hide or Restrict Access to the Traps Console.

System Element Description

Anti-Exploit Protection Indicates whether or not exploit prevention rules are active in the endpoint
security policy.

Anti-Malware Indicates whether or not restriction and/or malware protection modules are
Protection enabled in the endpoint security policy.

Forensic Data Collection Indicates whether or not WildFire integration is enabled.

Status tab Displays the Connection status and level of protection on the endpoint. The
Traps console opens to the Status tab by default.

Events tab Displays security events that have occurred on the endpoint.

Protection tab Displays the processes that the Traps agent protects that are currently
running on the endpoint.

Policy tab Displays changes to the endpoint security policy including the date and time
of the update.

Verdict Updates tab Displays changes in verdict for executables that have been opened on the
endpoint.

Settings Displays language options that you can use to change the language of the
Traps Console.

Check In Now link Initiates an immediate update of the security policy.

Connection Displays the status of the connection between Traps and ESM Server.

Last Check-In Displays the date and time that Traps last received a heartbeat message.

112 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

 System Element Description

Open Log File... Opens the most recent trace file on the endpoint.

Send Support File Creates a zipped file of traces and sends it to the forensic folder.

View the Rule History of an Endpoint

The standard details view of the Health page displays a table of endpoints with fields displayed along
the top. Selecting an endpoint in the Health table expands the row to reveal additional details about the
endpoint and allows you to view the rule history of objects in your organization. Each rule in the Agent
Policy displays the date and time when Traps applied the rule, source of the policy rule (local or remote),
rule name and description, and the current status of that rule.

STEP 1 | Open the Endpoint Security Manager and select Monitor > Agent > Health.

STEP 2 | Select the row of the endpoint for which you want to view the rule history. The row expands
to display further details and actions you can perform.

STEP 3 | Select Agent Policy from the drop-down on the right. The recent status information appears in
the Agent Policy and Logs section of the page.

STEP 4 | Click Details to view the full rule history log. The status indicates one of the following:
ActiveThe rule is active in the endpoint security policy.
HistoricThe rule is an older version of a rule that is active in the endpoint security policy.
DisabledThe rule was deactivated in the security policy.

View Changes to the Security Policy from the Traps Console

The Policy tab on the Traps Console displays changes to the endpoint security policy. Each rule displays
the unique ID number, name of the rule, date and time that Traps received the updated security policy
containing the rule, and description.

Each rule type has a dedicated management page that you can use to view and manage
the rules for your organization. To create a text file containing the active security policy
on an endpoint, run the following from a command prompt: cyveraconsole.exe
export(641980)
CyveraConsole.exe creates an XML file in \programdata\cyvera
\logs\ containing the active policy. The filename uses the format
ClientPolicy_<date>_<time>.xml to indicate the date at which the policy was active,
for example: CyveraPolicy_20160831_113415.xml

STEP 1 | Do one of the following to launch the Traps Console on the endpoint:
From the Windows tray, right-click the Traps icon and select Console, or double-click the icon.
Run CyveraConsole.exe from the installation folder of the Traps Console.

STEP 2 | View the security policies:

1. If necessary, click Advanced to reveal additional tabs. Then click the Policy tab to display the
protection rules that are running on the endpoint.
2. Use the up and down arrows to scroll through the list of protection rules.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 113

View the Service Status History of an Endpoint
By default, the standard details view of the Monitor > Agent > Health page displays a table of endpoints
with fields displayed along the top. Selecting an endpoint in the Health table expands the row to reveal
additional details about the endpoint and allows you to view the status history of the Traps agent on the
endpoint. A drop-down on the Agent Policy and Service Status section allows you to display a partial list of
Service Status events. From this section you can also view the full service status history log. Each event in
the log displays the date and time of the service change, version of Traps that is running on the endpoint
and the change in status, either disconnected, running, shutdown, or stopped.

STEP 1 | From the ESM Console select Monitor > Agent > Health.

STEP 2 | Select the row of the endpoint for which you want to view the rule history. The row expands
to display further details and actions you can perform.

STEP 3 | Select Service Status from the drop-down on the right. The recent status information appears
in the Agent Policy and Logs section of the page.

STEP 4 | Click Details to view the full service status history log.

Remove an Endpoint from the ESM Console

In situations where you must remove one or more endpoints from the Endpoint Security Manager, use the
Delete Selected option from the action menu at the top of the Health page.

You might delete an endpoint to:

Clean up duplicate entries.
Remove endpoints that are no longer in use.
Free up a license from an inactive Traps agent before the automatic revocation period expires.
Release the license from a VDI session that did not close correctly.
When you delete an endpoint, the ESM immediately frees up the license and returns it to the available pool
of licenses for use by another Traps agent. After you delete the endpoint, the Traps agent continues to
apply the last known policy and remains licensed using the original license. However, after the license and
grace period (a period of two days) expires, Traps disables protection.
If at any time, the Traps agent sends a heartbeat communication and successfully connects to the ESM
Server, the ESM Server treats the agent as a new agent and issues it a new license from the available license
pool.
To delete an endpoint from the ESM Console:

STEP 1 | From the ESM Console select Monitor > Agent > Health.

114 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

STEP 2 | In the agent health table, select the checkbox for one or more endpoints you want to delete.

To quickly locate an endpoint, use the filter controls at the top of the columns.

STEP 3 | Select Delete Selected from the action menu at the top of the Health table. Click OK to
confirm the deletion.
The ESM Console changes the status of the endpoint to Historic and hides the endpoint from the
default display of endpoints on the Health page (to view the deleted endpoints, filter the status column
by Historic).

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 115

Monitor the ESM Servers
From the ESM Console you can monitor the health of the ESM Servers in your organization and view
changes in their status.
View the Health of the ESM Servers on page 116
View Notifications About the ESM Server on page 116

View the Health of the ESM Servers

Use the Monitor > ESM > Health page to view notifications about changes in the ESM Server health
including the number of agents that are connected or disconnected from the server.
By default, the standard details view of the Health page displays a table of servers with fields displayed
along the top. Selecting a server in the Health table expands the row to reveal additional details about the
server and actions that you can perform. You can also export the logs to a CSV file by clicking the menu
icon , and selecting Export Logs.

STEP 1 | From the ESM Console, select Monitor > ESM > Health.

STEP 2 | To view the table entries, use the paging controls on the top right of each page to view
different portions of the table.

STEP 3 | (Optional) To sort the table entries, select the column heading to sort by ascending order. Select
the column heading again to sort by descending order.

STEP 4 | (Optional) To filter the table entries, click the filter icon to the right of the column to specify
up to two sets of criteria by which to filter the results.

STEP 5 | (Optional) To export the logs to a CSV file, click the menu icon , and then select Export Logs.

STEP 6 | (Optional) To view a list of agents that are connected to the ESM Server, expand the row for the
server, and then click Agent List next to the connected or disconnected field. If there are no
agents, this option is grayed out.

View Notifications About the ESM Server

The Monitor > ESM > Logs page displays notifications about and actions initiated from the ESM Server(s)
including administrative changes, license changes, server management changes, policy management
changes, and WildFire changes. For details on the fields in the ESM > Logs table, refer to the online help.

STEP 1 | From the ESM Console, select Monitor > ESM > Logs.

STEP 2 | To view the table entries, use the paging controls on the top right of each page to view
different portions of the table.

STEP 3 | (Optional) To sort the table entries, select the column heading to sort by ascending order. Select
the column heading again to sort by descending order.

STEP 4 | (Optional) To filter the table entries, click the filter icon to the right of the column to specify
up to two sets of criteria by which to filter the results.

STEP 5 | (Optional) To export the logs to a CSV file, click the menu icon , and then select Export Logs.

116 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

View the Rule Summary
Each rule summary and management page displays active and inactive rules for your organization and has
tools that you can use to manage the rules. To view a rule summary page or find specific rules:

STEP 1 | From the ESM Console, select the rule management page for that rule type, for example
Policies > Exploit > Protection Modules.

STEP 2 | To view the table entries, use the paging controls on the top right of each page to view
different portions of the table.

STEP 3 | (Optional) To sort the table entries, select the column heading to sort by ascending order. Select
the column heading again to sort by descending order.

STEP 4 | (Optional) To filter the table entries, click the filter icon to the right of the column to specify
up to two sets of criteria by which to filter the results.

STEP 5 | (Optional) To expand a rule entry, click the expansion arrow on the right side of the rule. From
the expanded view, you can view further rule details or take any of the actions to manage a
rule. See Save Rules on page 129.

TRAPS ADMINISTRATOR'S GUIDE | Monitoring 117

Monitor Forensics Retrieval
The Monitor > Forensics Retrieval page displays information about forensic data files and allows you to
manage the data files from a central location. Examples of data files that can be displayed on the Forensics
Retrieval page include:
ESM Tech Support Files
Logs from the agent
WildFire updates
Memory dump collection
You can sort the table entries in ascending order by selecting the column heading. Select the heading again
to sort the table entries in descending order. To narrow your results, click the filter icon to the right of
the column and specify up to two sets of criteria. You can also export the logs to a CSV file by clicking the
menu icon and selecting Export Logs. For details on the fields in the Forensics Retrieval page, refer to
the online help.

118 TRAPS ADMINISTRATOR'S GUIDE | Monitoring

Getting Started with Rules
The following topics describe the basic components and processes associated with each rule:

> Endpoint Policy Rule Concepts

> Common Rule Components and Actions
> Wildcards and Variables in Policy Rules
> Process Management

119
120 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules
Endpoint Policy Rule Concepts
Policy Rule Types
Policy Enforcement
Default Protection Policy

Policy Rule Types

A complete endpoint security policy comprises policies that target specific methods of protection. The
rules that make up each of these policies enable you to enforce protection, manage Traps settings, and take
action on your endpoints. You can configure rules that target specific objects or that take effect when they
match specific conditions and, together, these rules help to secure the endpoints in your organization.
The following table describes the types of policies you can configure in the ESM Console:

Policy Description

Malware protection Malware protection rules use protection modules to block common behavior
initiated by malicious executable files. Each rule in the malware protection
policy specifies the type of protection module used to block suspicious actions.
The rule can also include a whitelist that specifies exceptions to the rule. For
more information, see Malware Protection Rules.

Exploit protection Exploit protection rules determine the method of protection for processes that
run on your endpoints. Each rule in the exploit prevention policy specifies the
type of protection modules used to protect processes. For more information,
see Exploit Protection Rules.

Restrictions Restriction rules limit the scope of an attack by specifying where and how
executable files can run that are launched on Windows endpoints. For more
information, see Restriction Rules.

WildFire WildFire rules enable pre- and post-prevention analyses of executable files and
macros by sending unknown files to the public or private WildFire cloud. For
more information, see Configure a WildFire Rule.

Forensics Forensics rules enable you to set preferences about memory dump and
forensic file collection. For more information, see Forensics Rules.

Agent settings Agent settings rules enable you to change the values of Traps agent settings
related to logging, heartbeat frequency, and console accessibility. For more
information, see Traps Agent Settings Rules.

Action Action rules allow you to perform administrative activities on endpoints.

The one-time management actions include uninstalling and upgrading Traps,
updating licenses, protecting the Traps software, and clearing data files. For
more information, see Traps Action Rules.

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 121

Policy Enforcement
When you configure security policy rules, the Traps rules mechanism merges all configured rules into
an effective policy that is evaluated for each endpoint. To determine which rules apply to the specific
endpoint, the agent must evaluate the policy based on the following considerations:
Rule typeTraps evaluates exploit protection, malware protection, and restriction rules when a process,
executable file, or macro attempts to run. When the security policy contains multiple rules of the same
rule type and module, Traps must then evaluate the rules based on the specificity of the rule and the
modification date.
Process specificityThe more specific a rule, the higher the priority. For example, a rule configured
for a specific process takes precedence over a rule configured for all processes even if the more
generic rule was created more recently.

Modification dateWhen rules have the same level of specificity, where the core configuration is
the same across two or more rules, Traps determines which rule takes precedence to avoid rule
conflicts. For example, consider two exploit protection rules which use the same module to protect
the same process but have conflicting settings: One rule enables the module and the other disables
the module. In this case, the rule that was created or edited more recently takes precedence over an
older rule. An easy way to identify which rule is more recent is to look at the ID number assigned to
the rule. The ESM Console assigns an ID to each rule sequentially as you modify or add rules to the
security policy so a higher ID number indicates the rule was created more recently.
Target ObjectsA target object can be any user, group, organizational unit, or computer that appears in
Active Directory or any endpoint on which Traps is installed. For a rule to apply, the rule must specify
the endpoint as a target object or specify no target objects (meaning the rule applies to all objects). In
addition, the rule must not specify the endpoint as a target object from which to exclude the rule.
ConditionsA condition is an identifying characteristic on the endpoint which can be used to apply or
exclude a rule on an endpoint. For a rule to apply, the endpoint must match any conditions specified
in the rule. For example, rules with conditions for Windows 7 endpoints will apply only to Windows 7
endpoints. Similarly, the rule must not specify a condition which matches the endpoint in an exclude
condition.

Default Protection Policy

The Endpoint Security Manger is preconfigured with a default security policy which contains a curated set
of Malware Protection Rules and Exploit Protection Rules. This default security policy automatically protect
your endpoints from common software vulnerabilities, exploits, and malware techniques without requiring
additional configuration.
The following table describes the protection modules and the default configuration provided in content
update version 13. When configuring new rules, you can inherit the default behavior or you can override
the settings to meet the requirements of your organizations security policy.

122 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

Module OS Enabled by Mode User Alert
Default?

Malware Protection Modules

Child Process Protection Windows Prevention On

Gatekeeper Enhancement Mac Prevention On

Exploit Protection Modules

CPL Protection Windows Prevention On

DEP Windows Prevention On

DLL Security Windows Prevention On

DLL-Hijacking Protection Windows Prevention On

Dylib-Hijacking Protection Mac Prevention On

Exception Heap Spray Check Windows Prevention On

Exploit Kit Fingerprinting Windows Prevention On

Protection

Font Protection Windows Prevention On

Hot Patch Protection Windows Prevention On

JIT Mitigation Windows and Prevention On

Mac

Kernel Privilege Escalation Windows and Prevention On

Protection Mac

Library Preallocation Windows Prevention On

Memory Limit Heap Spray Windows Prevention On

Check

Null Dereference Protection Windows Prevention On

ROP Mitigation Windows and Prevention On

Mac

SEH Protection Windows Prevention On

Shellcode Preallocation Windows Prevention On

ShellLink Protection Windows Prevention On

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 123

 Module OS Enabled by Mode User Alert
Default?

SysExit Windows Prevention On

UASLR Windows Prevention On

124 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

Common Rule Components and Actions
Each type of rule has a specific set of required and optional fields that you can customize to meet the needs
of your organizations security policy.
The following table describes the common steps for creating an endpoint security policy rule.

Manage Rules Topic

Define the settings and actions that are specific to the For more details on the specific settings
rule type. required for each rule type, see:
Manage Malware Protection Rules
Create an Exploit Protection Rule
WildFire Integration
Manage Restrictions on Executable Files
Manage Traps Action Rules
Manage Agent Settings Rules
Manage Forensics Rules and Settings

Add activation conditions to the ruleconditions that the Conditions

endpoint must fulfill for a rule to be applied.

Define the target objects (users, computers, Target Objects

organizational units, groups, and endpoints).

Provide a descriptive name for the rule. Name or Rename a Rule

Save and optionally activate the rule. Save Rules

Manage Saved Rules

Back up or restore rules. Export and Import Policy Files

Filter the rules shown on the page. Filter Rules

View the default policy rules. Show or Hide the Default Policy Rules

Disable or enable all protection rules. Disable or Enable All Protection Rules

Conditions
A condition is an identifying characteristic on the endpoint which you can define to apply or exclude a rule
on an endpoint.
For Windows endpoints, you can define a condition to match a filename, a filename and file version, or a
registry path. You can also define a condition for a specific version of an executable file defined in the file
path. You can then use the condition to apply or exclude a rule on a Windows endpoint.
For Mac endpoints, you can configure a condition to match the bundle path or bundle ID and then use the
condition to apply or exclude a rule on a Mac endpoint.
Define Activation Conditions for a Rule on Windows Endpoints

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 125

 Define Activation Conditions for a Rule on Mac Endpoints
Include or Exclude Endpoints Using Conditions
Delete or Modify a Rule Condition

Define Activation Conditions for a Rule on Windows Endpoints

For each condition, you can specify either an executable file path, an executable file path and file version, or
a registry path that must exist on the endpoint.
Use the following workflow to create a new activation condition for a rule on Windows endpoints.

STEP 1 | Select Settings > Conditions > Windows. The Conditions page displays the unique ID number,
Name, Description, and Path (if applicable) for each condition.

STEP 2 | Click the action menu and then Add a new condition.

STEP 3 | Enter a Name and Description to identify the condition.

STEP 4 | Select the type of condition, either Path to match on the path of a specific executable file
and optionally on a specific version or range of versions for the executable file, or Registry to
match a specific registry key:
To match a specific executable file (or to match a specific version of an executable file), specify the
full Path of an executable file that exists on the endpoint. Optionally, you can use system variables in
the path. For example, specify %windir%\system32\calc.exe to apply the rule if the calculator
executable file is run from this location.
If you specified an executable file in the Path field, you can also set a match condition for a file
Version (as displayed in the file properties) or range of versions of that executable file. If you specify
a Version value, Traps will only apply the rule if the executable is run from the location specified in
the Path field and also matches the Version value. By default, the condition matches any version of
the file. To narrow the number of versions, select one of the following Version Comparison options
and then enter a Version number.

When you configure a condition to match a Version, Traps evaluates the version
value stored in the file properties. Because this number may be different than the
published version number, we recommend that you verify the version number in the
file properties before creating your condition.

The Version must follow the standard Windows version convention and be no longer
than four segments long (for example, 4.30.200.100). To match versions longer than
four segments long, use Regex.

EqualMatch an exact version.

GreaterMatch any version that is equal to or greater than the specified version.
LesserMatch any version that is equal to or lesser than the specified version.
BetweenMatch any version inclusive of and between two values. For example, to set a condition
that matches Internet Explorer versions between and including versions 8 and 9, enter C:
\Program Files\Internet Explorer\iexplore.exe in the Path field, select Version
Comparison: Between, and enter 8 and 9 in the Version fields.
RegexMatch a version using .NET Framework 4 regular expressions.
(Refer to Microsofts Regular Expression Language Quick Reference at https://
msdn.microsoft.com/en-us/library/az24scfc(v=vs.100).aspx).

126 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

 For example, to match any version of 3.1.x including 3.1, use the following regular expression:
3\.1(\.[0-9]+)?To match only versions 3.1.0-3.1.9 use:3\.1\.[0-9]To match only version
3.2 and 3.4, use: 3\.[24]
Specify a full Registry Path for a registry entry, beginning with one of the following: LocalMachine,
ClassesRoot, Users, PerformanceData, CurrentConfig, or DynData.

You cannot specify CurrentUser registry paths because Traps runs as the local
system.

Traps will only apply the rule if the endpoint contains the specified path in its registry. You can also
configure a specific registry Key or Data value (String and DWord only) as a match condition.
For example, to apply a rule on endpoints that have IPv6 enabled, configure a condition that matches
the following registry settings:
Registry Path: LocalMachine\SYSTEM\CurrentControlSet\services
\TCPIP6\Parameters\EnableICSIPv6
Key: DisabledComponents
Data: 0

STEP 5 | Save the condition.

You can use the condition as a match criteria to either include or exclude endpoints from receiving a
rule. See Include or Exclude Endpoints Using Conditions.

Define Activation Conditions for a Rule on Mac Endpoints

For each condition, you can specify either an bundle directory path or a bundle ID that must exist on the
endpoint.
Use the following workflow to create a new activation condition for a rule on Mac endpoints.

STEP 1 | Select Settings > Conditions > macOS. The Conditions page displays the unique ID number,
Name, Description, and if applicable, Path or Bundle ID for each condition.

STEP 2 | Click the action menu and then Add a new condition.

STEP 3 | Select the type of condition from the drop down, either Path or Bundle ID.

STEP 4 | Enter a Name and Description to identify the condition.

STEP 5 | Configure the settings for the Condition type:

PathSpecify the bundle directory path.

Wildcards are not supported in bundle directory paths.

Bundle IDSpecify the numeric bundle ID. To specify a bundle ID as an include or exclude condition,
enter the unique ID number. You can optionally specify match conditions for the bundle version.

STEP 6 | Save the condition.

You can use the condition as a match criteria to either include or exclude endpoints from receiving a
rule. See Include or Exclude Endpoints Using Conditions.

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 127

Include or Exclude Endpoints Using Conditions
By configuring conditions, you can activate rules for only those endpoints that match the condition. For
example, consider a condition that matches Windows XP client systems. When you add that condition to an
include list, the rule will apply only if the client system is running Windows XP. Conversely, if you add that
same condition to an exclude list, the rule will apply to all client systems except those running Windows XP.
After you add a condition to a list (include or exclude), you cannot use it in the other list.
Use the following workflow to include or exclude an endpoint from a rule using conditions.

STEP 1 | From the rule configuration page, select the Conditions tab.

STEP 2 | Select a condition and Add it to the include or exclude list. To select multiple conditions, press
and hold the Ctrl key while selecting.

STEP 3 | Configure the rule settings and then Save or Apply the rule (see Save Rules on page 129).

Delete or Modify a Rule Condition

Rule activation conditions are conditions that the endpoint must fulfill for a rule to apply to that endpoint.
After you create a condition, you can delete or modify it from the Conditions page.

STEP 1 | Select Settings > Conditions. The Conditions page displays the unique ID number, Name, and
Description for each condition.

STEP 2 | Select the condition that you want to modify or delete.

STEP 3 | Do either of the following.

Click Delete to discard the condition.
Modify the condition settings, and then Save the changes.

Target Objects
Target objects define the scope of a rule and the endpoints to which a rule applies. An object can be one of
the following:

Target Object Description

Users A user defined in Active Directory.

Groups A user group defined in Active Directory.

Computers The name of a computer or mobile device defined in Active Directory.

Organizational Unit A subdivision within Active Directory into which you can place users,
groups, computers, and other organizational units.

Existing Endpoints A computer or mobile device on which the Traps agent is installed.
The Endpoint Security Manager identifies existing endpoints by
communication messages it receives from Traps agents.

For objects defined in Active Directory, the ESM Console provides autocompletion as you type.

128 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

 Computer names may be offered as autocompletions even if they are not presently running
Traps.

You can apply rules to all objects, to selected objects, or to all objects except those in the Exclude list.
Rules that you define for users and groups will apply to those users and groups, regardless of the endpoint
on which they log in.

Name or Rename a Rule

The ESM Console automatically generates the rule name and description based on the rule details and
time of creation. To override the autogenerated name, select the Name tab, clear the Activate automatic
description option, and then enter your own rule name and description.

The rule that is modified or edited most recently takes precedence over older rules of the
same type. As a result, changing the name of a rule changes the modification date for the
rule and can cause the edited rule to override older rules.

The rule description is a good place to record the business reasons for the creation of a rule.
For example, you might include an incident identification number or a link to a help desk
ticket.

Save Rules
To save a rule, you must complete all required fields for that rule type. Tabs with required fields are
indicated by a red tab background.

Complete the required fields before attempting to save or modify a rule.

After specifying the required fields for a rule, you can select one of the following actions:

Action Description

Save Save the rule without activating it. The status of the rule is shown as Inactive,
and you can activate it later. This option is only available for inactive, new, or
cloned default rules.

Apply Save the rule and activate it immediately. The ESM Server sends the updated
rule at the next heartbeat communication with the Traps agent. However, you
can trigger a policy update by clicking Check In Now in the Traps console on
an endpoint.

Manage Saved Rules

After saving the rule, the name and description appear in the appropriate system logs and tables.
Select the rule to view details and perform any of the following actions:

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 129

 Action Description

Duplicate (Action rules only) Create a new rule from an existing rule.

Delete Discard the rule; the rule is removed from the system.
To delete multiple rules at the same time, select the rules and then select
Delete Selected (non-Default) from the action menu at the top of the
table.

Activate/Deactivate If the rule was previously saved but not applied, you can Activate the rule to
add it to the current security policy. If the rule is active, you can Deactivate it
to remove the rule from the current security policy but not from the system.
To activate or deactivate multiple rules at the same time, select the rules and
then select Activate Selected or Deactivate Selected from the menu at the
top of the table. To disable or enable all exploit, malware, or forensics rules,
see Disable or Enable All Protection Rules.

Edit Edit the rule definition. Selecting this option opens the rule configuration
dialog and allows you to change the rule definition. For more information, see
Create an Exploit Protection Rule.

Import Rules/Export From the action menu at the top of the table, you can import rules or
Selected export selected rules. Exporting rules saves the selected rules to an XML file.
For more information, see Export and Import Policy Files.

Show Default From the action menu at the top of the table, you can expand the default
Rules/Hide Default rules or hide default rules. Select the rule to view additional information about
Rules the rule. For more information, see Show or Hide the Default Policy Rules.

Clone When you show default rules and then select a rule, the ESM Console
displays additional details about the rule settings and an option to Clone the
rule. Cloning enables you to create a new rule that overwrites the default
policy settings. For more information, see Show or Hide the Default Policy
Rules.

Filter Rules
Each rule summary and management page in the ESM Console displays details about the rules that define
your organizations security policy. To narrow the number of rules that the ESM Console displays, you can
filter the rules using the filter control at the top of each column. Use the filter control to define either one
or two values to filter on rule status, rule name, rule description, or modification date.
The operators that are available for each column depend on the column type. For example, you can filter
columns that display text using any of the following operators to search for a string value: Is equal to, Is not
equal to, Starts with, Contains, Does not contain, or Ends with. For columns that display a date, you can
filter for a specific date or a date range using any of the following operators: Is equal to, Is not equal to, Is
after or equal to, Is after, Is before or equal to, or Is before.

The ESM Console identifies columns that have active filters with an applied filter icon and a blue
background. To remove the filter, click the icon and then select Clear.
The following table shows the columns, operators, and values that you can use to filter the rules.

130 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

 Column Operators Value

Rule Status Is equal to PendingNot used.

Is not equal to ActiveApplied rules.
Starts with InactiveDeactivated rules.
Contains HistoricDeleted rules.
Does not contain MigratedNot used.
Ends with

Name Is equal to <string>

Is not equal to
Starts with
Contains
Does not contain
Ends with

Description Is equal to <string>

Is not equal to
Starts with
Contains
Does not contain
Ends with

Date Modified Is equal to <mm/dd/yyyy>

Is not equal to
Is after or equal to
Is after
Is before or equal
to
Is before

Disable or Enable All Protection Rules

If the endpoint protection security policy is causing issues for endpoints in your organization, you can
quickly disable all active policy rules including the default policy rules. Disabling protection effectively
removes all restrictions and halts the following tasks:
Traps injection into all processes that run in the future
Validation against WildFire
Further data collection
Modifying security policy rules while all protection is disabled has no effect until protection is re-enabled.
After disabling protection and resolving the issues, you can restore all the policy rules at the same time by
enabling all protection. (Enabling protection does not activate rules that were previously deactivated.)
In a scenario where you need to disable only a single rule or small group of rules, you can individually select
and deactivate those rules from the rule management page specific to that rule type.

STEP 1 | From the ESM Console, select any rule management page, such as Policies > Malware >
Restrictions.

STEP 2 | Select the action menu .

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 131

STEP 3 | Do either of the following:
To disable protection, select Disable All Protection. The ESM disables all rules and sends the updated
security policy to the endpoints at the next heartbeat communication with the Traps agents.
To enable protection, select Enable All Protection. The ESM re-enables all rules and sends the
updated endpoint protection security policy to the endpoints at the next heartbeat communication
with the Traps agents.

Show or Hide the Default Policy Rules

The Endpoint Security Manager security policy comes preconfigured with rules that protect against attacks
that leverage common software vulnerabilities, exploits, and attack vectors.
When configuring new rules, you can inherit the default behavior or you can override settings as needed to
customize your organizations security policy.
To reduce the number of rules you see in your security policy, the default rules are collapsed under a single
default policy.

Show Default Rules

To expand and view the default policy rules, select Show Default Rules from the action menu at the
top of the page.

Hide Default Rules

To collapse the list of rules, select Hide Default Rules from the action menu at the top of the page.

Modify a Default Rule

To override a default rule, you can clone the rule and edit the settings. In the case of similar rules, the
more recent rule takes precedence over the older rule.
1. Select Show Default Rules from the action menu at the top of the page.
2. Select the desired rule to view additional details.
3. Clone the rule and edit the settings as desired.
4. Save or Apply the rule when finished.

132 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

Wildcards and Variables in Policy Rules
For ease of configuration, you can use wildcards or variables to represent the full or partial filename, folder
path, or process name in policy rules.
The policy rules which support wildcards and variables are:
Execution restriction rules
Global restriction settings
Child processes rules
The ESM Console supports in many policy rules where you would specify a file or folder path or process
name. For example, when you configure local or network folder restrictions, you can add one or more files
or folders using wildcards or environment variables to a whitelist or blacklist.
Wildcards in Policy Rules
Environment Variables in Policy Rules
Example: Using Wildcards and Variables in Policy Rules

Wildcards in Policy Rules

The following table displays the wildcards that you can use in policy rules to match a filename (regardless
of location), a file located within a specific folder or folder path, or any file within a specific folder or folder
path.

Value Purpose

? Matches a single character. For example, Wor?.exe matches Word.exe

and Worm.exe.

* Matches any string of characters. For example, Word*.exe matches

Word11.exe and Word2013.exe.

Environment Variables in Policy Rules

In addition to wildcards, policy rules also support native environment variables, including user- and system-
wide variables. Restriction rules also support the use of multiple environment variables as long as the
environment variable does not expand to another environment variable. You can use many environment
variables that are supported by the Windows OS but some environment variables, including this specific set
of variables, are not supported:
%USERNAME% environment variable
Environment variables that are private
Recursive environment variables which include other environment variables in their definition (for
example, %MySystemDrive% with a definition of %SystemDrive%)
The following topics describe supported environment variables in Windows and examples of the target
values.
Environment Variable Support for Windows Vista and Later Releases
Environment Variable Support for Windows XP

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 133

Environment Variable Support for Windows Vista and Later
Releases
The following table displays environment variables and target values supported on endpoints running
Windows Vista and later releases.

The %CommonProgramFiles(x86)% and %ProgramFiles% environment variables

expand to the native value of the machine. On 64-bit machines, the environment variable
expands to the 64-bit value even when operating on behalf of a 32-bit process. On 32-bit
machines, the environment variables expands to the file path provided by the application.

Environment Variable Example Value

%ALLUSERSPROFILE% C:\ProgramData

%CommonProgramFiles% C:\Program Files\Common Files

%CommonProgramFiles(x86)%(64-bit only) C:\Program Files (x86)\Common Files

%CommonProgramW6432% (64-bit only) C:\Program Files\Common Files

%ProgramFiles% C:\Program Files

%ProgramFiles(x86)% (64-bit only) C:\Program Files (x86)

%ProgramW6432% (64-bit only) C:\Program Files (x86)

%ProgramData% C:\ProgramData

%SystemDrive% C:

%SystemRoot% C:\Windows

%TEMP% and %TMP% C:\Users\<username>\AppData\Local\Temp

%USERPROFILE% C:\Users\<username>

%windir% C:\Windows

%COMPUTERNAME% <computername>

%ComSpec% %SystemRoot%\system32\cmd.exe

%FP_NO_HOST_NAME% NO

%NUMBER_OF_PROCESSORS% 1

%OS% Windows_NT

%PATH% %SystemRoot%\system32;%SystemRoot%...

%PATHEXT% .COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC

134 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

 Environment Variable Example Value

%PROCESSSOR_ARCHITECTURE AMD64
%

%PROCESSOR_IDENTIFIER% Intel64 Family 6 Model 69 Stepping 1, GenuineIntel

%PROCESSOR_LEVEL% 6

%PROCESSOR_REVISION% 4501

Environment Variable Support for Windows XP

The following table displays examples of environment variables and target values supported on endpoints
running Windows XP.

Environment Variable Example Value

%ALLUSERSPROFILE% C:\Documents and Settings\All Users

%CommonProgramFiles% C:\Program Files\Common Files

%ProgramFiles% C:\Program Files

%SystemDrive% C:

%SystemRoot% C:\Windows

%TEMP% and %TMP% C:\Documents and Settings\<username>\Local Settings\Temp

%USERPROFILE% C:\Documents and Settings\<username>

%windir% C:\Windows

%COMPUTERNAME% <computername>

%ComSpec% %SystemRoot%\system32\cmd.exe

%FP_NO_HOST_NAME% NO

%NUMBER_OF_PROCESSORS% 1

%OS% Windows_NT

%PATH% %SystemRoot%\system32;%SystemRoot%

%PATHEXT% .COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC

%PROCESSSOR_ARCHITECTURE x86
%

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 135

 Environment Variable Example Value

%PROCESSOR_IDENTIFIER% x86 Family 6 Model 58 Stepping 9, GenuineIntel

%PROCESSOR_LEVEL% 6

%PROCESSOR_REVISION% 3a09

Example: Using Wildcards and Variables in Policy Rules

The following table displays examples of using wildcards and variables to specify a filename (regardless of
location), a file located within a specific folder or folder path, or any file within a specific folder or folder
path.

Example Result

C:\temp\a.exe Matches only the a.exe file and only if launched from the C:\temp folder

%TEMP%\a.exe Matches only the a.exe file and only if launched from the C:\Users
\<username>\AppData\Local\Temp folder on Windows Vista and
later machines or C:\Documents and Settings\<username>\Local
Settings\Temp on Windows XP machines

C:\temp* Matches any file launched from the C:\temp folder or from any folder or
subfolder in a filepath that begins with C:\temp (for example, C:\temp
\folder\a.exe, C:\temp1\a.scr, and C:\temporary\folder
\b.exe)

C:\temp\* Matches any file launched from the C:\temp\ folder or subfolder (for
example: C:\temp\a.scr and C:\temp\temp2\b.exe)

C:\temp\a?.exe Matches any file beginning with a and followed by a second character
launched from the C:\temp\ folder (for example: C:\temp\a1.exe and
C:\temp\az.exe)

C:\temp*.exe Matches any executable file with an .exe file extension, a filename that
begins with temp, and that is launched from the C:\ drive (for example,
C:\temp1.exe and C:\temporary.exe) and matches any executable
file with an .exe file extension that is launched from any folder or subfolder
in a filepath that begins with C:\temp (for example, C:\temp\folder
\a.exe, C:\temp1\b.exe, and C:\temporary\folder\c.exe)

C:\temp\*.exe Matches any executable file with an .exe file extension that is launched
from the C:\temp\ (or equivalent %SystemDrive%\temp\ folder) or
%SystemDrive%\temp
from any folder or subfolder in a filepath that begins with C:\temp\
\*.exe

*\a.exe Matches only the a.exe file regardless from which location it is launched

%SystemDrive%\ When %MyVar% is equal to a filename, for example myfile.exe, this

%MyVar% matches that filename when launched from the %SystemDrive% folder (in
most cases C:\)

136 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

Example Result

a.exe (Java restriction rules only) Matches only the a.exe file regardless from
which location it is launched

Java restriction rules require you to include the .exe at the

end of the filename.

C:\temp Does not match any executable files because the path is not a full path
(partial paths must contain at least one wildcard to be useful)
C:\temp\

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 137

Process Management
Process Protection Types
Processes Protected by the Default Policy
Add a New Protected Process
Import or Export a Process
View, Modify, or Delete a Process
View Processes Currently Protected by Traps

Process Protection Types

The ESM Console categorizes each process by a Protection Type:
ProtectedIndicates that the process is actively protected by exploit protection rules that apply to all
processes. You can also configure process-specific rules that only apply to select processes.
ProvisionalIndicates that the process is undergoing a test run as a protected process, usually on a small
number of endpoints and with a small number of rules. After the test run completes and you make any
necessary adjustments to the associated rules, you can change the protection type of the process to
Protected.
UnprotectedA process is categorized as Unprotected when Traps first discovers a new process on an
endpoint in your organization. Although your malware protection and WildFire policies automatically
protect these processes, you must categorize new processes as Protected or Provisional processes to
apply the exploit protection policy.

Processes Protected by the Default Policy

The Endpoint Security Manager and Traps come preconfigured to protect common applications and
processes on Windows and Mac endpoints. These processes vary depending on the associated content
update version. To determine which processes are supported in a given release, look up the content update
version associated with the release (see Associated Software Versions) and then review the release notes
for the content update on the Support portal.

The process type, as shown on the Process Management page, does not indicate whether
a process is used in the default security policy. Instead, the process type only indicates
whether the process can be used in an exploit protection rule. For more information, see
Process Protection Types.

Add a New Protected Process

A process is an active instance of a program that is executed by the operating system. From the Windows
Task Manager on Windows endpoints or the macOS Activity Monitor on Mac endpoints, you can view
all active processes that are currently running including the names of core system processes. Many core
system processes are protected by the operating system and cannot be renamed. Changing the name of
these system processfor example, changing the name of the calc.exe process to calc1.execan cause the
process to stop functioning. Because Traps identifies processes by name, changing the name of a process
can also prevent Traps from applying protection rules to the new process name.
The ESM Console is preconfigured with a Default Protection Policy that protects the most vulnerable and
most commonly used processes on Windows and Mac endpoints. You can protect additional uncommon,
third-party, and proprietary processes by adding their names to the list of protected processes. Each rule in
the exploit protection policy protects one or more processes from a specific type of exploit or vulnerability
using exploit protection modules (EPMs). Depending on the configuration, Traps can activate the EPM in all

138 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

 processes or in specific process names. Adding a new process to the list of protected processes enables you
to automatically protect the process-without any additional configuration-using any exploit protection rules
that apply to all processes.

To ensure process protection continues, we recommend that you do not change the names
of commonly used processes on the system. If a process name change is required, ensure
that you add the renamed process as a protected process and mirror the protection rules for
the old process name. As needed, you can also configure additional exploit protection rules
to protect the process.

By extending protection to the applications that are important to your organization, you can provide
maximum protection with minimal disruption of day-to-day activities. Add processes as either protected,
provisional, or unprotected and configure them using the Process Management page.

You can configure only exploit protection rules on Protected or Provisional processes.

You cannot change the default Protected processes that are included in the initial setup.
Consult the Palo Alto Networks support team for questions.

STEP 1 | Navigate to the Process Management page.

From the ESM Console, select Policies > Exploit > Process Management.

STEP 2 | Select the operating system, either Windows or macOS.

STEP 3 | Add a new process.

1. From the action menu , select Add.
2. Enter the Process name.
3. To actively protect the process using default and user-defined rules, set the Protection type to
Protected. For additional options, see Process Protection Types.

STEP 4 | Save your changes to the process.

Click Create.

STEP 5 | For each new protected process, configure an exploit protection rule to activate the ROP
Mitigation EPM in the process and another exploit protection rule to activate the JIT
Mitigation EPM in the process. These exploit protection rules provide the best protection
with the lowest false-positive rate.

1. For each EPM, Create an Exploit Protection Rule with the following settings:
EPM:
ActivationOn

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 139

 ActionNotification
User AlertOff
Processes:
Select the new protected process.
Objects:
To identify any unintended consequences of protecting the new process, select a small number
of endpoints. If you have different environments within your organization (for example, different
operating systems), we recommend that you select a few endpoints in each environment.
2. Apply the rule and then repeat the process for the second EPM.
3. After a period in which no issues are caused by the new rules, update and then apply the rule
settings:
EPM:
ActionPrevention
User AlertOn
Objects:
Expand the rule deployment: Add additional objects or remove all objects. In the case of the latter, if
no objects are specified, the rule applies to all endpoints.

Import or Export a Process

Use the export and import features in the ESM Console to back up one or more process definitions used
in your security policy. The export and import features allow you to back up processes before migrating
or upgrading to a new server, or deploying a managed process to multiple independent servers. You can
export processes on a global or individual basis and save them to an XML file. The import feature appends
imported processes to the existing list of default and added processes and also displays their protection
types.

STEP 1 | Navigate to the Process Management page.

From the ESM Console, select Policies > Exploit > Process Management.

STEP 2 | Select the type of operating system for which you want to manage processes, either Windows
or macOS.

STEP 3 | Import or export one or more processes.

To import processes, click the action menu and then select Import Processes. Browse to and
Upload the file containing details about processes you want to import. The processes appear in the
table after the upload is complete.
To export processes, select one or more processes that you want to export. From the action menu
, select Export Selected. The ESM Console saves the processes to an XML file.

View, Modify, or Delete a Process

The Processes Management page in the ESM Console displays all the processes that your organizations
security policy protects. To change or delete a process, you must first remove the process from any
associated rules.

STEP 1 | Navigate to the Process Management page.

From the ESM Console, select Policies > Exploit > Process Management.

140 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

STEP 2 | Select the type of operating system for which you want to manage processes, either Windows
or macOS.

STEP 3 | View the processes in the Process Management table.

Use the paging controls at the top of the table to view different portions of the table.
The following fields are displayed:
ProcessFilename of the process executable file.
Protection TypeProtected, Unprotected, or Provisional.
ComputersNumber of endpoints on which the process has run.
Linked RulesNumber of rules configured for the process.
Discovered OnName of the endpoint on which the process was first discovered.
First SeenDate and time the process was first discovered on the endpoint (after receiving a rule to
report new processes).

STEP 4 | Delete or change the process.

If the process is used in any rules, you must first unlink (remove) the process from the rule.

You can not unlink processes from default rules and, as a result, you cannot remove any
processes specified in default rules.

After the process is unlinked, you can select the name of the process and do any of the following:
Delete the process.
Change the Process Name and then Save your changes.
Change the Protection Type and then Save your changes. For more information, see Process
Protection Types.

View Processes Currently Protected by Traps

The Protection tab on the Traps console displays processes run by the current user that are currently
protected by Traps. The list of processes reflects the processes that were executed by the current user.
To view all processes protected by Traps including those run by other users or by the operating system, use
the Traps console or a command-line interface called Cytool (see View Processes Currently Protected by
Traps Using Cytool).

Figure 1: Running Processes Detected by Traps on Windows Endpoints

TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules 141

 Figure 2: Running Processes Detected by Traps on Mac Endpoints

On Windows endpoints, Traps displays the name, description, unique process ID number, time the process
was initiated, and memory allocation register.
On Mac endpoints, Traps displays the name and unique process ID number.
STEP 1 | Launch the Traps Console:
From the Windows tray, double-click the Traps icon or right-click the icon and select Console.
Run CyveraConsole.exe from the Traps installation folder.
The Traps Console launches.

STEP 2 | Select the Advanced > Protection tab to view the protected processes.

142 TRAPS ADMINISTRATOR'S GUIDE | Getting Started with Rules

Malware Protection
> Malware Protection Policy Best Practices
> Malware Protection Flow
> Manage Malware Protection Rules
> Manage Restrictions on Executable Files
> WildFire Integration
> Manage Hashes for Executable Files

143
144 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection
Malware Protection Policy Best Practices
The key principle when defining a malware protection policy is to minimize the chance of infection from
known and unknown malware. To achieve this goal, the best practice malware protection policy uses
WildFire rules that enable Traps to identify and block all known threats and send unknown files for analysis
and identification by WildFire. In addition, the best practice malware protection policy enables Traps to
take advantage of built-in mechanisms to analyze unknown executable files and determine the likelihood of
malware. Consider the following recommendations when creating a malware protection policy:
Enable WildFire integration to allow Traps to evaluate executable files based on their WildFire verdicts.
WildFire integration is automatically enabled in the default policy. Therefore, if you need to create new
WildFire rules, ensure that WildFire Activation is On. See Configure a WildFire Rule.
Block the execution of malware. The easiest way to prevent malware from causing harm to your
endpoints is to block its execution. To do this, the Action in the WildFire policy for executable and
Microsoft Office files (containing macros) must be set to Prevention. Because the default policy
configures this setting, we recommend that you leave the default setting, or if you need to create new
rules, inherit the action from the default policy. See Configure a WildFire Rule.
Enable Traps to submit unknown executable files to the ESM Server and enable the ESM Server to send
those samples to WildFire for analysis. By submitting the samples, you take advantage of advanced
WildFire threat intelligence which enables analysis and identification of zero-day malware. WildFire
also makes information about newly-discovered executable files available globally to other ESMs (upon
query) and to Palo Alto Networks firewalls (within minutes). This enables you and other Palo Alto
Networks customers to transform unknown samples to known samples thus reducing the time spent
determining the nature of the unknown executable file. Because the default policy configures this
setting, no additional action is required to enable this functionality. However, if you need to create new
rules, ensure that you configure the Unknown Verdict Configuration to block unknown executables and
enable Traps agents to Upload Files for WildFire Analysis. See Set Up the ESM to Communicate with
WildFire.
Enable Traps to perform local analysis on unknown executable files to determine if they are likely to be
malware. Local analysis uses a statistical model that was developed using machine learning on WildFire
threat intelligence. When enabled, local analysis uses the model to issue a local verdict for the file. Traps
simultaneously queries the ESM Server for a verdict for the unknown executable but can use the local
analysis verdict until the ESM Server responds with either an official WildFire verdict or administrative
hash control policy. Because the default policy configures this setting, no additional action is required
to enable this functionality. However, if you need to create new rules, ensure that you enable Local
Analysis. See Local Static Analysis.
Install the latest content update. Each content update packages the latest Palo Alto Networks threat
intelligence into a default security policy file. The content update can include changes to the list of
trusted signers, local analysis model, compatibility rules, and default rule configuration settings. By
installing the latest content update, you can ensure that your endpoints take advantage of this threat
intelligence. See Content Updates.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 145

Malware Protection Flow
To protect the endpoint from malicious and unknown executable files, the malware prevention engine
employs three methods of protection:
WildFire analysis of known and unknown executable files
Restriction policy rules that examine the source of the file
Malware protection modules that target behaviors commonly initiated by malicious processes

Phase 1: Evaluation of the Malware Protection Policy

Phase 2: Evaluation of the Restriction Policy
Phase 3: Evaluation of Hash Verdicts

Phase 1: Evaluation of the Malware Protection Policy

When a user first tries to open an executable file, Traps evaluates the malware protection policy and
observes the behavior of the file. If the file exhibits malicious behavior as determined by your malware
protection policy, Traps halts the file from executing and prevents the malicious behavior from continuing.
For example, consider a case where you have a child process protection rule that prevents a processes from
creating specific child (target) processes. If the file launches and then attempts to create child processes
defined in the malware protection policy, Traps blocks the file from opening and reports the security event
to the Endpoint Security Manager.
If no malicious behavior is detected, Traps next moves onto Phase 2: Evaluation of the Restriction Policy.

Phase 2: Evaluation of the Restriction Policy

When a user or machine attempts to open an executable file, Traps first evaluates the malware protection
policy as described in Phase 1: Evaluation of the Malware Protection Policy. If the executable file is
not exhibiting any malicious behavior, Traps next verifies that the executable file does not violate any
restriction rules. For example, you might have a restriction rule that blocks executable files launched from
network locations. If a restriction rule applies to an executable file, Traps blocks the file from executing and
reports the security event to the Endpoint Security Manager and, depending on the configuration of each
restriction rule, Traps can also notify the user about the prevention event.
If no restriction rules apply to an executable file, Traps next evaluates the verdict for the file (see Phase 3:
Evaluation of Hash Verdicts).

Phase 3: Evaluation of Hash Verdicts

When WildFire is enabled (see Set Up the ESM to Communicate with WildFire), Traps calculates a unique
hash using the SHA-256 algorithm for every executable file and macro that attempts to open on the

146 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 endpoint. Depending on the WildFire features that you enable, the Traps WildFire module performs
additional analysis to determine whether an unknown executable is malicious or benign. Traps can also
submit unknown executable files to the ESM Server for in-depth analysis by WildFire.
The evaluation stages are described in more detail in the following sections:
Administrative Hash Control Policy
Trusted Signers
WildFire Verdict
Local Static Analysis

Administrative Hash Control Policy

The administrative hash control policy (also referred to as a verdict override or simply hash control policy),
enables you to change the verdict for a specific executable file or macro without affecting your WildFire
integration settings. The hash control policy is evaluated first and takes precedence over all other methods
to determine the hash verdict.
From the ESM Console, you can configure a verdict override for any of the following situations:
You want to block a file that has a benign verdict.
You want to allow a file that has a malware verdict. In general, we recommend that you only override
the verdict for malware after you use available threat intelligence resourcessuch as WildFire and
AutoFocusto determine that an executable file is not malicious.
You want to specify verdict for an executable file that has not yet received an official WildFire verdict
After you configure a hash control policy, the ESM Server distributes it at the next heartbeat
communication with any endpoints that have previously opened the file.
When an executable file or macro launches on the endpoint, Traps first evaluates whether a hash control
policy is configured for the file. The hash control policy specifies whether or not Traps should either treat
the file as malware. If the file is assigned a benign verdict, Traps permits it to open.
If a hash control policy is not configured for the file, Traps next employs the WildFire module to determine
the verdict. The WildFire module uses a three-step evaluation process in the following order to determine
the verdict: Trusted Signers, WildFire Verdict, and then Local Static Analysis.

Trusted Signers
Legitimate software is often signed by a trusted signer to signify that the software has not been altered
or tampered with. Palo Alto Networks regularly reviews and makes changes to the list of trusted signers
and makes the list available with the default security policy. Any updates to the list of trusted signers are
made available with content updates that you can obtain from the Support portal (for more information, see
Content Updates on page 101).
When a user attempts to open an unknown executable file for which a hash control policy does not exist,
the WildFire module begins the verdict evaluation process by verifying whether an executable file is signed
by a trusted signer.
If the executable file is signed by a trusted signer, the file is considered benign and is locally exempt from
additional WildFire verification and local analysis. As long as execution restrictions and malware protection
rules do not apply to the executable file, Traps permits it to open. If Traps blocks a file that is signed by a
trusted signer (for example, if the file was signed by a trusted signer but violated a restriction rule), the ESM
Console displays the signer information in the new Source Signers field in the security event details.
If the executable file is not signed by a trusted signer, Traps next evaluates the official WildFire Verdict on
page 148.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 147

 In very rare occasions, WildFire can return a malicious file verdict for an executable file that
is signed by a trusted signer. If this rarity occurs, the ESM Console reports a Post Detections
event. You can review these events in the Post Detections area of the Security Events
page. To override the default behavior, which permits the executable file to run, configure an
administrative hash control policy to block the file.

WildFire Verdict
If an executable file is not signed by any Trusted Signers, the Traps agent performs a hash verdict lookup to
determine if a verdict already exists in its local cache.
If the executable file has a malware verdict, Traps reports the security event to the Endpoint Security
Manager and, depending on the configured behavior for malicious files, Traps then does one of the
following:
Blocks the malicious executable file
Notifies the user about the file but still allows the file to execute
Logs the issue without notifying the user and allows the file to execute.
If the verdict for a hash indicates that the associated file is benign, Traps moves on to the next stage of
evaluation (see Phase 2: Evaluation of the Restriction Policy).
If the hash does not exist in the local cache or has an unknown verdict, Traps performs Local Static Analysis.

Local Static Analysis

Local analysis enables Traps to examine hundreds of characteristics of an unknown executable file to
determine if it is likely to be malware. The local analysis module uses a statistical model that was developed
using machine learning on WildFire threat intelligence.
Traps performs local analysis only on unknown executable files on Windows endpoints and enables Traps
to issue a local verdict (benign or malicious) while the endpoint is offline or the ESM Server is unreachable.
Traps can rely on the local analysis verdict until it receives an official WildFire verdict or updated hash
control policy.
Local analysis is enabled by default in the WildFire policy. Because local analysis always returns a verdict for
an unknown executable file, enabling the Unknown Verdict Configuration to Block unknowns only applies
to agents for which local analysis is not enabled or for agents running versions earlier than Traps 3.4. To
change the default settings, clone the default WildFire rule and disable Local Analysis (not recommended).
For more information, see Configure a WildFire Rule.

148 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

Manage Malware Protection Rules
Malware protection rules enable you to restrict malware-related behavior. When enabled, these modules
use a whitelist model that allows process injection for only those processes specified in the policy. The
default malware protection policies that come preconfigured with the ESM software grant exceptions to
common legitimate processes that must inject into other processes or modules.
When new malware protection rules are added to the security policy, the Traps rules mechanism merges
all configured rules into an effective policy that is evaluated for each endpoint. In the case of a potential
conflict between two or more rules, there are a set of considerations, such as modification date, that
determine which rule takes effect (for more information, see Policy Enforcement). To retain whitelists
across malware protection rules, you can opt to merge the whitelists.

For additional questions about configuring malware protection rules, contact Support team or
your Sales Engineer.

Malware Protection Rules

Configure Child Process Protection
Configure the Gatekeeper Enhancement MPM

Malware Protection Rules

A malware protection rule prevents the execution of malware, often disguised as or embedded in non-
malicious files, by using malware modules to target process behaviors that are commonly triggered by
malware.
You can activate malware protection modules in all processes or enable protection of one or more
protected processes in your organization.
The following table describes the malware protection modules:

Malware Protection Description

Rules

Child Process (Windows only) The Child Process Protection MPM prevents script-based
Protection attacks used to deliver malware such as ransomware by blocking known
targeted processes from launching child processes commonly used to bypass
traditional security approaches. For more information, see Configure Child
Process Protection.

Gatekeeper (Mac only) The Gatekeeper Enhancement MPM is an enhancement of the

Enhancement macOS gatekeeper functionality which allows apps to run based on their
digital signature. The MPM provides an additional layer of protection by
extending gatekeeper functionality to child processes to enforce the signature
level of your choice. For more information, see Configure the Gatekeeper
Enhancement MPM.

Configure Child Process Protection

The Child Process Protection MPM supersedes the Child Processes restriction rule and
whitelist available in Traps 3.4 and earlier releases. To enable you to manage child process
rules and whitelists on endpoints running earlier Traps versions, the existing child process

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 149

 functionality is retained in the ESM Console. To configure child process restrictions or
whitelists for endpoints running Traps 3.4 or earlier releases, see Define Child Process
Restrictions and Manage Global Whitelists.

The Child Process Protection MPM for Windows endpoints prevents script-based attacks used to deliver
malware such as ransomware. To prevent these attacks, the MPM is enabled by default and blocks
known targeted processes from launching child processes commonly used to bypass traditional security
approaches.
For increased flexibility, you can configure the module to operate in one of two ways:
Use a whitelist to block all child processes initiated by a process except for those specified in the
whitelist.
Use a blacklist to allow a process to run all child processes except for those specified in the blacklist.
To control how new rules inter-operate with existing rules, you can also choose to merge or override
settings in rules that apply to the same parent process.
Use the following workflow to configure enhanced child process protection:

STEP 1 | Configure a new malware protection rule.

Select Policies > Malware > Protection Modules.

STEP 2 | Select Windows as the operating system (child process protection is not supported on Mac
endpoints).

STEP 3 | From the action menu , select Add.

STEP 4 | Select Child Process Protection and configure the rule settings:
ActivationSelect On to enable child process protection or Off to disable child process protection.
ActionSelect the action to take when a process attempts to call a child process: Block the child
process from running (Prevention), or permit the child process to run and log the issue (Notification).
If you choose to Inherit the behavior, Traps defers to the default policy for the action.

To view additional details about the default policy, select Policies > Malware >
Protection Modules, and then select Show Default Rules from the action menu.
User AlertSpecify the notification behavior when a process attempts to call a child process, either
On to notify the user, or Off to suppress notifications. If you choose to Inherit the behavior, Traps
defers to the default policy for the notification behavior.

STEP 5 | Configure a child process whitelist or blacklist:

1. Select the List Behavior: Use Allowed Processes to configure a whitelist or Restricted Processes to
configure a blacklist.
2. To block or allow a parent process to run all child processes, leave the Child Process List blank.
Otherwise add one or more processes to the Child Process List (one per line). Traps whitelists or
blacklists these processes according to the List Behavior you selected in the previous step.
For example, to block cscript.exe and wscript.exe when run from winword.exe, configure a Restricted
Processes list for winword.exe and add the scripts to the Child Process List.
The Child Process List also supports the same environment variables and wildcards that you can
use in restriction rules. For example, to configure a rule for iexplorer.exe which blocks that process
from launching SCR files from the temp folder, you can use environment variables and wildcards to
specify %temp%\*.scr. For more information about using environment variables and wildcards, see
Wildcards and Variables in Policy Rules.

150 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 3. Select the List Action to Merge or Override the child process list with lists defined in other user-
defined or default policy rules for the parent process.

If multiple rules exist for the same parent process that specify List Action: Merge,
Traps consolidates the Child Process List (either the whitelist or blacklist). If multiple
rules exist for the same parent process that specify List Action: Override, only the
most recent rule (with the highest ID number) takes precedence.

If multiple rules exist for the same parent process but use different list behaviors (for example, one
as a whitelist and one as a blacklist), only the most recent rule (with the highest ID number) takes
precedence.

STEP 6 | Select the Processes tab and Add one or more source (parent) processes to which Traps will
apply child process protection. As you type, the ESM Console provides auto-completion based
the list of processes defined in the ESM Console.

STEP 7 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 8 | (Optional) Define the Target Objects to which to apply the restriction rule.
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 9 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 10 | Save the exploit protection rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Exploit > Protection
Modules page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Protection Modules page at any time to Delete or
Deactivate the rule.

Configure the Gatekeeper Enhancement MPM

The Gatekeeper Enhancement MPM is an enhancement of the macOS gatekeeper functionality which
allows apps to run based on their digital signature. The MPM provides an additional layer of protection
by extending gatekeeper functionality to child processes to enforce the signature level of your choice (for
example by Apple System, Mac App Store, or Developers).
By enforcing the signature level you can prevent attackers from leveraging a logical vulnerability in an
existing process to bypass the OS verification of the signature level. You can also choose to allow child

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 151

 processes to run if they match (or exceed) the signature level of the parent process or you can block all child
processes regardless of digital signature.
This module is enabled by default for select macOS apps and supported on Mac endpoints.
To configure the Gatekeeper Enhancement EPM, use the following workflow:

STEP 1 | Configure a new malware protection rule.

Select Policies > Malware > Protection Modules.

STEP 2 | Select macOS as the operating system (the Gatekeeper Enhancement MPM is not supported
on Windows endpoints).

STEP 3 | From the action menu , select Add.

STEP 4 | Select Gatekeeper Enhancement and configure the rule settings:

ActivationSelect On to enable the gatekeeper enhancement MPM or Off to disable it.
ActionSelect the action to take when Traps detects a child process which does not match or exceed
the configured signature level: Block the behavior (Prevention), or permit the behavior and log the
issue (Notification). If you choose to Inherit the behavior, Traps defers to the default policy for the
action.

To view additional details about the default policy, select Policies > Malware >
Protection Modules, and then select Show Default Rules from the action menu.
User AlertSpecify the notification behavior when Traps detects a child process which does not
match or exceed the configured signature level, either On to notify the user, or Off to suppress
notifications. If you choose to Inherit the behavior, Traps defers to the default policy for the
notification behavior.

STEP 5 | Select the signature Verification Level:

By Parent(Default) The child process must match the signature level of the parent process.
Block AllBlock all child processes regardless of signature level.
Apple SystemThe child process must be signed by Apple.
Mac App StoreThe child process must be signed by the App Store.
DevelopersThe child process must be signed by a registered developer.

STEP 6 | (Optional) Whitelist child processes run from specific locations:

1. Select the add folder icon .
2. Enter the full path for the child process, for example:

/Applications/myapp1.app/Contents
3. Repeat the process to add any additional child processes, if desired.
4. Select the Whitelist Action to Merge or Override the child process list with lists defined in other
user-defined or default policy rules for the parent process.

If multiple rules exist for the same parent process that specify Whitelist Action:
Merge, Traps consolidates the Whitelist. If multiple rules exist for the same parent
process that specify Whitelist Action: Override, only the most recent rule (with the
highest ID number) takes precedence.

152 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 If multiple rules exist for the same parent process but use different list behaviors (for example, one
as a whitelist and one as a blacklist), only the most recent rule (with the highest ID number) takes
precedence.

STEP 7 | Select the Processes tab and Add one or more source (parent) processes to which Traps will
apply the Gatekeeper Enhancement MPM. As you type, the ESM Console provides auto-
completion based on the list of processes defined in the ESM Console.

STEP 8 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 9 | (Optional) Define the Target Objects to which to apply the restriction rule.
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 10 | (Optional) Review the rule name and description. The ESM Console automatically generates
the rule name and description based on the rule details but permits you to change these
fields, if needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 11 | Save the exploit protection rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Exploit > Protection
Modules page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Protection Modules page at any time to Delete or
Deactivate the rule.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 153

Manage Restrictions on Executable Files
Restriction Rules
Add a New Restriction Rule
Manage Global Whitelists
Block Execution from Local and Network Folders
Whitelist a Network Folder
Define External Media Restrictions
Define Child Process Restrictions
Define Java Restrictions and Exemptions

Restriction Rules
A restriction rule limits the surface of an attack on a Windows endpoint by defining where and how your
users can run executable files. The following table displays the different types of restrictions you can
configure:

Restriction Rules Description

Running executable Many attack scenarios are based on writing malicious executable files to
files from certain certain folders and then running them. For example the local temp and
folders download folders are commonly used to store and later run malicious
executable files. To make an exception to this general restriction, you can
add specific folders to a whitelist. For more information, see Manage Global
Whitelists, Block Execution from Local and Network Folders, and Whitelist a
Network Folder.

Running executable Malicious code can gain access to endpoints via external media such as
files from external removable drives and optical drives. To protect against this, you can define
media restrictions that control the executable files, if any, that users can launch
from external drives attached to the endpoints in your network. For more
information, see Define External Media Restrictions.

Processes spawning (Traps 3.4 and earlier releases) Malicious code can activate by causing
child processes a legitimate process to spawn malicious child processes. You can block
the malicious code by defining an appropriate restriction rule. For more
information, see Define Child Process Restrictions.

Java processes run (Traps 3.4 and earlier releases) A common entry point for malicious code is
from browsers through Java processes that are imported from a remote host and launched
through Internet browsers. To protect against these exploits, you need
to prevent untrusted Java applets from executing objects using browsers
while whitelisting specific trusted processes so they can run on endpoints as
needed. You can selectively choose which actions are permitted (read, write,
or execute) based on process file types, locations, and registry paths. For
more information, see Define Java Restrictions and Exemptions.

Add a New Restriction Rule

Create a new restriction rule to define limitations on where and how executable files run on endpoints.

154 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

STEP 1 | Configure a new restriction rule.
Select Policies > Malware > Restrictions and Add a new rule.

STEP 2 | From the action menu , select Add.

STEP 3 | Select the type of restriction rule you are adding.

Select one of the following options and then configure settings according to the type of restriction you
are adding to your security policy:
Execution Path RestrictionRestrict access to local or remote files and folders. For more information,
see Block Execution from Local and Network Folders.
Network Folder BehaviorRestrict access to all network folders except for those in the whitelist. For
more information, see Whitelist a Network Folder.
External MediaFor more information, see Define External Media Restrictions and Exemptions.
Child Processes (Pre-4.0 Agents)Block malicious child processes spawned from legitimate
processes. For more information, see Define Child Process Restrictions.
Java (Pre-4.0 Agents)Prevent untrusted Java applets from executing objects using browsers and
add specific trusted processes to whitelists so they can run on endpoints as needed. For more
information, see Define Java Restrictions and Exemptions.

STEP 4 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 5 | (Optional) Define the Target Objects to which to apply the restriction rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 6 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 7 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 155

Manage Global Whitelists
To allow executable files to run from local folders and external media and allow child processes initiated
from parent processes in a specific folder, you can configure a global whitelist. Similar to the existing
whitelist functionality for Java processes, unsigned executable files, and Thread Injection, you can specify
full paths and path variables and can also use wildcards for pattern matching (% to match similar terms and *
to match any characters).
Items in the whitelist section also take precedence over any blacklisted items and are evaluated first in the
security policy.

STEP 1 | Select Policies > Malware > Restriction Settings.

STEP 2 | To specify whether Traps blocks an executable file that it is opened from a location not
included in the whitelist or that is younger than the block period, configure the Action as one
of the following:
NotificationDo not block access to executable files and processes but log when files that are
opened from locations not included in the whitelist and report those events to the ESM.
or
PreventionBlock executable files and processes.

STEP 3 | To specify whether Traps should notify the user when an executable file is opened from a
location not included in the whitelist, configure the User Alert as one of the following:
OnNotify the user.
or
OffDo not notify the user.

STEP 4 | Click the add folder icon next to the whitelist area for Local Folder, Child Process, or Media
Control and enter the full path or partial path. For example, C:\Windows\filename.exe.

Whitelists also support wildcards and environmental variables, such as %windir% (for
more details, see Wildcards and Variables in Policy Rules).

STEP 5 | Click Commit to save your changes.

156 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

Block Execution from Local and Network Folders
Many attack scenarios are based on writing malicious executable files in remote folders and common local
folderssuch as temp and downloadand then running those executable files. By default, Traps allows
benign executable files to run from any local folder. By configuring an Execution Path Restriction rule you
can restrict the locations from which executable files can run. For increased flexibility, you can configure
the Execution Path Restriction to restrict both local and remote folders and executable files. Common
applications for this rule include the ability to restrict:
Specific executable files run locally, for example:

%MySystemDrive%\myfolder\temp\malware.exe
Any executable run from a specific local folder or subfolders, for example:

C:\temp\*
Specific executable files run from a remote location, for example:

\\remoteserver\folder\malware.exe
Specific remote locations, for example:

\\remoteserver\*

When you enable this restriction rule, all executable files are permitted to run unless they match the folders
or files specified in the rule. If a user tries to open an executable file from a blocked location, Traps blocks
the attempt and reports the security event to the ESM Server.
For a more stringent security policy, consider configuring a network folder behavior rule which blocks
all executables run from remote network folders except for those expressly whitelisted (see Whitelist a
Network Folder).
You can also configure an exception for a local folder by adding the folder to the a whitelist (see Manage
Global Whitelists). The whitelists take precedence over the blacklist and enables executable files in specific
locations to always run.

STEP 1 | Begin a new restriction rule:

1. Select Policies > Malware > Restrictions.
2. From the action menu , Add a new restriction rule.
3. Select Execution Path Restriction.

STEP 2 | Block an executable file or files run from a local folder.

1. Select Local Folder Behavior.
2. Select the option to Restrict file execution from the locations.
3. Click the add folder icon , and Add the executable file or folder path to the Blacklist section.

To blacklist a folder, you must terminate the path with a wildcard. For example, C:
\temp\* matches any file launched from the C:\temp\ folder or subfolder).

For additional syntax examples, see Wildcards and Variables in Policy Rules.
4. Repeat the previous step to add multiple paths as needed.

STEP 3 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 157

 To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 4 | (Optional) Define the Target Objects to which to apply the restriction rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

Whitelist a Network Folder

To prevent attack scenarios that are based on writing malicious executable files to remote folders, you can
create a restriction rule to block all executable files run from specific folders. To enable executable files to
run from known trusted network locations, you can create a Network Folder Behavior restriction rule to
whitelist the file or remote folder path.
When you enable this rule, Traps blocks all executable files that run from network locations except for
those expressly whitelisted in the rule. When a user attempts to open an executable file from a network
folder that is not specified in the whitelist, Traps blocks the attempt and reports the security event to the
ESM Server.

STEP 1 | Begin a new restriction rule:

1. Select Policies > Malware > Restrictions.
2. From the action menu , Add a new restriction rule.
3. Select Network Folder Behavior.

STEP 2 | Select the option to Restrict file execution from all network folders except the locations listed
below.

STEP 3 | Click the add folder icon , to Add the file or folder path in uniform naming convention (UNC)
format.

158 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 To whitelist a folder, you must terminate the path with a wildcard. For example, \
\networkpath\temp\* matches any file launched from the \\networkpath\temp\
folder or subfolder).

For additional syntax examples, see Wildcards and Variables in Policy Rules.

STEP 4 | Repeat the previous step to add multiple paths as needed.

STEP 5 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 6 | (Optional) Define the Target Objects to which to apply the restriction rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 7 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 8 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

Define External Media Restrictions

Malicious code can gain access to endpoints through external media, such as removable drives and optical
drives. To protect against this type of attack, you can define restriction rules that prevent executable files
from running on external drives that are attached to your endpoints. Defining a restriction on external
media protects against any attempt to launch an executable file from an external drive.

STEP 1 | Begin a new restriction rule:

1. Select Policies > Malware > Restrictions.
2. From the action menu , Add a new restriction rule.
3. Select External Media.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 159

STEP 2 | Select the type of external media from which you want to restrict executable files from
running, either Removable Drives or Optical Drives. By default, running non-malicious and
unknown applications from removable and optical drives is allowed.

STEP 3 | (Optional) Add Conditions to the Rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 4 | (Optional) Define the Target Objects to which to apply the restriction rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

STEP 7 | (Optional) To whitelist specific external media locations from your external media restriction
rule, add one or more folders to the External Media Whitelist. For more information, see
Manage Global Whitelists.

Define Child Process Restrictions

The child process restriction rule is supported in Traps 3.4 and earlier releases. To restrict
child processes on endpoints running Traps 4.0, Configure Child Process Protection.

In an attempt to control an endpoint, an attacker can cause a legitimate process to spawn malicious child
processes. Define a restriction rule to prevent child processes from launching from one or more processes.

STEP 1 | Begin a new restriction rule:

1. Select Policies > Malware > Restrictions.
2. From the action menu , Add a new restriction rule.
3. Select Child Processes (Pre-4.0 Agents).

STEP 2 | Define the behavior for child processes. By default, child processes spawned from a process
are allowed.

160 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 1. In the Select Processes search field, enter and then select the name of a process. As you type, the
ESM Console offers auto-completion for any processes that match your search term.

To modify the processes list, see View, Modify, or Delete a Process.

2. Repeat steps a to add additional process names, as needed.

STEP 3 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 4 | (Optional) Define the Target Objects to which to apply the restriction rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

Define Java Restrictions

The Java restriction rule is supported in Traps 3.4 and earlier releases. To restrict
Java processes from running specific child processes on endpoints running Traps 4.0,
ConfigureChild Process Protection.

A common entry point for malicious code is through Java processes that are imported from a remote host
and run in Internet browsers. To protect against these exploits, you can configure Traps to prevent a Java
applet from executing objects from within web browsers and whitelist only trusted processes so they can
execute as needed. Use the whitelist option to selectively choose which processes Java is permitted to run.

STEP 1 | Begin a new restriction rule:

1. Select Policies > Malware > Restrictions.
2. From the action menu , Add a new restriction rule.
3. Select Java (Pre-4.0 Agents).

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 161

STEP 2 | Configure the Java restriction rule to whitelist a process run by Java in a specific browser on
Traps agents running 3.4 or earlier versions.
1. From the Java Activation drop-down, select On to enable the rule or Off to disable the rule.

Any additional settings are grayed out if Java is disabled.

2. Configure the Action to take when a Java process attempts to run and the process is not whitelisted:
InheritInherit the behavior from the default policy.
PreventionTerminate all Java processes except for those specified in the whitelist.
NotificationLog the issue and allow the Java process to continue.
3. Configure the User Alert behavior when a Java process attempts run from a web browser.
InheritInherit the behavior from the default policy.
OnNotify the user.
OffDo not notify the user.
4. In the Java Whitelisted Processes section, click the add processes button to specify the Java
processes that will be allowed to run from web browsers (for example AcroRd32.exe). Repeat this
step to add additional processes.
5. From the Browsers list, select the web browsers on which to enforce Java protection.

STEP 3 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see DefineActivation Conditions for a Rule on Windows Endpoints.

STEP 4 | (Optional) Define the TargetObjects to which to apply the restriction rule. By default, a new rule
applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the restrictions rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > Restrictions
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Restrictions page at any time to Delete or
Deactivate the rule.

162 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

WildFire Integration
WildFire is the Palo Alto Networks sandbox solution for analyzing unfamiliar filesincluding unknown
executable files. WildFire issues verdicts for all scrutinized files: benign in the case of a safe file and
malicious in the case of malware. The WildFire integration with Traps is an optional service that
incorporates WildFire analysis into your Traps endpoint solution.
When a user or a machine tries to open an executable file or macro on the endpoint, Traps calculates a
unique identifier (known as a hash) using the SHA-256 algorithm. The ESM Server then checks it against the
WildFire database. If WildFire confirms that a file is known malware, Traps blocks the file and notifies the
Endpoint Security Manager (for more information, see Manage Hashes for Executable Files).
WildFire Integration Concepts
Set Up the ESM to Communicate with WildFire
Set Up a Private WildFire Cloud
Configure a WildFire Rule

WildFire Integration Concepts

ESM Forwarding
Verdicts
Verdict Caches
File Type Analysis

ESM Forwarding
The Endpoint Security Manager (ESM) forwards unknown samples for in-depth analysis to the WildFire.
You can integrate your ESM environment with either the WildFire public cloud or a local WF-500 that acts
as a local sandbox. The type of samples the ESM submits and frequency at which the ESM communicates
with WildFire is determined by the WildFire settings and rules that you configure (see Set Up the ESM to
Communicate with WildFire and Configure a WildFire Rule).
For samples that Traps reports, the agent first checks its local cache of hashes to determine if it has an
existing verdict for that sample. If Traps does not have a local verdict, Traps queries the ESM to determine
if WildFire has previously analyzed the sample. If the sample is identified as malware, it is blocked. If the
sample remains unknown after comparing it against existing WildFire signatures, the ESM forwards the
sample for WildFire analysis. For more information, see Malware Protection Flow.

Verdicts
WildFire delivers verdicts to identify samples it analyzes as safe, malicious, or unwanted (grayware is
considered obtrusive but not malicious):
BenignThe sample is safe and does not exhibit malicious behavior.
MalwareThe sample is malware and poses a security threat. Malware can include viruses, worms,
Trojans, Remote Access Tools (RATs), rootkits, botnets, and malicious macros. For files identified as
malware, WildFire generates and distributes a signature to prevent against future exposure to the threat.
GraywareThe sample does not pose a direct security threat, but might display otherwise obtrusive
behavior. Grayware typically includes adware, spyware, and Browser Helper Objects (BHOs).
When WildFire is not available or integration is disabled, Traps can also assign a local verdict for the sample
using additional methods of evaluation: When Traps performs Local Static Analysis on a file, it uses machine
learning to determine the verdict. Traps can also compare the signer of a file with a local list of Trusted
Signers to determine whether a file is malicious:

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 163

 Local analysis verdicts:
BenignLocal analysis determined the sample is safe and does not exhibit malicious behavior.
MalwareThe sample is malware and poses a security threat. Malware can include viruses, worms,
Trojans, Remote Access Tools (RATs), rootkits, botnets, and malicious macros.
Trusted signer verdicts:
TrustedThe sample is signed by a trusted signer.
Not TrustedThe sample is not signed by a trusted signer.

Verdict Caches
Traps stores hashes and the corresponding Verdicts for all executable files that open on the endpoint in
its local cache. The local cache is stored in the C:\ProgramData\Cyvera\LocalSystem folder on the
endpoint and scales in size to accommodate the number of unique executable files opened on the endpoint.
When service protection is enabled (see Manage Service Protection), the local cache is accessible only by
the Traps agent and cannot be changed.
Each time an executable file attempts to run, the Traps agent performs a lookup in its local cache to
determine if a verdict already exists. If known, the verdict is either the official WildFire verdict or manually
set as an administrative hash control policy. Verdicts with an administrative hash control policy take
precedence over any additional verdict analysis.
If the executable file is unknown in the local cache, the Traps agent then queries the ESM Server for the
verdict. The Endpoint Security Manager stores verdicts for all executable files that have been opened on
the endpoints across your organization in its server cache which is stored in the ESM database. When the
ESM Server receives a verdict request it performs a lookup in its server cache to determine the verdict.
The ESM Server responds with the verdict at the next heartbeat communication with the Traps agent that
requested the verdict.
If the executable file is unknown in the server cache, the ESM Server then queries WildFire and optionally
submits the file for analysis.

File Type Analysis

You can configure your ESM to forward samples to WildFire for analysis. A sample can be:
Any Portable Executable (PE) file including (but not limited to) executable files, object code, FON (Fonts),
and Microsoft Windows screensaver (.scr) files.
Microsoft Office files containing macros opened in Microsoft Word (winword.exe) and Microsoft Excel
(excel.exe):
Microsoft Office 2003 to Office 2007.doc and .xls
Microsoft Office 2010 and later releases.docm, .docx, .xlsm, and .xlsx
For details on enabling the ESM to forward samples to WildFire, see Set Up the ESM to Communicate with
WildFire.

Set Up the ESM to Communicate with WildFire

WildFire integration is enabled by default; however, you must set up the ESM to communicate with
WildFire.

STEP 1 | From the ESM Console, select Settings > ESM > WildFire.

164 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

STEP 2 | Enable WildFire communication settings:
Select Allow External Communication with WildFire to enable the ESM to check hashes with
WildFire.
Select Allow Upload Executable Files to WildFire to enable the ESM to send files to WildFire for
analysis. Clearing this upload option enables the ESM Server to check verdicts with WildFire but not
send files for analysis.
To Use Private Cloud (Requires a WF-500 appliance), see Set Up a Private WildFire Cloud.

STEP 3 | In the Unknown Verdicts Recheck Interval (Minutes) field, enter the frequency (in minutes)
at which the ESM Server resubmits hashes to WildFire for unknown files. A file can have an
unknown verdict if it is the first time an endpoint submits the hash to the server or if WildFire
has not, yet, analyzed or finished analyzing the file (range is 1 to 20,160; default is 30).

STEP 4 | In the Known Verdicts Recheck Interval (Minutes) field, enter the frequency (in minutes) at
which the ESM Server rechecks with WildFire for the value of known benign or malicious
hashes (range is 1 to 20,160; default is 1,440).

STEP 5 | In the Upload Retry Interval (Minutes) field, enter the frequency (in minutes) at which the ESM
Server attempts to re-upload any files that did not upload to WildFire successfully (range is 1
to 20,160; default is 1,440).

STEP 6 | Enter the WildFire web address (for example, https://wildfire.paloaltonetworks.com) that
the ESM will use to check hashes and submit samples. To forward samples to a local WF-500
appliance, see Set Up a Private WildFire Cloud.

The WildFire API Key is required only for a private WildFire cloud.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 165

STEP 7 | By default, the ESM Server submits files up to 100MB to WildFire for analysis. To change the
Maximal File Size (MB), enter a value from 1 to 100 MB. Files that exceed the maximum size
are not submitted to WildFire either automatically or manually.

STEP 8 | Save your changes.

Set Up a Private WildFire Cloud

For deployments with privacy and legal regulations that restrict the transfer of files outside your network,
you can set up your ESM to integrate with a private WildFire cloud. To set up the private cloud, you must
install an on-premise WF-500 appliance. This appliance supports up to 40,000 Traps agents.

When an unknown file attempts to run on your endpoints, the WF-500 appliance queries the WildFire
public cloud to obtain the verdict and analyzes the executable file in the local private sandbox. By default,
the WF-500 appliance does not send discovered malware outside your network, however, you can choose
to automatically forward malware to the WildFire public cloud to generate and distribute signatures to
all Palo Alto Networks firewalls with Threat Prevention and WildFire licenses. Otherwise, the WF-500
appliance only forwards the malware report (and not the sample itself) to the WildFire public cloud.
To enable the ESM Server to verify and trust the identity of the WF-500 appliance, you obtain the WF-500
Root CA certificate from Support and import it on each ESM Server.
To integrate a WF-500 application in with your ESM deployment, use the following workflow:

STEP 1 | On each ESM Server, import the WF-500 Root CA certificate (Palo Alto Networks Root CA 1)
into the Trusted Root Certification Authorities.
1. Contact Support to obtain the WF-500 Root CA certificate and save it to a location you can access
from the ESM Server.
2. On the ESM Server, open the Microsoft Management Console (MMC.exe).
3. Select File > Add/Remove Snap-In > Certificates and add the Certificates snap-in for the Computer
account.
4. Select Local Computer > Finish, and then click OK.
5. Expand the Certificates (Local Computer) folder.
6. Right-click Trusted Root Certification Authorities and then select All Tasks > Import > Next.
7. Browse to the certificate you saved in the previous step and then click Next. The certificate import
wizard displays details about the Trusted Root CA certificate.
8. Click Finish.

STEP 2 | Configure WildFire Integration in the ESM Console.

166 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 1. Get Your WF-500 Appliance API Keyand copy it into memory.
2. From the ESM Console, select Settings > ESM > WildFire.
3. Select Use Private Cloud (Requires a WF-500 appliance).
4. Enter the WildFire Address of the WF-500 appliance:
HostnameIf the WF-500 appliance has a set hostname, enter the hostname for the WildFire
Address (for example: https://HostName/). You must also ensure there is a DNS record to
map the hostname to the IP address of the WF-500 appliance.
Hostname and domainIf the WF-500 appliance has a set hostname and domain, use the FQDN
for the WildFire Address (for example: https://HostName.DomainName/). You must also
ensure there is a DNS record to map the FQDN to the IP address of the WF-500 appliance.
No hostname or domainIf the WF-500 appliance does not have a set hostname or domain
name, use the IP address of the WF-500 appliance as the WildFire Address (for example:
https://172.10.10.10/).
5. Paste the WildFire API Key from memory.
6. Save the WildFire configuration.

STEP 3 | To verify connectivity between the ESM Server and the local WF-500 appliance, recheck a
hash verdict with WildFire.
1. Select Policies > Hash Control.
2. Select a record in the hash control table.
3. Select Recheck Verdict. If the connection is successful, the WF-500 appliance returns a verdict. If the
connection is not successful, the verdict is No Connection.

Configure a WildFire Rule

WildFire rules determine how Traps detects and responds to malware on your endpoints. You can create
or edit WildFire rules on the WildFire rule management page (Policies > Malware > WildFire). When you
configure a WildFire rule, you can enable any of the following functionality in Traps:
Notify the user about malware on the endpoint
Execute the desired action on malware (either block, permit but notify, or permit and silently log the
event)
Apply the same action on malware to grayware
Submit unknown executable files and files containing macros [to the ESM Server] for WildFire analysis
Use local analysis to determine the verdict for a file
Quarantine malicious files identified locally on the endpoint
Block unknown files when no WildFire verdict is available

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 167

 Block unknown files when the ESM Server is unreachable
By default, a WildFire rule applies to all users. If needed, you can customize different WildFire settings for
specific users or different groups of users by creating a WildFire rule for each.

STEP 1 | Verify that the ESM components are configured to communicate with WildFire.
See Set Up the ESM to Communicate with WildFire.

STEP 2 | Configure a new WildFire rule.

1. Select Policies > Malware > WildFire.
2. From the action menu , select Add.
3. Select the type of file to which you want to apply WildFire analysis, either Executable Files or Office
Files.

STEP 3 | To activate the WildFire module to enable Traps to calculate and check hash verdicts against
its local cache of hashes, set WildFire Activation to On.

STEP 4 | Configure the Actionthe behavior of Trapswhen Traps identifies malware.

Select Inherit to use the behavior defined by the default policy (Prevention).
Select Prevention to block the malicious file.
Select Notification to allow the user to open the file, log the issue, and notify the user about the
malicious file.
Select Learning to allow the user to open a malicious file and silently log the issue without notifying
the user.

STEP 5 | Specify whether Traps will notify the user about the malicious file.
From the User Alert drop-down, select On to notify the user or Off to silently log the event.

STEP 6 | (ESM 4.0.1 and later) To exempt a file from WildFire examination, add the file to the whitelist.
Whitelisting files can be useful if the associated hash value changes but the filename stays the same.
For example, consider an application such as GoToMeeting which creates a new executable file with
the same filename and a unique hash value each time you launch the application. In this case, to exempt
GoToMeeting from WildFire examination, you can add the full path for GoToMeeting.exe to the
whitelist.

If you do not expect the hash value associated with a file to change and want to whitelist
the file, we recommend that you configure an administrative hash override for the verdict.

1. Click the icon above the Whitelist.

2. Add the Full Path to the file. Traps will ignore executables or macros run from the specified files at
these paths.

The whitelist also supports the same environment variables and wildcards that
you can use in restriction rules. For example, to allow a file at path C:\temp
\myfilename.exe to run, add the path to the whitelist. Or to allow myfilename.exe to
run regardless of where myfilename.exe is stored, you can use wildcards to define
the full path as *\myfilename.exe.
3. Repeat this process to specify additional files.
4. Select the Whitelist Action to Merge or Override the whitelist with lists defined in other user-
defined or default policy rules.
If multiple rules specify List Action: Merge, Traps consolidates the Whitelist.

168 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 If multiple rules specify List Action: Override, only the most recent rule (with the highest ID
number) takes precedence.

STEP 7 | Configure the WildFire integration behavior for the type of file:

To get the most out of WildFire integration, we recommend that you turn on all WildFire
functionality.

Executable Files:
Upload Files for WildFire AnalysisSet this value to On to enable Traps to send unknown executable
files to the ESM Console, which sends the files to WildFire for analysis.
Apply Malware Verdict on GraywareSet this option to On to treat all grayware as malware.
Otherwise, if this option is Off, grayware is considered benign and is not blocked.
Enable Local Analysis on Unknown FilesSet this option to On to enable Traps to use embedded
machine learning to determine the likelihood that an unknown executable file is malware and issue a
local verdict for the file. When this option is Off and is configured to block unknown files, users will
not be permitted to open unknown executable files. As a result, the unknown file remains blocked
until Traps receives an official WildFire verdict.
Quarantine Prevented FilesSet this option to On to enable Traps to quarantine malware on the
endpoint. A file is considered malware if one of the following sources issued a malware verdict for
the file: WildFire, administrative policy override, or local analysis. Set this option to Off to allow
malware to remain on the endpoint in its original location. The quarantine feature is not available for
malware identified in network drives.
WildFire Verdict is UnavailableSet this option to Block Unknowns or Allow Unknowns when the
file is unknown in the local and server cache.

By default Traps permits unknown executable files to open; however, if local analysis
is enabled, Traps always returns a verdict for an unknown executable file. Therefore,
enabling these options files only applies to agents for which local analysis is not
enabled or for agents running Traps 3.3.
ESM UnreachableSet this option to Block Unknowns or Allow Unknowns when Traps cannot reach
the ESM Server to query for a verdict or submit the file for analysis.
Office Files:
Upload Files with Macros for WildFire AnalysisSet this value to On to enable the ESM Server to
send the files it received from Traps agents which contain unknown macros to WildFire for analysis.

STEP 8 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 9 | (Optional) Define the Target Objects to which to apply the WildFire rule. By default, a new rule
applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 10 | (Optional) Review the rule name and description. The ESM Console automatically generates
the rule name and description based on the rule details but permits you to change these
fields, if needed.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 169

 To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 11 | Save the WildFire rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Malware > WildFire page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the WildFire page at any time to Delete or Deactivate
the rule.

170 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

Manage Hashes for Executable Files
View and Search Hashes
Export and Import Hashes
View a WildFire Report
Override a WildFire Verdict
Recheck a WildFire Decision
Report an Incorrect Verdict
Upload a File to WildFire for Analysis
Manage Quarantine Settings
Restore a Quarantined File

View and Search Hashes

The Hash Control page displays a table of all the hashes and their verdicts for executable files reported by
the Traps agents in your organization.

Filter File Hashes

File Hash Search Conditions

Filter Hash Control Records

To help you quickly respond to malware-related activity, you can easily filter the number of results on the
Hash Control page using one or more search conditions.
STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | Filter the results displayed on the Hash Control page using any of the following methods:
Import and run a previously-saved search query
1. Click the button to expand the list of available actions and search queries.
2. Select Import Search.
3. Browse to and Upload an XML file containing a previously saved search query. The Hash Control
page automatically applies the imported search query.
Use a predefined search query
1. Click the button to expand the list of available actions and search queries.
2. Select from one of the following predefined search queries:

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 171

 Malware discovered in the last day
Malware discovered in the last week
Restore candidatesDisplays the files that have been quarantined that are eligible for restoration
Last 1000 manual overridesDisplays the files which have an administrative hash control policy
to override the official WildFire verdict
Last 1000 unknown filesDisplays files which have not been submitted to WildFire for analysis or
for which the official WildFire verdict is unknown
Last 1000 upload errorsDisplays any files which encountered errors during the submission
process to WildFire
The Hash Control page displays up to 1000 records which match your predefined search conditions.
Perform a complex search query

1. Specify whether to match Any of the conditions you specify (similar to an OR operation) or to match
All of the conditions (similar to an AND operation).
2. To clear all existing search conditions, click . Or, to remove a single search term, click next to
the condition you want to remove.
3. Select your search condition, operator, and value. For options, see File Hash Search Conditions.
4. To enter additional search conditions, click next to the condition. The Hash Control page adds an
additional search condition for you to configure.
5. When you are done adding conditions, click Search. The Hash Control page displays up to 1000
records which match your search conditions.

STEP 3 | (Optional) To run you search query at a later time, export it to a file.
1. Click the button to expand the list of available actions and search queries.
2. Select Export Search. The ESM Console saves your search parameters to an XML file.

File Hash Search Conditions

Search fields at the top of the Hash Control page allow you to filter using one or more search conditions.
For search queries with multiple conditions, you can query results that match All of the search conditions
or results that match Any of the search conditions. You can also choose from predefined search queries
for quick access to records that may require additional action. For example, you can use predefined queries

172 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

to review malware discovered within the last 24 hours, or you can identify malware that was quarantined
on the endpoint (restoration candidates). You can also import a previously saved search query or export a
query to use it again later.
The ESM Console search engine queries the ESM database for records which match the search conditions
and returns up to 1,000 matching results. Searches with a large number of results may take a few seconds
to complete.
The following table displays the search conditions that you can use to filter the hash records.

Table 3: File Hash Search Conditions

Condition Operators Description

Endpoint is Name of the endpoint, or list

is in list of endpoints separated by new
is not in list lines
isnt

File Name is Full or partial filename

is in list (Microsoft Office files containing
is not in list macros, executable files, or
isnt Mach-object (Mach-o) files), or
list of filenames separated by
contains
new lines

File Size greater than File size in MB

less than

File Type is One of the following files types:

is in list PEPortable executable file
Mach-oMach object files
for macOS
Office FileMicrosoft Office
files containing macros

First Seen after Date and time at which the file

before was first seen by Traps

Last Seen after Date and time at which the file

before was last seen by Traps

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 173

 Condition Operators Description

Module is Module which issued the verdict:

is in list WildFire, Hash Control, or Local
is not in list Analysis
isnt
Use the was/
wasnt operator
to identify
changes in
the source of
a verdict. For
example, to
identify hashes
whose verdict
was previously
issued by Local
Analysis but is
now issued by
WildFire, set the
following search
conditions:
(Module was
Local Analysis)
and (Module is
WildFire).

Number of Endpoints is Number of endpoints on which

greater than the file was seen
less than

174 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

Condition Operators Description

Quarantine Status is Quarantine status of the file, one

isnt of the following:
YesTraps successfully
quarantined the file
NoTraps failed to
quarantine the file
Pending RestoreTraps
is attempting to restore a
quarantined file
FailedTraps failed to
restore a quarantined file
Restore succeededTraps
successfully restored a
quarantined file
Quarantine record deleted
The quarantine record was
deleted. This can occur when
Traps receives an action rule
to purge the prevention data,
or when the folder storage
quota is reached causing
Traps to automatically purge
the oldest files.

SHA256 is Full or partial hash value, or list

is in list of hash values separated by new
is not in list lines
isnt
contains

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 175

 Condition Operators Description

Upload Status is Status of the upload to WildFire,

isnt one of the following:
No information supplied
The file upload is not
required because WildFire
has already analyzed the file.
Upload in progressThe file
upload has begun.
Upload succeededThe ESM
Server received the file from
the endpoint.
Upload failedTraps failed
to upload the file to the ESM
Server.
Upload limit exceeded
The file will not be uploaded
because the file exceeded
the maximum size limit (by
default 100MB or as defined
in the WildFire settings).

Verdict is Verdict regardless of source

isnt (WildFire, Local Analysis, or
was Hash Control): Benign, Malware,
wasnt Grayware, Unknown, or No
Connection. Use the was/wasnt
operators to search for previous
verdicts (all historically known
verdicts).

176 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 Condition Operators Description

WildFire Verdict is Official WildFire verdict: Benign,

isnt Malware, Grayware, Unknown,
or No Connection.

You can use this

search condition
to locate hashes
that have
verdicts that
are different
from WildFire.
For example, to
identify files that
are blocked by
an administrative
override (Hash
Control), but
are considered
benign by
WildFire, set the
following search
conditions:
(WildFire
Verdict is
Benign and
(Verdict is
Malware).

Export and Import Hashes

The Hash Control page displays information about the hashes and the verdicts associated with all
executable files that users or machines have tried to open on your endpoints. Use the export function
from the action menu to back up hash records before migrating or upgrading to a new server or
before deploying hash records to multiple independent servers. You can export hash records on a global
or individual basis and save them to an XML file. Importing hash records appends any new hashes to the
existing Hash Control table.

If you attempt to edit the XML file in Excel, Excel automatically adds quotes around some
values in the file. These quotes do not adhere to the input format expected by the ESM
Console. Therefore, if you need to modify the XML file, you must use a text editor to remove
the quotes before attempting to import the file.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | Do either of the following:

To back up or export hash records, select the check box next to the record(s) you want to export.
From the action menu at the top of the table, select Export Selected. The ESM Console saves the
selected hash records to an XML file.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 177

 To restore or import new policy rules, select Import Hashes from the action menu at the top of
the table. Browse to the XML file and then Upload.

View a WildFire Report

To help aid in hash control decisions, you can view a copy of the official WildFire report for each executable
file that WildFire analyzes. The ESM Server caches the report and makes it available on the Hash Control
page of the ESM Console. Each report contains file information, a behavioral summary about the executable
file, and details about network and host activity.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | Search for and then select the hash for which you would like to see the report.

STEP 3 | Click WildFire Report. The ESM Console displays the cached report.

STEP 4 | Review the report and take additional action, as needed:

Override a WildFire Verdict
Recheck a WildFire Decision
Report an Incorrect Verdict

View the History of a Verdict

The verdict change history helps you to identify the flow of changes to a verdict and the source (module)
of all applied verdicts. You can view the verdict change history associated with each file hash record on the
Hash Control page.

178 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 The ESM begins tracking the verdict history as soon as you upgrade the Endpoint Security Manager 4.0 (the
ESM Console does not retroactively identify verdict changes which occurred in earlier releases).
For the ESM Console to log the verdict change, Traps must have applied the verdict to one or more agents.
WildFire and Hash Control verdicts are listed in the order they are applied and Local Analysis verdicts are
listed last.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | Select the record for a hash. If necessary, Filter Hash Control Records to reduce the number of
records the ESM Console displays.

STEP 3 | In the Previously Reported Verdicts section, review up to five of the most recent verdicts that
were applied on an agent.

STEP 4 | To view details about the endpoints which have opened the file associated with the hash,
select Agent List.

Override a WildFire Verdict

You can locally override a WildFire verdict to allow or block a file without impacting the official verdict
in WildFire. This is useful when you need to create an exception for a specific file in only specific
circumstances or endpoints without altering the global security policy. After overriding the verdict, the ESM
Console displays any change in the WildFire verdict on the Hash Control page. The override remains in
place until you remove it, at which time it reverts to the last known verdict on the server.
For example, consider a case where WildFire returns a verdict on a specific hash and indicates that the file
is unknown. If your security policy is configured to block all unknown files and you believe the file to be
benign, you can override the policy to allow the specific file to execute without altering the global policy.
Later, if WildFire returns a new verdict indicating that the file was analyzed and determined to be malicious,
you can view the verdict change on the Hash Control page. In that case, you can remove the override and
allow the security policy to block the malicious file.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | To view the WildFire verdict for a specific hash, do either of the following:
Use the search at the top of the page to search for a hash value or process name.
Use the paging controls on the top right of each page to view different portions of the table.

STEP 3 | To review the endpoints on which a user has tried to open the executable file, select Agent List
(available only when there are five or more instances of a process hash).

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 179

STEP 4 | Review the WildFire report for the executable file to validate your decision to override the
verdict. See View a WildFire Report.

STEP 5 | Select the hash record and then click Treat as Benign to allow the executable file to run or
click Treat as Malware to block execution of the file. This override does not affect the official
WildFire verdict but it does change the verdict in the local security policy for your organization.
If you suspect a WildFire verdict is incorrect, please consider reporting the issue to Palo Alto
Networks. See Report an Incorrect Verdict.

STEP 6 | On a regular basis, review any mismatches between the official WildFire verdict and your local
policy action.

STEP 7 | When the override is no longer needed, remove it. From the action menu , select Revert to
WildFire Verdict. The ESM Console reverts to the verdict last known by the ESM Server.

Recheck a WildFire Decision

If you suspect that WildFire has changed the verdict of a file, you can force the ESM Server to query
WildFire for the verdict. If the WildFire response indicates a change to the verdict, the ESM Server updates
the verdict in its local server cache. Then, at the next heartbeat communication with Traps agents, the ESM
Server communicates the verdict to endpoints on which a user has tried to open the executable file.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | To view the WildFire verdict for a specific hash, do either of the following:
Use the search at the top of the page to search for a hash value or process name.
Use the paging controls on the top right of each page to view different portions of the table.

STEP 3 | Select the hash record to view additional details about the process hash and then click
Recheck. To recheck multiple records at the same time, select the check box for each hash
record, and then select Recheck with WildFire from the action menu . These actions initiate
an immediate query to WildFire.

Report an Incorrect Verdict

When you want WildFire to reanalyze a file and change its official verdict, you can use the Report Incorrect
Verdict feature from the Policies > Malware > Hash Control page on the ESM Console. This action flags a
sample for further analysis by Palo Alto Networks.
When reporting an incorrect file verdict, you can provide your email address and additional information
about why you believe the verdict is incorrect. If you choose to provide your email address, you will receive
an email notification containing the results of the analysis. If WildFire changes the verdict, the ESM Console
also displays the updated verdict on the Hash Control page.

STEP 1 | Locate the verdict and report it to WildFire.

1. From the ESM Console, select Policies > Malware > Hash Control.
2. In the search field, enter the full or partial hash value or process name and then click the search icon
to filter the list of hashes.
3. Select the row for the hash to expand the hash details and then click Report as Incorrect.

STEP 2 | Fill out the report with details that indicate why the verdict is incorrect.
1. Review the sample information and verify the verdict that you are reporting.

180 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 2. (Optional) Enter an email address to receive an email notification after Palo Alto Networks completes
the additional analysis.
3. (Optional but recommended) Enter any details that may help us to better understand why you
disagree with the verdict.
4. Click Submit.

Upload a File to WildFire for Analysis

Before the integration of the Traps solution, WildFire typically only analyzed an executable file if it was
sent through or uploaded from the firewall or if it was submitted using the WildFire portal. This meant that
some executable files, while common, may not have been analyzed because it was not common to submit
them using the traditional methods. To reduce the number of executable files that are unknown by the ESM
Server and by WildFire, you can manually or automatically send unknown executable files to WildFire for
immediate analysis. To automatically send unknown files to WildFire, see Set Up the ESM to Communicate
with WildFire.
If the option to automatically send unknown files is disabled, you can instead manually upload a file on a
case-by-case basis. When a user opens an unknown executable file, Traps uploads the file to the forensic
folder (so long as the file does not exceed the configured maximum size in Step 8 when you Set Up the ESM
to Communicate with WildFire). Then, when you initiate a manual upload of the file, the ESM Server sends
the file from the forensic folder to WildFire.
After WildFire completes its analysis and returns the verdict and report, the ESM Server sends the changed
verdict to all Traps agents and enforces the policy.
As more agents enable automatic forwarding of unknown files or submit them manually, the total number of
unknown files is expected to decrease dramatically for all users.

STEP 1 | From the ESM Console, select Policies > Malware > Hash Control.

STEP 2 | To view the WildFire verdict for a specific hash, do one of the following:
Use the search at the top of the page to search for a hash value or process name.
Use the paging controls on the top right of each page to view different portions of the table.
Filter the table entries by clicking the filter icon to the right of a column to specify up to two sets
of criteria by which to filter the results. For example, filter the Verdict column for unknown files.

STEP 3 | Select the row to view additional details about the process hash and then Upload the file to
WildFire.

Manage Quarantine Settings

To prevent malware from causing harm to data or systems, you can enable Traps to quarantine files.
Before Traps can begin quarantining files:
Enable Traps to quarantine files in a WildFire rule. See Configure a WildFire Rule. After you enable Traps
to quarantine files, Traps quarantines any malware it identifies locally on the endpoint.
Adjust the storage quota for event logs (see Define Event Logging Preferences). Traps stores
quarantined files in the same location as the logs. When the storage folder reaches the size quota, Traps
makes room for new logs by deleting the oldest logs first.
Because Traps can quarantine only local malware and does not quarantine malware stored in network
folders, we recommend that you enable logging of File Quarantine Failed events (see Forward Logs to
an External Logging Platform and select the File Quarantine Failed event in the Settings - Agent section).
This enables you to receive alerts about events that require manual remediation.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 181

Restore a Quarantined File
When malware is launched on a Windows endpoint, and Traps is enabled to quarantine files, Traps take
immediate action to quarantine the malicious executable file. To evaluate whether an executable file is
considered malicious, Traps uses information from the following sources:
WildFire threat intelligence
Local analysis
Administrative hash control policy (a verdict override configured in the ESM server cache)
When any of theses sources identify malware, Traps moves the malware from the local folder or removable
hard-drive to a local quarantine folder (%PROGRAMDATA%\Cyvera\Quarantine). If user alerts are
enabled, Traps also notifies the user about the quarantined file.
If after using available threat intelligencesuch as from WildFire or AutoFocusyou believe the
quarantined file is not malware and is benign, you can update your hash control policy and then restore the
executable file to its original location (either on the endpoint, or on a removal drive).

When the same malware file (same filename and hash) runs from multiple locations, the
Hash Control page only displays information about the last instance. As a result, if you
choose to restore a file, you can only restore the last instance.

Each time you restore an executable file, the ESM Console sends a one-time action rule to the agent to
restore the file. You can also use Cytool to view and restore quarantined files (see Restorea Quarantined
File Using Cytool). To view the quarantine and restoration status, view the logs or configure the ESM to
send logs to an external logging server.

STEP 1 | Review quarantined files.

Each time Traps quarantines a file, the ESM Console logs a quarantine event. The ESM Console also
updates the hash control record to indicate the quarantine status and number of endpoints on which the
file was quarantined.
1. Log in to the ESM Console and select Policies > Malware > Hash Control.
2. From the action menu , select Restore Candidates. The ESM Console filters the results to display
only quarantined files. You can also filter the Quarantined column by the value Yes. (To return to the
unfiltered review of hashes and refresh the results, remove the filter at the top of the table or select
Hash Control from navigation menu on the left.)
3. To view additional information about the executable file, select the row for a hash record. The row
expands to display additional fields.
4. To view the endpoints on which the executable file was quarantined, click Agent List. The
Quarantined Status column indicates whether quarantine was successful on each endpoint. Click the
x to close the agent list.

STEP 2 | Configure an administrative hash control policy for the executable file. Each time a user
attempts to run an executable file, Traps evaluates whether the file is malware and whether
to quarantine the file. If you choose to restore an executable file but do not change the Hash
Control policy, the next time a user attempts to run the file, Traps blocks and then quarantines
the file again. Therefore, to prevent Traps from continuing to block and quarantine a file, you
must configure an administrative hash control policy to Treat as Benign.
In the additional details view of the hash record, select Treat as Benign. You can also select the
checkbox next to the row or rows and select Treat as Benign from the action menu . This changes the
verdict in the server cache from Malware to Benign.

STEP 3 | Restore a quarantined file.

182 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection

 In the expanded details view for the hash record, click Restore and confirm the action to restore the file
on one or more endpoints. You can also select the checkbox next to the row or rows and select Restore
from the action menu . When Traps receives the request at its next heartbeat communication with
the ESM Server, it attempts to restore the file to its original location on each endpoint.

The Restore button is disabled (grayed out) if the file is not quarantined.

STEP 4 | (Optional) View logs for restored files on the agent.

You can also forward reports for these events to an external logging server or to an email
address. See Reportsand Logging.

Select Monitor > Agent > Logs, Filter the Report Type by any of the following events:
File Restore SucceededTraps successfully restored an executable file to its original location on an
endpoint.
File Restore FailedTraps failed to restore an executable file to its original location on an endpoint.

TRAPS ADMINISTRATOR'S GUIDE | Malware Protection 183

184 TRAPS ADMINISTRATOR'S GUIDE | Malware Protection
Exploit Protection
> Exploit Protection Rules
> Windows Exploit Protection Modules (EPMs)
> Mac Exploit Protection Modules (EPMs)
> Create an Exploit Protection Rule
> Exclude an Endpoint from an Exploit Protection Rule

185
186 TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection
Exploit Protection Rules
An exploit protection rule uses exploit protection modules (EPMs) to protect processes in your organization
from specific exploitation techniques. An EPM is a code module that you activate for one or more processes
to prevent attacks on program vulnerabilities related to memory corruption or logic flaws.
The default security policy contains a preconfigured set of exploit protection rules that are activated for
commonly used protected processes. To protect processes and additional applications that are important
to your organization, you can add these to the list of protected or provisional processes and then configure
additional exploit protection rules. For example, to protect two processes that your organization uses (for
example, ProcessA.exe and ProcessB.exe) from a specific type of memory corruption attack called return
oriented programming (ROP), you can add the processes to the protected processes list and then create
an exploit protection rule that activates the ROP Mitigation EPM. When a user opens a file or URL, the
Traps agent injects code into the protected process or processes involved in opening the file and activates
the EPM. If the file contains code designed to exploit APIs used in ROP chains, Traps blocks the memory
corruption attack. When a security event triggers a prevention, the Traps agent also takes a snapshot of the
memory for subsequent forensic investigation.
On a regular basis, the Traps agent retrieves the latest security policy from the ESM Server. The security
policy determines which processes Traps protects and the type of EPM that Traps activates to protect the
process.
View a summary of exploit protection rules on the Policies > Exploit > Protection Modules page. Selecting a
rule on the page displays further information about the rule and other actions that you can take on the rule
(Delete, Activate/Deactivate, or Edit).

Consult with Palo Alto Networks Support before making any changes to the EPMs in security
policy rules.

TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection 187

Windows Exploit Protection Modules (EPMs)
To combat attackers from leveraging software vulnerabilities on Windows endpoints, Traps employs the
following exploit protection modules (EPMs):

Name Type Description

CPL Protection Application Protects against vulnerabilities related to the display routine for
Protection Windows Control Panel shortcut images, which can be used as a
malware infection vector.

DEP Application Data execution prevention (DEP). Prevents areas of memory

Protection designated as containing data from running as executable code.

DLL Security Application Prevents access to crucial DLL metadata from untrusted code
Protection locations.

DLL-Hijacking Application Prevents DLL-hijacking attacks where the attacker attempts to load
Protection Protection DLLs from unsecured locations to gain control of a process.

Exception Heap Application Detects instances of heap sprays upon occurrence of suspicious
Spray Check Protection process crashes (indicative of exploitation attempts).

Exploit Kit Application Protects against the fingerprinting technique used by browser exploit
Fingerprinting Protection kits to identify informationsuch as the OS or applications which
Protection run on an endpointwhich attackers can use to leverage an attack or
evade protection capabilities.

Font Protection Application Prevents improper font handling, a common target of exploits.
Protection

Hot Patch Application Prevents the use of system functions to bypass DEP and address
Protection Protection space layout randomization (ASLR).

JIT Mitigation Application Prevents an attacker from bypassing the operating system's memory
Protection mitigations using just-in-time (JIT) compilation engines. In ninja-
mode, you can also configure advanced hooks and whitelists for this
module.

Kernel Privilege Kernel Prevents an attacker from using the privilege information of another
Escalation Protection process with greater privileges to run a process with system
Protection permissions.

Library Application Enforces relocation of specific modules that exploitation attempts

Preallocation Protection commonly utilize.

Memory Limit Application Detects instances of heap sprays using the Palo Alto Networks
Heap Spray Protection proprietary algorithm, which is triggered by a sudden increase in
Check memory consumption (indicative of ongoing exploitation).

188 TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection

Name Type Description

Null Application Prevents malicious code from mapping to address zero in the
Dereference Protection memory space, making null dereference vulnerabilities unexploitable.
Protection

ROP Mitigation Application Protects against the use of return oriented programming (ROP) by
Protection protecting APIs used in ROP chains.

SEH Protection Application Prevents hijacking of the Structured Exception Handler (SEH), a
Protection commonly exploited control structure called Linked List, which
contains a sequence of function records.

Shellcode Application Reserves and protects certain areas of memory commonly used to
Preallocation Protection house payloads using heap spray techniques.

ShellLink Application Prevents shell-link logical vulnerabilities.

Protection Protection

SysExit Application Protects against the use of return oriented programming (ROP) by
Protection protecting APIs used in ROP chains.

UASLR Application Improves or altogether implements ASLR (module location

Protection randomization) with greater entropy, robustness, and strict
enforcement.

TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection 189

Mac Exploit Protection Modules (EPMs)
To combat attackers from leveraging software vulnerabilities on Mac endpoints, Traps employs the
following exploit protection modules (EPMs):

Name Type Description

Dylib-Hijacking Application Prevents Dylib-hijacking attacks where the attacker attempts to

Protection Protection load dynamic libraries from unsecured locations to gain control of a
process.

JIT Mitigation Application Prevents an attacker from bypassing the operating system's memory
Protection mitigations using just-in-time (JIT) compilation engines. In ninja-
mode, you can also configure advanced hooks and whitelists for this
module.

Kernel Privilege Kernel Prevents an attacker from using the privilege information of another
Escalation Protection process with greater privileges to run a process with system
Protection permissions.

ROP Mitigation Application Protects against the use of return oriented programming (ROP) by
Protection protecting APIs used in ROP chains.

190 TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection

Create an Exploit Protection Rule
An exploit protection rule uses exploit protection modules (EPMs) to protect processes in your organization
from specific exploitation techniques. Each module prevents attempts to exploit program vulnerabilities
related to memory corruption and software logic flaws and protects against a specific attack method, such
as DLL hijacking or heap corruption. If a process is vulnerable to a specific type of attack, you can activate
an EPM to protect it. Although Traps protects common processes automatically, you can tailor your exploit
protection policy to meet the needs of your organization.
For each exploit protection rule you add, configure EPM-specific settings and choose the process or
processes to which the rule applies. You can apply the rule to a single process, multiple processes, or all
processes. Additional settings typically include EPM activation, Traps behavior, and user notification.

As with other types of rules, you can reduce the scope of an exploit protection rule by specifying Target
Objects and Conditions that must be satisfied for the rule to apply. A target object can be any user, group,
organizational unit, or computer that appears in Active Directory or any existing endpoint on which the
Traps agent is installed. A condition can refer to a specific file, the specific version or range of versions for a
file, or a registry path that must exist on the endpoint.

Additional EPMs and fine-grained settings are hidden and are accessible only in ninja mode . To configure
these EPMs and settings, you must enter an administrative password.

Configuring exploit protection rules is an advanced feature. To change or override an exploit

protection rule, consult with the Palo Alto Networks support team.

STEP 1 | Configure a new exploit protection rule.

Select Policies > Exploit > Protection Modules.

STEP 2 | Select the operating system, either Windows or macOS.

STEP 3 | From the action menu , select Add to add a new rule that applies to the operating system
you previously selected.

STEP 4 | Configure EPM injection.

TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection 191

 By default, EPM injection is enabled. To disable all exploit protection of the protected processes on your
system, select the option at the bottom of the list of EPMs to Disable All EPM Injection.

STEP 5 | Configure the settings for the EPM module.

1. Select the EPM from the list and configure its settings in the Details section. The settings for each
type of EPM are different but can include preferences on whether or not to terminate a process and
notify a user about a security event.
2. Repeat the process to add and configure additional EPMs. For more information on the different
types of EPMs, see Exploit Protection Rules.

Changing EPM definitions changes the order in which rules are evaluated and can
affect your protection level (see Policy Enforcement). To avoid compromising your
organizational security, consult with Palo Alto Networks Support.

STEP 6 | Select the processes for which you want to apply the rule.
Before configuring an exploit protection rule on a new process, you must define the process and the
protection type on the Policies > Exploit > Process Management page. To add a new process, see Add
a New Protected Process. To change the protection type of a process, for example from Unknown to
Protected, see View, Modify, or Delete a Process.
1. Select the Processes tab.
2. Narrow the list of processes by selecting the process type from the drop-down, either Protected or
Provisional. Provisional processes are processes that are undergoing a test run and are monitored
separately from protected processes. For a list of processes that are protected by the default security
policy, see the release notes for your associated content update version.
3. Select one or more processes to which to apply the rule, and then click Add. Or, to apply the rule to
all protected or provisional processes, select All Processes.

STEP 7 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints.

STEP 8 | (Optional) Define the Target Objects to which to apply the restriction rule.
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 9 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 10 | Save the exploit protection rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Exploit > Protection
Modules page and then click Activate.
Apply the rule to activate it immediately.

192 TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection

After saving or applying a rule, you can return to the Protection Modules page at any time to Delete or
Deactivate the rule.

TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection 193

Exclude an Endpoint from an Exploit
Protection Rule
When an endpoint attempts to launch an application that violates an exploit protection policy, the Traps
agent stops the process from running and reports the malicious process to the Endpoint Security Manager.
The Security Events > Threats page provides detailed information about processes that trigger security
events and the Exploit Protection Modules (EPMs) that prevent the attacks.
To allow the process to run on a specific endpoint without deleting or disabling the policy rule, create
an exclusion rule based on the security event details. Defining an exclusion rule disables the EPM that
prevented the process from running on a specific endpoint.

To avoid unnecessarily exposing your organization to attacks, create exclusion rules only
when necessary.

You can also create exclusion rules from scratch by adding Objects to the Exclude section of the rule (see
Create an Exploit Protection Rule).

STEP 1 | Launch the Threats page.

From the ESM Console, select Security Events > Threats.

STEP 2 | Select the event.

Select the security event for which you want to create the exclusion rule. The event expands to display
further details and actions about the security event.

STEP 3 | Click Create Rule to populate the rule with details about the specific EPM and endpoint. This
function is available only for exploit protection rules.
1. Review the details on the Processes, Conditions, Objects, and Name tabs.
2. By default the exclusion rule applies only to the endpoint on which the security event occurred. If
you want to exclude multiple objects or endpoints from the rule, add them to the Exclude section on
the Objects tab.
3. Apply the rule immediately or Save the rule to activate it later.

STEP 4 | Verify that the exclusion rule allows the process to run on the endpoint.
1. Open the Traps Console.
2. Select Check In Now to obtain the latest security policy.
3. Select Advanced > Policy and verify that the rule appears.
4. Launch the application on the endpoint to verify that the user can successfully run the process.

194 TRAPS ADMINISTRATOR'S GUIDE | Exploit Protection

Manage the Endpoints
The following topics describe how to manage the endpoints using the ESM Console:

> Manage Traps Action Rules

> Manage Agent Settings Rules
> Remove an Endpoint from the ESM Console

195
196 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints
Manage Traps Action Rules
Use action rules to perform one-time actions on the Traps agent that runs on each endpoint.
Traps Action Rules
Add a New Action Rule
Manage Data Collected by Traps
Uninstall or Upgrade Traps on the Endpoint

Traps Action Rules

Action rules enable you to perform one-time actions on the Traps agent that runs on each endpoint. For
each action rule, you must specify target object(s), condition(s), and one of the following administrative
actions to take on each endpoint:

Action Rules Description

Manage data files that Each endpoint stores prevention and security information that includes
the Traps agent creates historical data, memory dumps, and quarantined files. Using this type of
action rule, you can erase or retrieve data files that the Traps agent creates on
the endpoint. For more information, see ManageData Collected by Traps.

Uninstall or upgrade Create an action rule to uninstall or upgrade Traps from the Endpoint Security
the Traps software Manager. To upgrade the Traps software on an endpoint, upload the software
zip file to the ESM (ESM) Server and specify the path when configuring the
action rule. For more information, see Uninstallor Upgrade Traps on the
Endpoint.

Traps does not apply action rules until the Traps agent receives the updated security policy,
typically with the next heartbeat communication with the server. To manually retrieve the
latest security policy from the ESM Server, select Check In Now on the Traps Console.

You can create or edit action rules on the Actions summary and management page (Settings > Agent >
Actions). Select a rule to display additional information about that rule and other actions that you can take
on the rule (Duplicate, Delete, or Activate/Deactivate). For more information, see ManageTraps Action
Rules.

Add a New Action Rule

For each action rule, you can specify organizational objects, conditions, and actions to take on each
endpoint. Action rules apply to Traps agents on endpoints running the operating system you select.

STEP 1 | Create a new action rule.

Select Settings > Agent > Actions.

STEP 2 | Select the type of operating system (Windows or macOS) and then Add a new rule.

STEP 3 | Select the type of task you want to perform.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 197

 Select one of the following action rule types and then configure the settings according to the type of
action:
Agent Data For more information, see Manage Data Collected by Traps.
Agent Installation For more information, see Uninstall or Upgrade Traps on the Endpoint.

STEP 4 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat this step to add more conditions, as needed. To add a
condition to the Conditions list, see Define Activation Conditions for a Rule.

STEP 5 | (Optional) Define the Target Objects to which to apply the action rule. By default, a new rule
applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 6 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 7 | Save the action rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Actions page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Actions page at any time to Delete or Deactivate
the rule.

Manage Data Collected by Traps

To manage data collected by Traps, you can configure an action rule that runs only one time on the
endpoint; after the Traps agent performs the action once, it will not repeat the action. To perform the same
action again, Duplicate the action from the Settings > Agent > Actions page.
STEP 1 | Create a new action rule.
Select Settings > Agent > Actions and then Add a new rule.

STEP 2 | Configure the tasks you want to perform on the Traps data stored on the endpoints.
Select Agent Data and then select any of the following options to manage Traps agent data.
Clear historyEach endpoint stores a history of security prevention events. Select this option to clear
historical data files from the Traps Console.
Erase memory dumpsMemory dumps are records of the contents of system memory when a
prevention event occurs. Select this option to erase the system memory records from target objects.
Erase quarantined filesWhen a security event occurs on an endpoint, Traps captures memory
dumps and recent files associated with the event and stores (quarantines) them in the forensic folder

198 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

 on the endpoint. Select this option to delete the files associated with the security event from the
target objects.
Retrieve collected data from the agentTraps collects security event history, memory dumps, and
other information associated with a security event. Select this option to retrieve all the information
saved from all events that occurred on the endpoint. After this rule runs, the Traps agent sends all
the data related to the prevention event, including a memory dump of the protected process, to the
designated forensic folder.
Retrieve collected logs from the agentTraps collects detailed application trace logs and stores
information about processes and applications that run on the endpoint. Use the log file to debug an
issue with an application or investigate a specific problem captured in the log. Select this option to
create an action rule that retrieves all the application trace information for an endpoint. After this rule
runs, the Traps agent sends all the logs to the forensic folder.

STEP 3 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule.

STEP 4 | (Optional) Define the Target Objects to which to apply the action rule. By default, a new rule
applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the action rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Actions page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Actions page at any time to Delete or Deactivate
the rule.

STEP 7 | Next steps...

View the status of the ruleAfter creating the action rule, you can view its status from the Actions
page. The status displays the number of agents that successfully completed the action and the
number of agents that failed to complete the action.
Duplicate the ruleFrom the Actions page, select the rule and click Duplicate. The ESM Console uses
the settings from the rule you selected to populate a new rule. You can then change the scope of the
rule by applying it to different target objects or leave it as is to run it again with the same settings;
Then, Save or Apply the rule as described in the previous step.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 199

 Retrieve dataIf you created an action rule to retrieve data from the endpoint, select Monitor >
Data Retrieval to view the Upload State of all data uploads. After the Traps agent completes the data
upload, this page displays the event along with a link which allows you to Download the data.

Uninstall or Upgrade Traps on the Endpoint

Create a new agent actions rule to uninstall Traps from the target objects or upgrade Traps using software
that is accessible by the ESM Console.

STEP 1 | Create a new action rule.

Select Settings > Agent > Actions and then Add a new rule.

STEP 2 | Define the tasks you want to perform on the Traps agent on the endpoints.
1. Select Agent Installation and then select Uninstall to uninstall the Traps software or Upgrade from
path to browse to and then select the installation file to use for upgrading the Traps software.
2. Enter the Uninstall Password.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the action rule. By default,
a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the action rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Actions page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Actions page at any time to Delete or Deactivate
the rule.

200 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

Manage Agent Settings Rules
Create agent settings rules from a central location to change preferences related to Traps.
Traps Agent Settings Rules on page 201
Add a New Agent Settings Rule on page 202
Define Event Logging Preferences on page 203
Hide or Restrict Access to the Traps Console on page 204
Define Communication Settings Between the Endpoint and the ESM Server on page 205
Collect New Process Information on page 208
Manage Service Protection on page 209
Change the Uninstall Password on page 210
Create a Custom User Alert Message on page 211

Traps Agent Settings Rules

Agent settings rules enable you to change preferences related to Traps from a central location. From the
Settings > Agent > Settings page, you can create rules to manage the following Traps settings:

Agent Settings Description

Event logging Configure a size quota for endpoint logs. For more information, see Define
Event Logging Preferences.

Heartbeat frequency Determine the frequency at which the Traps agent sends a heartbeat message
to the ESM Server. The optimal frequency is determined according to the
number of endpoints in the organization and the typical network load. For
more information, see Define Heartbeat Settings Between the Agent and the
ESM Server.

New process Configure Traps agents to collect new processes from endpoints. When this
information collection option is enabled, Traps reports every new process that runs on an endpoint
to the ESM Server. You can view the processes in the Process Management
view of the ESM Console and choose whether to create security rules related
to the processes. For more information, see Collect New Process Information.

Service protection (Windows only) Prevent attempts to disable or make changes to the Traps
registry values and files. When this option is enabled, users cannot shut down
or modify the Traps agent service. For more information, see Manage Service
Protection.

Agent security (Windows only) By default, users and administrators must enter a password
to uninstall the Traps application. Use this option to change the password. For
more information, see Change the Uninstall Password.

Communication Configure the amount of time, known as the timeout value, after which Traps
stops initiating attempts to reconnect to the ESM Server when the server
becomes unreachable. Configure the grace period to specify when Traps
should attempt to reestablish communication. For more information, see
Define Communication Settings Between the Agent and the ESM Server.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 201

 Agent Settings Description

User visibility and Determine whether and how end users can access the Traps Console
access application. Optionally, you can configure the console so that only
administrators can access it. For more information, see Hide or Restrict
Access to the Traps Console.

User alerts Customize the general settings for all user alerts, including the display image
and footer. You can also configure the title that appears on user alerts related
to protection modules, restrictions, and unknown files. For more information,
see Create a Custom User Alert Message.

Traps does not apply agent setting rules until the Traps agent receives the updated security
policy, typically with the next heartbeat communication with the server. To manually retrieve
the latest security policy from the ESM Server, select Check-in now on the Traps Console.

Select a rule on the Settings page to display additional information about that rule and other actions that
you can perform to manage the rule (Delete, Activate/Deactivate, or Edit). For more information, see
Manage Agent Settings Rules.

Add a New Agent Settings Rule

For each agent settings rule, you can specify organizational objects, conditions, and Traps preferences to
apply. Agent settings rules apply to Traps agents on endpoints running the operating system you select.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings.

STEP 2 | Select the type of operating system (Windows or macOS) and then Add a new rule.

STEP 3 | Select the type of setting that you want to change and configure your preferences.
Select one of the following, and then configure the settings according to the type of preference:
Event LoggingFor more information, see Define Event Logging Preferences.
Heartbeat SettingsFor more information, see Define Heartbeat Settings Between the Agent and
the ESM Server.
Communication SettingsFor more information, see Define Communication Settings Between the
Agent and the ESM Server.
Process ManagementFor more information, see Collect New Process Information.
(Windows only) Service ProtectionFor more information, see Manage Service Protection.
(Windows only) Agent SecurityFor more information, see Change the Uninstall Password.
User Visibility & AccessFor more information, see Hide or Restrict Access to the Traps Console.
User AlertsFor more information, see Create a Custom User Alert Message.

STEP 4 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule.

STEP 5 | (Optional) Define the Target Objects to which to apply the agent settings rule. By default, a new
rule applies to all objects in your organization.

202 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

 To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 6 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 7 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Define Event Logging Preferences

Traps stores event information and quarantined files in a temporary local storage folder. To adjust the size
of the disk quota, configure an agent settings rule:

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Define the event logging settings for the endpoints.

1. Select Event Logging.
2. Select Set disk quota (MB) and specify the size of the temporary local storage folder that Traps will
use to store event logs and quarantined files. Specify the quota amount in MB (default is 5,120; range
is 0 to 10,000,000). After the storage folder reaches the size quota, Traps purges the event logs by
deleting the oldest logs first to make room for new logs.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 203

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Hide or Restrict Access to the Traps Console

By default, a user can access the Traps Console to view information about the current status of the
endpoint, changes to the security policy, and any security events. When a security event is triggered,
the user also receives a notification about the event. The notification includes the application name, the
publisher, and a description of the exploit prevention or restriction rule that triggered the notification.

You can create an agent settings rule to change the accessibility of the console and specify whether to hide
notifications from users.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings, and then Add a new rule.

STEP 2 | Define user visibility and access for the endpoints.

Select User Availability & Access and then select one or more of the following options:
Hide tray iconHide the tray icon which Traps otherwise adds to the notification area (system tray)
on the endpoint.
Disable access to the Traps consoleDisable the ability to open the console.
Hide Traps user notificationsHide notifications that Traps otherwise displays when the agent
encounters a prevention or notification event.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

204 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Define Communication Settings Between the Endpoint and the

ESM Server
The Traps agent on the endpoint communicates with the ESM Server at specific intervals by sending
heartbeat messages and reports and by querying for unknown hash verdicts. Traps stops trying to reach the
server if communication attempts fail for a period of time that exceeds a timeout value and Traps resumes
attempts to reestablish communication with the server after a grace period.
To modify the default values for the heartbeat cycle, reports interval, timeout value, and/or grace period,
create an agent settings rule on the ESM Console using the following workflows:
Define Heartbeat Settings Between the Agent and the ESM Server on page 205
Define Communication Settings Between the Agent and the ESM Server on page 206

Define Heartbeat Settings Between the Agent and the ESM Server
During the heartbeat communication, the Traps agent requests the current security policy and sends a
response to the Endpoint Security Manager to report the status of the endpoint. The frequency at which
the Traps agent sends heartbeat messages to the ESM Server is called the heartbeat cycle. The optimal
frequency is determined according to the number of endpoints in the organization and the typical network
load.
Traps also reports changes in service, including start, stop, and crash events and new processes discovered
on the endpoint. The frequency at which the Traps agent sends report notifications is called the reports
interval.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Define the frequency of heartbeat messages and/or report notifications.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 205

 Select Heartbeat Settings and then configure either or both of the following settings:
Set distinct heartbeat cycleModify the frequency (in minutes) at which Traps sends heartbeat
messages to the ESM Server. Range is 0-144,000; Default is 60.
Set send reports intervalModify the frequency (in minutes) at which the Traps agent sends report
notifications, including changes in service, crash events, and new processes. Range is 0-144,000;
Default is 480 (8 hours).

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Define Communication Settings Between the Agent and the ESM

Server
By default, the Traps agent applies a No Connection policy to all unknown executable files upon startup.
The policy remains in place until the Traps agent can perform the ESM Server discovery to build a list of
available servers in order of shortest path.
After the Traps agent builds the list of available servers and a user opens an unknown executable file, Traps
queries the first ESM Server in the list to determine the hash verdict. If that server is unreachable or is
unable to respond to the request within the maximum allotted time, the Traps agent stops trying to reach
the ESM Server and assigns the executable file a No Connection verdict. If the user opens another unknown
executable file before Traps determines that the ESM Server is unavailable, it will also query the first ESM
Server in the list to determine the hash verdict. However, if the user opens another unknown executable
file after the Traps agent determines that the ESM Server is unavailable, Traps will query the next ESM
Server in the list.

206 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

 The Traps agent also periodically polls the ESM server list to determine which servers are available and, of
those available, which servers are closest. Other events, such as an IP address change on the endpoint, can
also trigger Traps to rebuild the list of ESM Servers.
Use the following workflow to change the timeout and intervals for establishing communication with the
ESM Server.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Define the communication settings between the Traps agent and the ESM Server.
Select Communication Settings and then select one or more of the following options:
Set Agent-WildFire Process Verdict TimeoutSpecify the amount of time (in seconds) that Traps
will wait for the ESM Server to respond to a verdict request (default is 10). After the timeout
period expires, Traps assigns the process a No Connection verdict. Traps will attempt to reestablish
communication only if a user clicks Check-In Now on the Traps Console, or if Traps needs to query
the ESM Server for unknown hash verdicts.

If your endpoints frequently lose their connection with the server, consider increasing the
timeout value.

Set No Connection Refresh IntervalSpecify the frequency (in minutes) at which the Traps agent
checks for available ESM Servers after entering a No Connection state (default is 1).
Set ESM Server Validation IntervalSpecify the frequency (in hours) at which the agent will verify
the integrity of the ESM Server list (default is 1).

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 207

 Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Collect New Process Information

By default, Traps protects the most commonly used and well-known processes on your endpoints. In
addition, when WildFire is enabled, Traps automatically reports unknown executable files to the Endpoint
Security Manager. If WildFire is disabled, it is recommended to create an agent settings rule to enable Traps
to collect the names of any new processes that are run on the endpoints and report them to the Endpoint
Security Manager. The ESM Console displays the processes as Unprotected on the Process Management
page.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Enable the collection of new processes on the endpoints.

Select Process Management and then enable the option to Collect new process information.
When Traps detects new processes, Traps reports the processes to the ESM Server. The ESM Console
lists the new processes on the Policies > Exploit > Process Management page as unprotected processes.
From there you can change the protection type (see View, Modify, or Delete a Process on page 140).
After changing the protection type, you can then use it to Create an Exploit Protection Rule on page
191.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.

208 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

 After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

STEP 7 | On a regular basis, review the list of unprotected processes and evaluate whether add them to
existing security rules or create new rules to protect them.
1. Select Policies > Exploit > Process Management.
2. Filter or sort the table by the Unprotected protection type.
3. Review each process and decide whether to change the protection type:
Change the protection type to Provisional, if you want to use the process in a security rule run as
a test.
Change the protection type to Protected to take advantage of existing rules that apply to all
processes. See View, Modify, or Delete a Process on page 140. You can also add the process to
rules that apply to specific processes, as needed.

Manage Service Protection

Service protection allows you to protect the Traps service running on your endpoints. When service
protection is enabled, users cannot change registry values or files associated with the Traps agent and
cannot stop or modify the Traps service in any way.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Enable service protection.

Select Service Protection and then choose either of the following options:
Enable service protection
Disable service protection

STEP 3 | (Optional) Add Conditions to the rule. By default, a new rule does not contain any conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule.

STEP 4 | (Optional) Define the Target Objects to which to apply the agent settings rule. By default, a new
rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 209

 Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

Change the Uninstall Password

By default, you must enter the uninstall password specified during installation to uninstall Traps from an
endpoint. Change the default password by creating an agent settings rule.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | Change the password.

1. Select Agent Security and then select the option to Set uninstall password.
2. Enter the password that the user or administrator must enter to uninstall Traps. The password must
be at least eight characters long.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Units, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

210 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

Create a Custom User Alert Message

Traps displays prevention and notification messages when a file or process violates a security policy and
the termination behavior is configured to block the file and notify the user or to log the issue and notify the
user. Use an agent settings rule to customize the general settings for all user alerts, including the display
image and footer. You can also configure the title that appears on user alerts related to protection modules,
restrictions, or unknown files.

STEP 1 | Create a new agent settings rule.

Select Settings > Agent > Settings and then Add a new rule.

STEP 2 | (Optional) Customize the icon and footer used for all user alert messages.
1. Select User Alerts and then select General Settings (icon and footer).
2. Customize either or both of the following options:
IconTo select an image that will appear in place of the Traps icon in user alert messages, Browse
to and then Upload a new image. The preview on the right allows you to view an example of how
the user alert message will look with the new icon.
Action/FooterTo provide contact or other information along the bottom of the message, enter
up to 250 characters. The preview on the right shows your changes as you make them. To specify
an email address, use standard HTML format, for example:
<a href="mailto://[email protected]"> Help Desk</a>
3. Select the Triggering Action: Prevention Mode or Notification Mode.

STEP 3 | (Optional) Customize the title text for user alerts.

1. From the User Alert Window drop-down, select the type of user alert:
Protection ModulesA user alert that Traps displays when it activates an exploit or malware
protection module to protect a process or block suspicious behavior.
Execution RestrictionsA user alert that Traps displays when a user opens an executable file from
a location that is restricted by a restriction rule.
WildFire Unknowns-TerminateA user alert that Traps displays when a user opens an unknown
executable file and the WildFire behavior for unknown files is configured to terminate the process
2. Enter the title text to display on the specific user alert type.
3. Select the Triggering Action: Prevention Mode or Notification Mode.

STEP 4 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 211

STEP 5 | (Optional) Define the Target Objects on page 128 to which to apply the agent settings rule. By
default, a new rule applies to all objects in your organization.
To define a subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 6 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 7 | Save the agent settings rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Settings > Agent > Settings page
and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Settings page at any time to Delete or Deactivate
the rule.

212 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints

Remove an Endpoint from the ESM Console
In situations where you must remove one or more endpoints from the Endpoint Security Manager, use the
Delete Selected option from the action menu at the top of the Health page.

You might delete an endpoint to:

Clean up duplicate entries.
Remove endpoints that are no longer in use.
Free up a license from an inactive Traps agent before the automatic revocation period expires.
Release the license from a VDI session that did not close correctly.
When you delete an endpoint, the ESM immediately frees up the license and returns it to the available pool
of licenses for use by another Traps agent. After you delete the endpoint, the Traps agent continues to
apply the last known policy and remains licensed using the original license. However, after the license and
grace period (a period of two days) expires, Traps disables protection.
If at any time, the Traps agent sends a heartbeat communication and successfully connects to the ESM
Server, the ESM Server treats the agent as a new agent and issues it a new license from the available license
pool.
To delete an endpoint from the ESM Console:

STEP 1 | From the ESM Console select Monitor > Agent > Health.

STEP 2 | In the agent health table, select the checkbox for one or more endpoints you want to delete.

To quickly locate an endpoint, use the filter controls at the top of the columns.

STEP 3 | Select Delete Selected from the action menu at the top of the Health table. Click OK to
confirm the deletion.
The ESM Console changes the status of the endpoint to Historic and hides the endpoint from the
default display of endpoints on the Health page (to view the deleted endpoints, filter the status column
by Historic).

TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints 213

214 TRAPS ADMINISTRATOR'S GUIDE | Manage the Endpoints
Forensics
> Forensics Overview on page 217
> Best Practices for Managing Forensic Data on page 220
> Manage Forensics Rules and Settings on page 221
> Agent Query on page 228

215
216 TRAPS ADMINISTRATOR'S GUIDE | Forensics
Forensics Overview
Forensics Flow on page 217
Forensic Data Types on page 218

Forensics Flow

Phase 1: Prevention Event Triggered on page 217

Phase 2: Automated Analysis on page 217
Phase 3: Automated Detection on page 217
Phase 4: Collection of Forensic Data on page 218

Phase 1: Prevention Event Triggered

When an attacker attempts to exploit a software vulnerability, the Traps protection modules spring into
action to halt malicious process behavior and ultimately block the attack. For example, consider the case
where a file tries to access crucial DLL metadata from untrusted code locations. If the DLL Security module
is enabled to protect processes in your organization, Traps immediately halts the process attempting to
access the DLL metadata. Traps records the event in its event log and notifies the user about the security
event. If configured, Traps displays a customized notification message (for more information, see Create a
Custom User Alert Message on page 211).
After successfully halting an exploit attempt, Traps collects and analyzes data related to the event as
described in Phase 2: Automated Analysis on page 217.

Phase 2: Automated Analysis

When a security event occurs on an endpoint, Traps freezes the contents of the memory, and stores it in a
data file known as a memory dump. From the ESM Console you can fine-tune memory dump settings that
specify the size of the memory dumpeither small, medium, or full (the largest and most complete set of
information)and whether Traps should automatically upload the memory dump to the forensic folder. For
more information, see Define Memory Dump Preferences on page 224.
After creating the memory dump, Traps deciphers the file and extracts information to identify the
underlying cause and to verify the validity of the prevention. Use the results of the analysis to diagnose and
understand the event.
Depending on the type of event, Traps may also use automated detection tools to scan for malicious
behavior as described in Phase 3: Automated Detection on page 217.

Phase 3: Automated Detection

After Traps analyzes the memory dump, Traps automatically performs secondary analysis, the results of
which you can use to verify the legitimacy of a prevention event. The secondary analysis provides greater
insight into the nature of the event by using detection toolsincluding ROP chain detection and heap spray
detectionto identify additional malicious activity traces.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 217

 If the detection tools successfully identify malicious activity traces, Traps stores the information to a system
log file on the endpoint using the following syntax: Traps prefix-unique client ID-event ID. Traps also
reports the detection to the ESM Server. The ESM Console displays the results in the Traps Automatic
Dump Analysis section for each prevention event record including whether or not each detection tool was
successful in identifying additional malicious activity. If Traps fails to capture the memory, creates the dump
file incorrectly, or otherwise fails to complete the secondary analysis, the ESM Console hides this section in
the event record.
If the detection tools identify one or more additional malicious activity traces there is a high likelihood that
the prevention event is a legitimate threat.
To further troubleshoot or analyze security events, view the forensic data that Traps collects as described in
Phase 4: Collection of Forensic Data on page 218.

Phase 4: Collection of Forensic Data

After analyzing the files, Traps notifies the ESM about the security event and can send additional forensic
data to the forensic folder.
If your security policy contains a forensic data collection rule, Traps collects one or more specified data
types and uploads the file(s) to the forensic folder. Depending on the preferences, Traps can collect URI
that were accessed, drivers, files, and relevant DLLs that are loaded in memory under the attacked process,
and ancestor processes of the process that triggered the security event. For more information, see Define
Forensics Collection Preferences on page 225.
By default, Traps uses a web-based Background Intelligent Transfer Service (BITS) folder that utilizes idle
network bandwidth to upload data. For more information, see Change the Default Forensic Folder on page
221.
You can also manually retrieve forensic data for a specific security event by creating a one-time action rule
to retrieve the data. For more information, see Retrieve Data About a Security Event on page 226. To
view the status of the forensic upload select Monitor > Data Retrieval.

Forensic Data Types

When a security event occurs on an endpoint, Traps can collect the following information:

Forensic Data Type Description

Memory Dump Contents of memory locations captured at the time of an event.

Accessed Files Files that are loaded in memory under the attacked process for in-depth event
inspection including:
Relevant DLL retrieval including their path
Relevant files from Temporary Internet Files folder
Open files (executables and non-executables)

Loaded Modules PE image files that are loaded on the system at the time of a security event.

218 TRAPS ADMINISTRATOR'S GUIDE | Forensics

Forensic Data Type Description

Accessed URI Network resources that were accessed at the time of the security event and
uniform resource identifier (URI) information.
The Traps agent can collect accessed URI from Internet Explorer and Firefox
browsers only. When an event occurs that is related to other browsers (for
example, Microsoft Edge), you will not be able to access URI data for further
analysis.
Collected information includes:
URIs including hidden links and frames of the relevant attacked threads.
Java applet source URIs, filenames and paths, including parents,
grandparents, and child processes
Collection of URI calls from browser plug-ins, media players, and mail-
client software

Ancestor Processes Information about ancestry processesfrom browsers, non-browsers, and

Java applet child processesat the time of a security event including:
Separate sources and destinations for Thread Injection
Restricted child process parents and grandparents

To customize which types of files are collected, Create a Forensics Rule on page 223.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 219

Best Practices for Managing Forensic Data
Configure the Forensic Folder to Communicate Over SSLTo encrypt forensic data, we strongly
recommend that you use SSL to communicate with the forensic folder. To use SSL, specify the
HTTPS prefix and use port 443 when configuring the Forensic Folder URL (for example, HTTPS://
ESMserver.Domain.local:443/BitsUploads).
Collect full memory dumps for all processesWhen a security event occurs on the endpoint, Traps can
capture the contents of memory related to the protected process and automatically send the data to
the ESM Server. This information enables you to further analyze security events when they occur. By
sending the full memory dump, Traps captures the most complete amount of data.
Create a script to monitor the disk quotaDue to the lack of an automated deletion mechanism, data
related to a large number of prevention events can fill the disk quota on the server that hosts the
quarantine folder. As a result, new prevention information will not be written once the quota is full.
After the disk quota is full, you cannot erase the prevention data. By creating a script to monitor the disk
quota, you can ensure that you are able to monitor and then delete older data, as needed.
Enable forensics collectionWhen a security event occurs on the endpoint, Traps can collect additional
forensic data including which files were accessed, modules that were loaded into memory, URIs that
were accessed, and ancestor processes of the process that triggered the security event. You can use
the data collected by Traps when troubleshooting a security event. For more information, see Define
Forensics Collection Preferences on page 225.

220 TRAPS ADMINISTRATOR'S GUIDE | Forensics

Manage Forensics Rules and Settings
Forensics Rules on page 221
Change the Default Forensic Folder on page 221
Create a Forensics Rule on page 223
Define Memory Dump Preferences on page 224
Define Forensics Collection Preferences on page 225
Retrieve Data About a Security Event on page 226

Forensics Rules
Forensics management rules enable you collect forensics data captured by Traps from a central location.
From the Policies > Forensics > Management page, you can create rules to manage the following forensics
settings:

Agent Settings Rules Description

Memory dump Specify files settings including a size for the memory dump and enable
settings Traps to send the memory dump to the server automatically. This
setting only applies to data collected from prevention events related to
protected processes. For more information, see Define Memory Dump
Preferences on page 224.

Forensics collection Enable Traps to collect forensic data for each security event including
which files were accessed, modules that were loaded into memory, URIs
that were accessed, and ancestor processes of the process that triggered
the security event. For more information, see Define Forensics Collection
Preferences on page 225.

Change the Default Forensic Folder

Change the Forensic Folder Destination Using the ESM Console on page 221
Change the Forensic Folder Destination Using the DB Configuration Tool on page 222

Change the Forensic Folder Destination Using the ESM Console

To allow you to further troubleshoot or analyze security events, such as a prevention or crash, Traps
uploads the forensic data to a web-based forensic folder. During installation of the ESM Console, the
installer enables the Background Intelligent Transfer Service (BITS) which utilizes idle network bandwidth to
upload the data to forensic folder.
To analyze a security event, create an action rule to retrieve the forensic data from the endpoint (see
Manage Data Collected by Traps on page 198). When Traps receives the request to send the data, it copies
the files to the forensic folder (also referred to in the Endpoint Security Manager as the quarantine folder),
which is a local or network path that you specify during the initial installation.
You can change the path of the forensic folder at any time using the Endpoint Security Manager or using
the DB Configuration Tool (see Change the Forensic Folder Destination Using the DB Configuration Tool on
page 222). All endpoints must have write-permission to this folder.

STEP 1 | Select Settings > ESM > Settings.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 221

STEP 2 | In the Server Configuration area, enter the web-based URL, in the Forensic Folder URL field to
use BITS to upload forensic data.

To encrypt forensic data, we strongly recommend that you use SSL to communicate
with the forensic folder. To use SSL, include the fully qualified domain name (FQDN)
and specify port 443, for example HTTPS://ESMserver.Domain.local:443/
BitsUploads. If you are not using SSL, specify port 80, for example http://
ESMSERVER:80/BitsUploads.

Change the Forensic Folder Destination Using the DB Configuration

Tool
To allow you to further troubleshoot or analyze security events, such as a prevention or crash, Traps
uploads the forensic data to a web-based forensic folder. During installation of the ESM Console, the
installer enables the Background Intelligent Transfer Service (BITS) which utilizes idle network bandwidth to
upload the data to forensic folder.
To analyze a security event, create an action rule to retrieve the forensic data from the endpoint (see
Manage Data Collected by Traps on page 198). When Traps receives the request to send the data, it copies
the files to the forensic folder (also referred to in the Endpoint Security Manager as the quarantine folder),
which is a local or network path that you specify during the initial installation.
You can change the path of the forensic folder at any time using the Endpoint Security Manager (see
Change the Forensic Folder Destination Using the ESM Console on page 221) or using the Database (DB)
Configuration Tool.
The DB Configuration Tool is a command-line interface that provides an alternative to managing basic
server settings using the ESM Console. You can access the DB Configuration Tool using a Microsoft MS-
DOS command prompt run as an administrator. The DB Configuration Tool is located in the Server folder on
the ESM Server.

All commands run using the DB Configuration Tool are case sensitive.

STEP 1 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd
C:\Program Files\Palo Alto Networks\Endpoint Security Manager\Server

STEP 3 | (Optional) View the existing server settings:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server show
PreventionsDestFolder = \\ESMServer\Quarantine
InventoryInterval = 284
HeartBeatGracePeriod = 4200
NinjaModePassword = Password2
BitsUrl = https://CYVERASERVER.Domain.local:443/BitsUploads

222 TRAPS ADMINISTRATOR'S GUIDE | Forensics

 MaxActions = 5000

STEP 4 | Enter the web-based URL of the forensics folder.

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server BitsUrl http://ESMserver.Domain.local:443/
BitsUploads

To encrypt forensic data, we strongly recommend that you use SSL to communicate
with the forensic folder. To use SSL, include the fully qualified domain name (FQDN)
and specify port 443, for example HTTPS://ESMserver.Domain.local:443/
BitsUploads. If you are not using SSL, specify port 80, for example http://
ESMSERVER:80/BitsUploads.

STEP 5 | (Optional) To verify the path of the forensic folder, run the dbconfig server show command:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server show
PreventionsDestFolder = \\ESMServer-New\Quarantine
InventoryInterval = 284
HeartBeatGracePeriod = 4200
NinjaModePassword = Password2
BitsUrl = HTTPS://ESMserver.Domain.local:443/BitsUploads
MaxActions = 5000

Create a Forensics Rule

Create a forensics rule to define memory dump and forensics collection preferences.

STEP 1 | Configure a new forensics rule.

Select Policies > Forensics > Management and then click Add.

STEP 2 | Select the type of rule you want to configure.

Select one of the following types of forensics rules and configure the settings according to the type of
rule:
Memory DumpFor more information, see Define Memory Dump Preferences on page 224.
Forensics CollectionFor more information, see Define Forensics Collection Preferences on page
225.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions, as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the restriction rule.
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 223

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the forensics rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Forensics > Management
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Management page at any time to Delete or
Deactivate the rule.

Define Memory Dump Preferences

When a protected process crashes or terminates abnormally, Traps records information about the event
including the contents of memory locations and other data about the event in what is known as a memory
dump.
Create a forensics rule to determine how Traps manages process-related memory dumps including whether
to send memory dumps automatically to the forensic folder or change the size of the memory dump, either
small, medium, or full (the largest and most complete set of information).

STEP 1 | Configure a new forensics rule.

Select Policies > Forensics > Management and then click Add.

STEP 2 | Define memory dump preferences when a prevention event occurs on the endpoint.
1. Select Memory Dump and then select either of the following preferences:
Automatically send the memory dumps to the server by selecting Send the memory dumps
automatically.
Specify the size of the memory dump file by selecting the Memory dump size option and then
selecting Small, Medium, or Full from the drop-down.
2. Select the source processes from with Traps will collect memory dumps, either one or more Specific
processes or All processes.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions, as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the restriction rule.
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

224 TRAPS ADMINISTRATOR'S GUIDE | Forensics

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the forensics rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Forensics > Management
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Management page at any time to Delete or
Deactivate the rule.

Define Forensics Collection Preferences

To help you better understand and derive implications about the true nature of a security event when it
occurs on an endpoint, you can configure forensics collection options. At the time of a security event, Traps
can report the files that were accessed, modules that were loaded into memory, URIs that were accessed,
and ancestor processes of the process that triggered the security event.

STEP 1 | Configure a new forensics rule.

Select Policies > Forensics > Management and then click Add.

STEP 2 | Define forensics collection preferences.

Select Forensics Collection and then configure preferences in the following fields:
Report Accessed FilesSelect Enabled to collect information about files that are loaded in memory
under the attacked process for in-depth event inspection.
Report Loaded ModulesSelect Enabled to report which PE image files are loaded on the system at
the time of a security event.
Report Accessed URISelect Enabled to collect network resources that were accessed at the time
of the security event and uniform resource identifier (URI) information from web plug-ins, media
players, and mail clients.
Report Ancestor ProcessesSome applications can run Java applets as a process child, and even as
a process child of a process child and so on. Select Enabled to record information about the ancestry
processes from browsers, non-browsers, and Java applet child processes to allow you to better
understand the root of an event.
Alternatively, for each data type, you can Disable forensics collection or Inherit the settings from the
default security policy.

STEP 3 | (Optional) Add Conditions on page 125 to the rule. By default, a new rule does not contain any
conditions.
To specify a condition, select the Conditions tab, select the condition in the Conditions list, and then
Add it to the Selected Conditions list. Repeat to add more conditions, as needed. To add a condition to
the Conditions list, see Define Activation Conditions for a Rule on Windows Endpoints on page 126.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 225

STEP 4 | (Optional) Define the Target Objects on page 128 to which to apply the forensics rule. By
default, a new rule applies to all objects in your organization. To define a smaller subset of
target objects,
To define a smaller subset of target objects, select the Objects tab, and then enter one or more Users,
Computers, Groups, Organizational Unit, or Existing Endpoints in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the forensics rule.

Do either of the following:
Save the rule without activating it. This option is only available for inactive, cloned, or new rules.
When you are ready to activate the rule, select the rule from the Policies > Forensics > Management
page and then click Activate.
Apply the rule to activate it immediately.
After saving or applying a rule, you can return to the Management page at any time to Delete or
Deactivate the rule.

Retrieve Data About a Security Event

When a security event occurs on an endpoint, Traps collects forensic data including the contents of
memory and stores it on the endpoint. Use the forensic data to debug an issue or investigate a specific
problem with an application. Selecting this option creates an agent settings rule to retrieve the information
collected by Traps. After Traps receives the agent settings rule, the agent sends all the logs to the
designated forensic folder.

To create a general rule to retrieve data from one or more endpoints, see Manage Data Collected by Traps
on page 198.

STEP 1 | From the ESM Console, select Security Events > Threats to view security events related
to protected processes, or Monitor > Provisional Mode to view security events related to
provisional processes.

226 TRAPS ADMINISTRATOR'S GUIDE | Forensics

STEP 2 | Select the security event for which you want to retrieve data. The event expands to display
further details and actions about the security event.

STEP 3 | Click Retrieve Data. The ESM Console populates the settings for an agent settings rule.

STEP 4 | Review the rule details, and then click Apply to activate the rule immediately or Save to
activate the rule at a later date. At the next heartbeat communication with the ESM Server, the
Traps agent receives the new rule and sends the prevention data to the forensics folder.

STEP 5 | To view the status of the forensic upload select Monitor > Data Retrieval.

STEP 6 | After the upload is complete, click Download to save the prevention data locally or navigate to
the forensic folder. If you are no longer require the prevention data, you can, optionally, Delete
it from the Data Retrieval table.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 227

Agent Query
Use the Agent Query to search your Windows endpoints for a system file, folder, or registry key. Each
query runs in real-time as a one-time action rule and enables you to search for multiple parameters from a
central location.
Agent Query Flow
Search Endpoints for a File, Folder, or Registry Key
View the Results of an Agent Query

Agent Query Flow

After you create an agent query to Search Endpoints for a File, Folder, or Registry Key on page 228, the
ESM Server sends the query in the form of a one-time action rule at the next heartbeat communication with
the agent. If the query contains target objects and/or conditions, the ESM Server sends the query to only
those endpoints that match the target objects and conditions. If you did not specify any target objects or
conditions, the ESM Server sends the query to all endpoints.
When the Traps agent receives the query, it immediately searches the endpoint for the filename, folder,
and/or registry key on the local endpoint. If the query contains multiple search parameters, Traps evaluates
the queries separately and reports a match if it finds any of the search criteria. In the case of a matching
system file, the Traps agent also captures metadata about the file. The Traps agent then sends the
information to the ESM Server at the next heartbeat communication.
To see the latest search results, refresh the Agent Query page at any time. The ESM Console displays up
to 50 results in the Details view of each search query (see View the Results of an Agent Query on page
229).

Search Endpoints for a File, Folder, or Registry Key

To perform a centralized search for a system file, folder, or registry key on a Windows endpoint, use the
Agent Query.

STEP 1 | Create a new query.

1. From the ESM Console, select Policies > Forensics > Agent Query.
2. Add a new query.

STEP 2 | Configure one or more search parameters for the query. When multiple search parameters are
specified, Traps will return a result if the search matches any of the parameters.
1. Select the search parameters, either a File name, Folder name, or Registry Key name.
2. Enter the matching search value, and then click Add.

Optionally, you can use wildcards in the last portion of the file or folder name path, for
example: C:\Temp\*.txt
3. Repeat as needed to enter multiple search criteria.

STEP 3 | (Optional) Add conditions to the query.

Conditions specified here can restrict the scope of the query by sending it to only endpoints that match
or do not match the condition.
1. From the Conditions tab, select the condition in the Conditions list and click Add next to the
appropriate include or exclude condition list.
2. Repeat to add more conditions, if desired.

228 TRAPS ADMINISTRATOR'S GUIDE | Forensics

STEP 4 | (Optional) Define the target objects to which to apply the query. By default, the ESM server
sends the query to all endpoints in your organization.
Like conditions, target objects can decrease the scope of a query by targeting specific Users, Computers,
Groups, Organizational Unit, or Existing Endpoints.
Select the Objects tab, and then enter one or more target objects in the Include or Exclude areas.
The Endpoint Security Manager queries Active Directory to verify the users, computers, groups, or
organizational units or identifies existing endpoints from previous communication messages.

STEP 5 | (Optional) Review the rule name and description. The ESM Console automatically generates the
rule name and description based on the rule details but permits you to change these fields, if
needed.
To override the autogenerated name, select the Name tab, clear the Activate automatic description
option, and then enter a rule name and description of your choice.

STEP 6 | Save the query.

Do either of the following:
Save the query without activating it. When you are ready to run the query, select the rule from the
Policies > Forensics > Agent Query page and then click Activate.
Apply the query to run it immediately.

STEP 7 | Review the results of the query.

Although the Agent Query searches in real-time, the ESM Console does not automatically refresh the
page with the query results. As a result, you must refresh the page to view the current results.
See View the Results of an Agent Query.

View the Results of an Agent Query

The Agent Query page displays all saved and applied queries and enables you to review results for applied
queries. By expanding the row for the query, you can view additional information about matches including
when and on which Windows endpoint the match was found, the file or registry key that matched the
search parameter, and metadata details for the file. Use the results you receive after you run an agent query
to identify and take additional action, if needed, to secure the endpoint

STEP 1 | From the Policies > Forensics > Agent Query page, select the row for the applied query. The
row expands to display additional information about the query and includes any matches for
the query in the Agent Query, Found matches section.
For each applied query, the ESM Console displays the number of endpoints that received the query
(Applied On), the number of endpoints which successfully executed the search (Succeeded), and the
number of endpoints which failed to run the query or did not receive the query (Failed).

STEP 2 | (Optional) To view detailed information about the match, click Details.

The ESM Console displays up to 50 records of matches.

STEP 3 | (Optional) To view the full text, hover over cell of the Result or Metadata field.

STEP 4 | (Optional) To save the results to a comma-separated (CSV) file that you can parse, click the
action menu at the top of the page and select Export Logs.

TRAPS ADMINISTRATOR'S GUIDE | Forensics 229

STEP 5 | (Optional) There are additional tasks you can perform after reviewing the results of the query:
Remediate any issues with malicious files on the endpoint.
Duplicate the query, make any changes as required, and Apply it to run it again.
Delete the query and results from the ESM Console.

230 TRAPS ADMINISTRATOR'S GUIDE | Forensics

Reports and Logging
The Endpoint Security Manager can write logs to an external logging platform, such as security
information and event management (SIEM), Service Organization Controls (SOCs), or syslog, in
addition to storing its logs internally. The Endpoint Security Manager can also send logs to an
email address. Specifying an external logging platform allows an aggregated view of logs from
all ESM components.

> Event Log Types

> Common Variables Used in Events
> Forward Logs to an External Logging Platform
> Forward Logs to Panorama
> Forward Logs to Email

231
232 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging
Event Log Types
The ESM Console displays information about events that occur on your Traps components on the Logs
and Security Events pages. The events can include security events, policy changes, agent and ESM Server
status changes, and changes to settings. When you enable log forwarding to a SIEM or syslog device, or to
an email, you can customize the type of events that the ESM Console sends. The events are grouped into
the following categories based on the type of event:
Security Events on page 233
Policies - General on page 234
Policies - Rules on page 234
Policies - Process Management on page 235
Policies - Restriction Settings on page 235
Policies - Hash Control on page 236
Monitor - Agent on page 237
Monitor ESM on page 241
Settings - Administration on page 242
Settings - Agent on page 243
Settings - ESM on page 244
Settings - Conditions on page 245
Settings - Licenses on page 245

Security Events
The following table displays the security event logs you can forward to an external logging platform or
email.

Event Name Description

Prevention Event A process or executable file was blocked.

CEFPreventionEvent
LEEFPreventionEvent
SyslogPreventionEvent
EmailPreventionEvent

Notification Event A process or executable file exhibited suspicious behavior.

CEFNotificationEvent
LEEFNotificationEvent
SyslogNotificationEvent
EmailNotificationEvent

Post Detection Event An executable file that was previously allowed to run on an endpoint was
determined to be malware. Post detection events provide notifications for
each endpoint on which the file executed.
CEFPostDetectionEvent
LEEFPostDetectionEvent
SyslogPostDetectionEvent
EmailPostDetectionEvent

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 233

Policies - General
The following table displays the general policy logs you can forward to an external logging platform or
email.

Event Name Description

Protection Disabled An administrator disabled protection of all security rules on the ESM Console.
CEFDisabledProtection
LEEFDisabledProtection
SyslogDisabledProtection
EmailDisabledProtection

Protection Enabled An administrator re-enabled protection by all security rules on the ESM
Console.
CEFEnabledProtection
LEEFEnabledProtection
SyslogEnabledProtection
EmailEnabledProtection

Server Content Update A content update was installed.

Success
CEFServerContentUpdateSuccess
LEEFServerContentUpdateSuccess
SyslogServerContentUpdateSuccess
EmailServerContentUpdateSuccess

Server Content Update A content update failed to install.

Failure
CEFServerContentUpdateFailure
LEEFServerContentUpdateFailure
SyslogServerContentUpdateFailure
EmailServerContentUpdateFailure

Server Content Revert A content update was rolled back to an older version.
Success
CEFServerContentRevertSuccess
LEEFServerContentRevertSuccess
SyslogServerContentRevertSuccess
EmailServerContentRevertSuccess

Server Content Revert A content update failed to roll back to an older version.
Failure
CEFServerContentRevertFailure
LEEFServerContentRevertFailure
SyslogServerContentRevertFailure
EmailServerContentRevertFailure

Policies - Rules
The following table displays the policy rule logs you can forward to an external logging platform or email.

234 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event Name Description

Rule Added/Edited An administrator added a new rule or edited an existing rule.

CEFRuleEdited
LEEFRuleEdited
SyslogRuleEdited
EmailRuleEdited

Rule Deleted An administrator deleted a rule.

CEFRuleDeleted
LEEFRuleDeleted
SyslogRuleDeleted
EmailRuleDeleted

Policies - Process Management

The following table displays the process management logs you can forward to an external logging platform
or email.

Event Name Description

Process Added/Edited An administrator added or edited a process.

CEFProcessEdited
LEEFProcessEdited
SyslogProcessEdited
EmailProcessEdited

Process Deleted An administrator added or edited a process.

CEFProcessDeleted
LEEFProcessDeleted
SyslogProcessDeleted
EmailProcessDeleted

Policies - Restriction Settings

The following table displays the restriction settings logs you can forward to an external logging platform or
email.

Event Name Description

Restriction Settings An administrator added or edited a global restriction setting.

Add/Edit
CEFRestrictionSettingsEdited
LEEFRestrictionSettingsEdited
SyslogRestrictionSettingsEdited
EmailRestrictionSettingsEdited

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 235

Policies - Hash Control
The following table displays the hash control logs you can forward to an external logging platform or email.

Event Name Description

Hash Added A hash was added to the ESM Server cache.

CEFNewHash
LEEFNewHash
SyslogNewHash
EmailNewHash

Verdict Changed - Any A hash verdict has changed to malicious.

to Any
CEFVerdictChange
LEEFVerdictChange
SyslogVerdictChange
EmailVerdictChange

Verdict Changed - Any A hash verdict has changed to malicious.

to Malware
CEFVerdictChangeAnyToMalware
LEEFVerdictChangeAnyToMalware
SyslogVerdictChangeAnyToMalware
EmailVerdictChangeAnyToMalware

Verdict Changed - The verdict of a hash has changed from malicious to a new verdict.
Malware to Any
CEFVerdictChangeMalwareToAny
LEEFVerdictChangeMalwareToAny
SyslogVerdictChangeMalwareToAny
EmailVerdictChangeMalwareToAny

Verdict Changed - No The verdict of a hash has changed from no connection to a new verdict.
Connection to Any
CEFVerdictChangeNoConnectionToAny
LEEFVerdictChangeNoConnectionToAny
SyslogVerdictChangeNoConnectionToAny
EmailVerdictChangeNoConnectionToAny

Verdict Changed - The verdict of a hash has changed from unknown to a new verdict.
Unknown to Any
CEFVerdictChangeUnknownToAny
LEEFVerdictChangeUnknownToAny
SyslogVerdictChangeUnknownToAny
EmailVerdictChangeUnknownToAny

Hashes Imported An administrator has imported one or more hashes into the server cache.
CEFHashesImport
LEEFHashesImport
SyslogHashesImport
EmailHashesImport

236 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event Name Description

Verdict Changed - An administrator manually set a verdict for hash.

Manual Override
CEFVerdictManualOverride
LEEFVerdictManualOverride
SyslogVerdictManualOverride
EmailVerdictManualOverride

Monitor - Agent
The following table displays the agent logs you can forward to an external logging platform or email.

Event Name Description

Agent Access Violation An agent reported an access violation.

CEFAccessViolation
LEEFAccessViolation
SyslogAccessViolation
EmailAccessViolation

Agent Heartbeat A heartbeat was received from the agent.

CEFHeartbeat
LEEFHeartbeat
SyslogHeartbeat
EmailHeartbeat

Agent Service Start The agent service was started on the endpoint.
CEFServiceAlive
LEEFServiceAlive
SyslogServiceAlive
EmailServiceAlive

Agent Service Stopped The agent service was stopped on the endpoint.
CEFServiceStopped
LEEFServiceStopped
SyslogServiceStopped
EmailServiceStopped

Agent Shutdown The endpoint was shut down.

CEFSystemShutdown
LEEFSystemShutdown
SyslogSystemShutdown
EmailSystemShutdown

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 237

 Event Name Description

Agent Service Start The agent service failed to start on the endpoint.
Failed
CEFServiceStartFailed
LEEFServiceStartFailed
SyslogServiceStartFailed
EmailServiceStartFailed

Agent Service Warning The agent service reported a warning.

CEFServiceWarning
LEEFServiceWarning
SyslogServiceWarning
EmailServiceWarning

Process Crash A process has crashed on the endpoint.

CEFProcessCrashed
LEEFProcessCrashed
SyslogProcessCrashed
EmailProcessCrashed

Agent Process Injection The agent exceeded the permissible amount of time to inject into a process.
Timeout
CEFProcessInjectionTimedOut
LEEFProcessInjectionTimedOut
SyslogProcessInjectionTimedOut
EmailProcessInjectionTimedOut

Agent Reporting The agent reporting service failed to start.

Service Start Failed
CEFReportingServiceStartFailed
LEEFReportingServiceStartFailed
SyslogReportingServiceStartFailed
EmailReportingServiceStartFailed

Agent File Upload The agent failed to upload a file.

Failed
CEFFileUploadFailure
LEEFFileUploadFailure
SyslogFileUploadFailure
EmailFileUploadFailure

Agent Installed to Traps was installed on an endpoint.

System
CEFClientInstall
LEEFClientInstall
SyslogClientInstall
EmailClientInstall

238 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Name Description

Agent Uninstalled from Traps was uninstalled from an endpoint.

System
CEFClientUninstall
LEEFClientUninstall
SyslogClientUninstall
EmailClientUninstall

Agent Upgraded Traps was upgraded on an endpoint.

CEFClientUpgrade
LEEFClientUpgrade
SyslogClientUpgrade
EmailClientUpgrade

Agent Status Change The agent status has changed.

CEFTrapsServiceStatusChange
LEEFTrapsServiceStatusChange
SyslogTrapsServiceStatusChange
EmailTrapsServiceStatusChange

Agent Policy Change The agent policy has changed.

CEFAgentPolicyChange
LEEFAgentPolicyChange
SyslogAgentPolicyChange
EmailAgentPolicyChange

Local Analysis Feature The file that local analysis tried to examine was corrupt and could not be
Extraction Failed examined using local analysis. When this occurs, Traps identifies the file as
malware until it receives a verdict (either from WildFire or the administrative
hash control policy).
CEFLocalAnalysisFeatureExtractionFailed
LEEFLocalAnalysisFeatureExtractionFailed
SyslogLocalAnalysisFeatureExtractionFailed
EmailLocalAnalysisFeatureExtractionFailed

Local Analysis Model The local analysis model was missing on the endpoint and was therefore
Unavailable disabled.
CEFLocalAnalysisModelUnavailable
LEEFLocalAnalysisModelUnavailable
SyslogLocalAnalysisModelUnavailable
EmailLocalAnalysisModelUnavailable

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 239

 Event Name Description

Local Analysis Module The local analysis model successfully analyzed an unknown executable file
Succeeded and issued a verdict.
CEFLocalAnalysisModuleSucceeded
LEEFLocalAnalysisModuleSucceeded
SyslogLocalAnalysisModuleSucceeded
EmailLocalAnalysisModuleSucceeded

Local Analysis Module The local analysis model failed to analyze an unknown executable file and
Failed issue a verdict.
CEFLocalAnalysisModuleFailed
LEEFLocalAnalysisModuleFailed
SyslogLocalAnalysisModuleFailed
EmailLocalAnalysisModuleFailed

Trusted Signer Changed The local decision of a trusted signer on the agent has changed. This can
be due a change in the local certificate store on the endpoint, a content
update containing changes to the trusted signer list, or a manual update to the
trusted signers list.
CEFPublisherChanged
LEEFPublisherChanged
SyslogPublisherChanged
EmailPublisherChanged

Agent Content Update The agent received a new content update version.
CEFAgentContentUpdate
LEEFAgentContentUpdate
SyslogAgentContentUpdate
EmailAgentContentUpdate

Quarantine Quota The storage quota for quarantined files on the endpoint has been exceeded.
Exceeded
CEFQuarantineQuotaExceeded
LEEFQuarantineQuotaExceeded
SyslogQuarantineQuotaExceeded
EmailQuarantineQuotaExceeded

240 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event Name Description

Agent Registration An agent that has already registered with the ESM Server has tried to re-
Conflict register but lacks valid authentication identification. This could indicate:
A duplicate machine name exists on the network (for Traps agents running
pre-4.0.2 versions). When this occurs, ensure the machine name is unique
or upgrade the agent to Traps 4.0.2 or a later release to ensure the agent
receives a unique ID.
A malicious component is attempting to manipulate the endpoint
protection policy. When this occurs, verify the validity of the agent and, if
needed, remediate the component.
Formats:
CEFRegistrationConflict
LEEFRegistrationConflict
SyslogRegistrationConflict
EmailRegistrationConflict

Monitor ESM
The following table displays the ESM logs you can forward to an external logging platform or email.

Event Name Description

User Login An administrator has logged in to the ESM Console.

CEFUserLogin
LEEFUserLogin
SyslogUserLogin
EmailUserLogin

ESM Heartbeat A heartbeat was received from the ESM Server.

CEFServerHeartbeat
LEEFServerHeartbeat
SyslogServerHeartbeat
EmailServerHeartbeat

ESM Configuration The ESM Server configuration was changed.

Changed
CEFEsmConfigurationChange
LEEFEsmConfigurationChange
SyslogEsmConfigurationChange
EmailEsmConfigurationChange

ESM Status Changed The status of the ESM Server has changed.
CEFEsmStatusChange
LEEFEsmStatusChange
SyslogEsmStatusChange
EmailEsmStatusChange

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 241

 Event Name Description

Tech Support File The status of the ESM tech support file has changed.
Status
CEFTechSupportFileStatus
LEEFTechSupportFileStatus
SyslogTechSupportFileStatus
EmailTechSupportFileStatus

Communication Check A proxy communication event occurred between the ESM components and
with Proxy the proxy server. Proxy communication events can disrupt communication
with WildFire.
CEFCommunicationsCheckWithProxy
LEEFCommunicationsCheckWithProxy
SyslogCommunicationsCheckWithProxy
EmailCommunicationsCheckWithProxy

WildFire The communication status between the ESM Server and WildFire has
Communication Status changed from reachable to unreachable or from unreachable to reachable.
Changed
CEFWfCommunicationsStatusChanged
LEEFWfCommunicationsStatusChanged
SyslogWfCommunicationsStatusChanged
EmailWfCommunicationsStatusChanged

Settings - Administration
The following table displays the administrative logs you can forward to an external logging platform or
email.

Event Name Description

Role Deleted An administrative role was deleted.

CEFRoleDeleted
LEEFRoleDeleted
SyslogRoleDeleted
EmailRoleDeleted

Role Added/Edited An administrative role was added or edited.

CEFRoleEdited
LEEFRoleEdited
SyslogRoleEdited
EmailRoleEdited

Role Status Changed The status of an administrative role was changed.

CEFRoleStatusChanged
LEEFRoleStatusChanged
SyslogRoleStatusChanged
EmailRoleStatusChanged

242 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event Name Description

User Deleted An administrative user was deleted.

CEFUserDeleted
LEEFUserDeleted
SyslogUserDeleted
EmailUserDeleted

User Added/Edited An administrative user was added or deleted.

CEFUserEdited
LEEFUserEdited
SyslogUserEdited
EmailUserEdited

User Status Changed The status of an administrative user was changed.

CEFUserStatusChanged
LEEFUserStatusChanged
SyslogUserStatusChanged
EmailUserStatusChanged

Settings - Agent
The following table displays the agent settings logs you can forward to an external logging platform or
email.

Event Name Description

Agent One Time Action An agent has finished running an action rule on an endpoint.
Completed
CEFOneTimeActionComplete
LEEFOneTimeActionComplete
SyslogOneTimeActionComplete
EmailOneTimeActionComplete

Agent One Time Action An agent failed to run an action rule on an endpoint.
Failed
CEFOneTimeActionFailed
LEEFOneTimeActionFailed
SyslogOneTimeActionFailed
EmailOneTimeActionFailed

File Restore Failed An agent failed to restore a file to its original location on the endpoint or
attached removable media.
CEFRestoreFailed
LEEFRestoreFailed
SyslogRestoreFailed
EmailRestoreFailed

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 243

 Event Name Description

File Quarantine Failed An agent failed to quarantine a file on the endpoint or its attached removable
media.
CEFQuarantineFailed
LEEFQuarantineFailed
SyslogQuarantineFailed
EmailQuarantineFailed

File Restore Succeeded An agent successfully restored a file to its original location on the endpoint or
attached removable media.
CEFRestoreSucceeded
LEEFRestoreSucceeded
SyslogRestoreSucceeded
EmailRestoreSucceeded

File Quarantine An agent successfully quarantined a file on the endpoint or its attached
Succeeded removable media.
CEFQuarantineSucceeded
LEEFQuarantineSucceeded
SyslogQuarantineSucceeded
EmailQuarantineSucceeded

Settings - ESM
The following table displays the ESM settings logs you can forward to an external logging platform or email.

Event Name Description

ESM Items Deleted A security event was removed from the ESM Console.
CEFArchivedPreventions
LEEFArchivedPreventions
SyslogArchivedPreventions
EmailArchivedPreventions

ESM Items Deleted The ESM Console failed to remove a security event.
Failed
CEFArchivedPreventionsFailure
LEEFArchivedPreventionsFailure
SyslogArchivedPreventionsFailure
EmailArchivedPreventionsFailure

Settings Changed The ESM Console settings have changed.

CEFConfigurationChange
LEEFConfigurationChange
SyslogConfigurationChange
EmailConfigurationChange

244 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Settings - Conditions
The following table displays the condition management logs you can forward to an external logging platform
or email.

Event Name Description

Condition Added/ A condition was added or edited.

Edited
CEFConditionEdited
LEEFConditionEdited
SyslogConditionEdited
EmailConditionEdited

Condition Deleted A condition was deleted.

CEFConditionDeleted
LEEFConditionDeleted
SyslogConditionDeleted
EmailConditionDeleted

Settings - Licenses
The following table displays the license management logs you can forward to an external logging platform
or email.

Event Name Description

Agent License The agent failed to validate the license.

Validation Failed
CEFMachineLicenseValidationFailed
LEEFMachineLicenseValidationFailed
SyslogMachineLicenseValidationFailed
EmailMachineLicenseValidationFailed

License Expiration The license expired on the agent.

CEFLicenseExpiration
LEEFLicenseExpiration
SyslogLicenseExpiration
EmailLicenseExpiration

License Quantity The license utilization has reached 80%. Consider purchasing additional
licenses.
CEFLicenseQuantity
LEEFLicenseQuantity
SyslogLicenseQuantity
EmailLicenseQuantity

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 245

 Event Name Description

Agent License Request The agent requested a license.

CEFClientLicenseRequest
LEEFClientLicenseRequest
SyslogClientLicenseRequest
EmailClientLicenseRequest

Agent License Invalid The license on the agent was invalid.

CEFClientLicenseInvalid
LEEFClientLicenseInvalid
SyslogClientLicenseInvalid
EmailClientLicenseInvalid

License Sent to Agent The agent received a new license.

CEFSendingLicenseToClient
LEEFSendingLicenseToClient
SyslogSendingLicenseToClient
EmailSendingLicenseToClient

License Pool Added A new pool of licenses was added to the ESM Console.
CEFLicensePoolAdded
LEEFLicensePoolAdded
SyslogLicensePoolAdded
EmailLicensePoolAdded

Agent License Revoked The license for an agent was revoked.

CEFLicenseRevoked
LEEFLicenseRevoked
SyslogLicenseRevoked
EmailLicenseRevoked

Settings - Installation Package

The following table displays the installation package events you can forward to an external logging platform
or email.

Event Name Description

3rd-Party The agent failed to validate the license.

Incompatibility
CEFIncompatibleOs
LEEFIncompatibleOs
SyslogIncompatibleOs
EmailIncompatibleOs

246 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Name Description

Installation Package The agent failed to validate the license.

CEFInstallationPackage
LEEFInstallationPackage
SyslogInstallationPackage
EmailInstallationPackage

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 247

Common Variables Used in Events
From the ESM Console, you can configure log forwarding for the events that matter to you most. The ESM
translates event information into the format of your choice and sends it to the external logging platform and
optionally to an email address. Included in each event are variables which the ESM replaces with values to
make each event meaningful. Many variables are shared across similar types of events. The following topics
describe some of the most common variables by the type of event:
Agent Change Event Variables on page 248
ESM Configuration Change Event Variables on page 248
Policy Change Event Variables on page 249
ESM Server Event Variables on page 250
Security Event Monitoring Variables on page 250

Agent Change Event Variables

Agent change events occur on the endpoint and include changes to content updates, licenses, software,
connection status, one-time action rules, processes and services, and quarantined files. The ESM Console
lists these events the Monitor - Agent Logging Events category. The following table displays the most
commonly specified variables in agent-related events.

Name Meaning

dhost Machine name of the endpoint

duser User who is logged in to the endpoint

msg Description of the nature of the event

Module Name of the exploit protection module (EPM)

ContentVersion Content update version

ModuleVersion Local analysis module version

For example, consider the output for an Agent Service Start event in CEF format:

Sep 28 2016 17:38:48 172.16.183.173 CEF:0|Palo

Alto Networks|Traps Agent|3.4.1.16709|Traps Service Status Change|Agent|6|
rt=Sep
28 2016 17:38:48 dhost=traps-win7x86 duser=Traps msg=Agent Service
Status Changed: Stopped-> Running

Notice that this event uses several common variables, namely: dhost, duser, and msg.

ESM Configuration Change Event Variables

ESM configuration change events include system-wide changes to licensing, administrative users and roles,
processes, restriction settings, and conditions. The ESM Console lists these events under the following
Logging Events categories:

248 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Policies - Process Management
Policies - Restriction Settings
Settings - Administration
Settings Conditions
The following table displays the most commonly specified variables in ESM configuration-related events.

Name Meaning

shost Machine name of the ESM Console server

suser User who is logged in to the ESM Console

msg Free text description

dhost Machine name of the endpoint

deviceProcessName Process name

For example, consider the output for a Role Added/Edited event in CEF format:

Sep 28 2016 17:42:04 ESM CEF:0|Palo Alto Networks|Traps ESM|3.4.1.16709|Role

Edited|Config|3|rt=Sep 28 2016 17:42:04 shost=ESM suser=administrator
msg=Role TechWriter was added\changed

Notice that this event uses several common variables, namely: shost, suser, and msg.

Policy Change Event Variables

Policy change events include changes to rules, protection levels, content updates, and verdicts. The ESM
Console lists these events under the following Logging Events categories:
Policies - General
Policies - Rules
Policies - Hash Control
The following table displays the most commonly specified variables in policy change events.

Name Meaning

shost Machine name of the ESM Console server

suser User who is logged in to the ESM Console

fileHash Hash value of an executable file

msg Free text description

For example, consider the output of a Hash Added event in CEF format:

Sep 28 2016 17:34:56 172.16.183.173 CEF:0|Palo

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 249

 Alto Networks|Traps ESM|3.4.1.16709|New Hash Added|Policy|6|rt=Sep
28 2016 17:34:56 shost=ESM suser=
fileHash=c97f276b4c70682c8f8d39b91e30f938bc6e86a42cd6b71e3ad08092dba528e9
cs5Label=NewVerdict
cs5=Benign msg=New hash added

Notice that this event uses several common variables, namely: shost, suser, fileHash, and msg.

ESM Server Event Variables

ESM Server events include changes related to preventions, configuration changes, ESM status, licenses,
ESM Tech Support files, communication with WildFire. The ESM Console lists these events under the
following logging categories:
Settings - ESM
Settings - Licenses
Monitor - ESM
The following table displays the most commonly specified variables in ESM Server-related events.

Name Meaning

shost Machine name of the ESM Console server

suser User who is logged in to the ESM Console

dhost Machine name of the endpoint

msg Free text description message

duser User who is logged in to the endpoint

FileName Executable filename

For example, consider the following output for a Communication Check With Proxy event in CEF format:

Sep 28 2016 17:34:50 172.16.183.173 CEF:0|Palo

Alto Networks|Traps ESM|3.4.1.16709|Communications Check With Proxy|System|9|
rt=Sep
28 2016 17:34:50 shost=ESM suser= dhost=ESM msg=Communications check
with Proxy on host 'ESM'. Status: 'WildFire communication succeeded,
proxy is disabled.'

Notice that this event uses several common variables, namely: shost, dhost, and msg.

Security Event Monitoring Variables

Security events include all prevention, notification, and provisional events that are reported by the Traps
agents. The ESM Console lists these events under the Security Events Logging Events category. The
following table displays the most commonly specified variables used for monitoring security events.

250 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Name Meaning

dhost Machine name of the endpoint

duser User that was logged onto the endpoint.

Model Name of the exploit protection module (EPM)

deviceProcessName Process name

File Hash Hash value of an executable file

dvc/dst IP address of the endpoint

msg Free text description

Content Version Content version

For example, consider the output of a Prevention Event in CEF format:

Aug 25 2016 12:52:45 10.200.0.216 CEF:0|Palo Alto

Networks|Traps Agent|3.4.1.15591|Prevention Event|Threat|9|rt=Aug
25 2016 12:52:45 dhost=tmpltwe7stan duser=TMPLTWE7STAN\User cs2Label=Module
cs2=DEP deviceProcessName=firefox.exe
fileHash=CD3CF48E727B5904A211F9366A67695702893316C7A039554496E99D98173D3C
cs3Label=ContentVersion
cs3=5-353 dvc=10.200.0.30 msg=New prevention event. Prevention Key:
f24ba02f-bf08-4713-be00-f03bfc1f4034

Notice that this event uses several common variables, namely: dhost, duser, deviceProcessName,
fileHash, dvc, and msg.

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 251

Forward Logs to an External Logging Platform
Syslog is a standard log transport mechanism that enables the aggregation of log data from different
network devices and vendors into a central repository for archive, analysis, and reporting. Depending on the
type and severity of the data in the log files, you may want to receive alerts for critical events that require
your attention, or you may have policies that require you to archive the data for longer than it can be stored
on the ESM Console. In these cases, you can configure the ESM to forward your log data to an external
service for archive, notification, analysis, or any combination of the three.
Enable Log Forwarding to an External Logging Platform on page 252
Enable Log Forwarding to an External Logging Platform Using the DB Configuration Tool on page 253
CEF Format on page 254
LEEF Format on page 267
Syslog (RFC5424) Format on page 281

Enable Log Forwarding to an External Logging Platform

The ESM Console and ESM Servers collectively generate logs for over 60 types of eventsincluding
security events, policy configuration changes, and monitoring events (agent and server)that can be
forwarded to an external logging platform. By enabling log forwarding the ESM can forward all or some of
these logs to an external service for long-term storage and analysis.
The ESM component which forwards the logs varies depending on the type of event. For example, if you
monitor verdict changes, the ESM Console sends logs when you override the verdict for a hash. If WildFire
changes the verdict, the ESM Server sends the logs.
To send logs, use TCP or SSL for reliable and secure transport of logs, or UDP for non-secure transport. You
can also customize the information format (CEF, LEEF, or Syslog) that the ESM uses to send the logs.

The date/time of the each logged event is in UTC.

STEP 1 | Enable log forwarding.

From the ESM Console, select Settings > ESM > Syslog, and then Enable Syslog.

STEP 2 | Configure the settings to send logs from ESM components to an external logging platform. To
send logs to an email, see Forward Logs to Email on page 299.
Configure the following settings:
Syslog ServerHostname or IP address of the external logging platform.
Syslog PortCommunication port of the external logging platform, such as 514.
Syslog ProtocolThe format the ESM uses to send reports: CEF, LEEF, or Syslog.
Keep-alive TimeoutPeriod (in minutes) in which Traps sends a keep-alive message to the external
logging platform (default is 0; range is 0 to 2,147,483,647). A value of 0 specifies that you do not
want to send a keep-alive message to the external logging platform.
Communication ProtocolTransport layer protocol that the ESM uses to send syslog reports: TCP,
TCP with SSL, or UDP.

STEP 3 | Select the events that you want to send to the external logging platform.
In the Logging Events area, select one or more of the events. Scroll through the list to see additional
types of events you can send.

252 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

STEP 4 | Save your settings.
Click Save.

STEP 5 | Verify the configuration of your settings.

Click Check Connectivity. The ESM Console sends a test communication to the external logging
platform using the settings you configured. If you do not receive the test message, confirm that your
settings are correct and then try again.

Enable Log Forwarding to an External Logging Platform Using the

DB Configuration Tool
The Endpoint Security Manager can write logs to an external logging platform, such as security information
and event management (SIEM), Service Organization Controls (SOCs), or syslog, in addition to storing its
logs internally. Specifying an external logging platform allows you to view aggregated logs from all ESM
Servers. You can enable external reporting using the Endpoint Security Manager (see Forward Logs to an
External Logging Platform) or using the Database (DB) Configuration Tool.
The DB Configuration Tool is a command-line interface that provides an alternative to managing basic
server settings using the ESM Console. You can access the DB Configuration Tool using a Microsoft MS-
DOS command prompt run as an administrator. The DB Configuration Tool is located in the Server folder on
the ESM Server.

All commands run using the DB Configuration Tool are case sensitive.

By default, log forwarding is disabled.

STEP 1 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd
C:\Program Files\Palo Alto Networks\Endpoint Security Manager\Server

STEP 3 | (Optional) View the existing reporting settings:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server>dbconfig reporting show
EnableSyslog = False
SyslogServer =
SyslogPort = 0
SyslogProtocol = Cef
KeepAliveTimeout = 0
MaximumReportsCount = 500000
MinReportsCount = 450000
SyslogCommunicationType = Udp

STEP 4 | Enable log forwarding to an external logging platform such as a syslog server:

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 253

 C:\Program Files\Palo Alto Networks\Endpoint Security Manager
\Server> dbconfig reporting EnableSyslog true

STEP 5 | Specify the IP address (or hostname) of the external logging platform:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig reporting SyslogServer <ipaddress>

STEP 6 | Specify the communication port for the external logging platform, a value between 1 and
65535 (default is 514):

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig reporting SyslogPort <portnumber>

STEP 7 | Specify the protocol that the ESM Console will use to send reports, either Cef, Leef, or
Rfc5424 (syslog).

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig reporting SyslogProtocol [Cef | Leef | Rfc5424]

STEP 8 | (Optional) Specify a timespan (in minutes) where the endpoint sends a keep alive message to
the log or report, a value of 0 or greater (default is 0):

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig reporting KeepAliveTimeout <value>

STEP 9 | (Optional) Specify the maximum number of report notifications to store in the database, a value
of 0 or greater (default is 4000):

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig reporting MaximumReportsCount <value>

For example, specifying a maximum report count of 5000 notifications means the Endpoint Security
Manager will discard older notifications higher than 5000.

STEP 10 | (Optional) Specify the minimum number of report notifications to store in the database, a value
of 0 or greater (default is 5000):

C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server> dbconfig reporting
MinReportsCount <value>

CEF Format
The following table lists the events in CEF format.

254 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

AccessViolation @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Access Violation|Threat|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] cs2Label=Module
cs2=@Model["EPM"] dvc=@Model["AgentIp"]
msg=Access Violation- @Model["TargetName"]:
@Model["TargetValue"]

AgentContentUpdate @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Content Update|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=@Model["host"] received
new content- version @Model["ContentVersion"]

AgentPolicyChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Policy Changed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Policy changed

ArchivedPreventions @Model["Time"] @Model["EsmIp"]

CEF:0|Palo Alto Networks|Traps ESM|
@Model["ProductVersion"]|Preventions Archived|
System|@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=@Model["totalPreventions"]
preventions been archived

ArchivedPreventionsFailure @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Preventions Archived Failed|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Archived preventions
failed

ClientInstall @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Install|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent installed

ClientLicenseInvalid @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Client License Invalid|
Agent|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
msg=Invalid license

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 255

 Event CEF Format

ClientLicenseRequest @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Client License Request|
Agent|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=New
license request

ClientUninstall @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Uninstall|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent uninstalled

ClientUpgrade @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Upgrade|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent upgraded

CommunicationsCheckWithProxy @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Communications Check With Proxy|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Communications check
with Proxy on host '@Model["host"]'. Status:
'@Model["message"]'

ConditionDeleted @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Condition Deleted|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=Condition ID: @Model["id"] was deleted

ConditionEdited @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Condition Edited|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Condition ID: @Model["id"]
was added/changed.

ConfigurationChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Settings Change|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=@Model["Property"] has changed from
@Model["OldValue"] to @Model["NewValue"].

256 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

DisabledProtection @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Protection Disabled|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Protection disabled on all
agents

EnabledProtection @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Endpoint Disconnected|
Agent|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=Agent
disconnected. last HB @Model["lastHBTime"]

EndpointDisconnected @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
EPM Init Failed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] cs2Label=Module
cs2=@Model["EPM"] msg=EPM @Model["EPM"] failed to
initialize

EsmConfigurationChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
ESM Configuration Change|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Multi ESM configurations
has changed

EsmStatusChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|ESM
Status Change|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=ESM
status changed

FileUploadFailure @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|File
Upload Failure|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
duser=@Model["user"] fname=@Model["fileName"]
msg=File failed to upload

HashesImport @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Hashes Import|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
msg=@Model["Amount"] hashes were imported

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 257

 Event CEF Format

Heartbeat @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Heartbeat|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Service is alive

IncompatibleOs @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Agent Incompatibility Issue|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=Traps
is inactive due to @Model["IncompatibilityReason"]

InstallationPackage @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|Agent
Package Created|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=@Model["OSType"] Agent Package was
@Model["AgentPackageStatus"]. Package name:
@Model["AgentPackageName"] Agent Version:
@Model["AgentPackageVersion"]

LicenseExpiration @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
License Expiration|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
duser=@Model["user"] msg=@Model["poolName"]
licenses will expire in @Model["days"] days

LicensePoolAdded @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
License Pool Added|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=A
pool of @Model["licenseCount"] licenses of type
@Model["licenseType"] have been added

LicenseQuantity @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
License Quantity|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=Agent
Licenses are running low

LicenseRevoked @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
License Revoked|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=Licenses revoked

258 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

LocalAnalysisFeatureExtractionFailed
@Model["Time"] @Model["EsmIp"] CEF:0|
Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Local Analysis
Extraction Failed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] cs3Label=ContentVersion
cs3=@Model["ContentVersion"] msg=Local Analysis
Feature Extraction Failed

LocalAnalysisModelUnavailable @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Local Analysis Model Unavailable|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Local Analysis Model
Unavailable

LocalAnalysisModuleFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Local Analysis Module Failed|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=Add
new module into Local Analysis- Failed

LocalAnalysisModuleSucceeded @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Local Analysis Module Succeeded|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
cs4Label=ModuleVersion cs4=@Model["ModuleVersion"]
msg=Add new module into Local Analysis- Succeeded

MachineLicenseValidationFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Machine License Validation Failed|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=License Validation Failed

NewHash @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
New Hash Added|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
cs5Label=NewVerdict cs5=@Model["NewVerdict"]
msg=New hash added

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 259

 Event CEF Format

NotificationEvent @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Notification Event|
Threat|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
cs2Label=Module cs2=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"] cs3Label=ContentVersion
cs3=@Model["ContentVersion"] dvc=@Model["AgentIp"]
msg=New notification event. Prevention Key:
@Model["preventionKey"]

OneTimeActionComplete @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|One
Time Action Complete|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=One Time Action completed.
Action Type: @Model["ActionType"]. Action ID:
@Model["ActionID"]

OneTimeActionFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|One
Time Action Failed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=One Time Action failed to
run. Action Type: @Model["ActionType"]

PostDetectionEvent @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Post Detection Event|
Threat|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
cs2Label=Module cs2=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"] cs3Label=ContentVersion
cs3=@Model["ContentVersion"] dvc=@Model["AgentIp"]
msg=New post detection event. Prevention Key:
@Model["preventionKey"]

PreventionEvent @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Prevention Event|
Threat|@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
cs2Label=Module cs2=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"] cs3Label=ContentVersion
cs3=@Model["ContentVersion"] dvc=@Model["AgentIp"]
msg=New prevention event. Prevention Key:
@Model["preventionKey"]

260 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

ProcessCrashed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Process Crashed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Process
@Model["ProcessName"] had crashed

ProcessDeleted @Model["Time"] @Model["EsmIp"]

CEF:0|Palo Alto Networks|Traps ESM|
@Model["ProductVersion"]|Process Deleted|Config|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
deviceProcessName=@Model["Name"] msg=Process was
deleted

ProcessEdited @Model["Time"] @Model["EsmIp"]

CEF:0|Palo Alto Networks|Traps ESM|
@Model["ProductVersion"]|Process Edited|Config|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
[email protected]
msg=Process was added/edited

ProcessInjectionTimedOut @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Process Injection Time Out|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
msg=Injection Timeout

PublisherChanged @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|Trusted
Signer Changed|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
msg=Hash @Model["Hash"] trusted signer changed
automatically from @Model["OldPublisher"] to
@Model["NewPublisher"]

QuarantineFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Quarantine Failed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=File @Model["fileName"]
could not be quarantined, reason:
@Model["FailureReason"]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 261

 Event CEF Format

QuarantineQuotaExceeded @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Quarantine Quota Exceeded |Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=File
@Model["fileName"] was permanently removed from the
quarantine folder because quota was exceeded

QuarantineSucceeded @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Quarantine Succeed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=File @Model["fileName"]
was quarantined successfully

RegistrationConflict @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Agent Registration Conflict Detected|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Agent registration
conflict detected on host @Model["host"] from IP:
@Model["RequestIP"]. Saved IP: @Model["AgentIp"]

ReportingServiceStartFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Reporting Service Start Failed|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"]
msg=ReportingService start failed.

RestoreFailed @Model["Time"] @Model["EsmIp"] CEF:0|

Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Restore Failed|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=File
@Model["fileName"] could not be restored, reason:
@Model["FailureReason"]

RestoreSucceeded @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Restore Succeeded|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=File @Model["fileName"]
restored successfully

RestrictionSettingsEdited @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Restriction Settings Edited|Config|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Restriction Settings were added/changed

262 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

RoleDeleted @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Role Deleted|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Role @Model["Name"] was
deleted

RoleEdited @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Role Edited|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Role @Model.Data.Name was
added\changed

RoleStatusChanged @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|Role
Status Changed|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Role @Model["Name"] status
was changed to @Model["Status"]

RuleDeleted @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Rule Deleted|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] cs1Label=Rule cs1=@Model["id"]
msg=Rule @Model["id"]: Deleted

RuleEdited @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Rule Edited|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] cs1Label=Rule
[email protected] msg=Rule @Model.Data.Id: Edited

SendingLicenseToClient @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|Sending
License To Client|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=New
license sent

ServerContentRevertFailure @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Server Content Revert Failure|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version failed to revert to
@Model["ContentVersion"]. Error: @Model["Error"]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 263

 Event CEF Format

ServerContentRevertSuccess @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Server Content Revert Success|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version was reverted to
@Model["ContentVersion"] successfully

ServerContentUpdateFailure @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Server Content Update Failed|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version failed to update to
@Model["ContentVersion"]. Error: @Model["Error"]

ServerContentUpdateSuccess @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Server Content Update Success|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version was updated to
@Model["ContentVersion"] successfully

ServerHeartbeat @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
ESM Heartbeat|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=ESM
heartbeat

ServiceAlive @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Service Alive|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Service start

ServiceStartFailed @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Service Start Failed|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Service start failed

ServiceStopped @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Service Stopped|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Service stopped

264 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event CEF Format

ServiceWarning @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Service Warning|Threat|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] cs2Label=Module
cs2=@Model["EPM"]dvc=@Model["AgentIp"] msg=Warning-
Java sandboxed file access to @Model["TargetValue"]

SystemShutdown @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
System Shutdown|Agent|@Model.ExternalSeverity|
rt=@Model["Time"] dhost=@Model["host"]
duser=@Model["user"] msg=Service shutdown

TechSupportFileStatus @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Tech Support File|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"] msg=Tech
Support File: Status:@Model["Status"]

TrapsServiceStatusChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps Agent|@Model["ProductVersion"]|
Traps Service Status Change|Agent|
@Model.ExternalSeverity|rt=@Model["Time"]
dhost=@Model["host"] duser=@Model["user"] msg=Agent
Service Status Changed: @Model["OldStatus"]->
@Model["NewStatus"]

UserDeleted @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
User Deleted|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model["Name"] was
deleted.

UserEdited @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
User Edited|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model.Data.Name was
added\changed.

UserLogin @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
User Login|System|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model.Data.Username
logged in to ESM console

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 265

 Event CEF Format

UserStatusChanged @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|User
Status Changed|Config|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model["Name"] status
was changed to @Model["Status"]

VerdictChange @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Verdict Changed|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
cs5Label=NewVerdict cs5=@Model["NewVerdict"]
msg=Hash verdict changed. @Model["OldVerdict"] ->
@Model["NewVerdict"]

VerdictChangeAnyToMalware @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Verdict Changed Any To Malware|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
fileHash=@Model["Hash"] cs5Label=NewVerdict
cs5=@Model["NewVerdict"] msg=Hash verdict
changed to Malware. @Model["OldVerdict"] ->
@Model["NewVerdict"]

VerdictChangeMalwareToAny @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Verdict Change Malware To Any|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
fileHash=@Model["Hash"] cs5Label=NewVerdict
cs5=@Model["NewVerdict"] msg=Hash verdict
changed from Malware. Awaiting to restore:
@Model["QuarantineStatus"]. @Model["OldVerdict"] ->
@Model["NewVerdict"]

VerdictChangeNoConnectionToAny
@Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto
Networks|Traps ESM|@Model["ProductVersion"]|
Verdict Change No Connection To Any|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
fileHash=@Model["Hash"] cs5Label=NewVerdict
cs5=@Model["NewVerdict"] msg=Hash verdict changed
from No Connection. @Model["OldVerdict"] ->
@Model["NewVerdict"]

266 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event CEF Format

VerdictChangeUnknownToAny @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
Verdict Change Unknown To Any|Policy|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
fileHash=@Model["Hash"] cs5Label=NewVerdict
cs5=@Model["NewVerdict"] msg=Hash verdict
changed from Unknown. @Model["OldVerdict"] ->
@Model["NewVerdict"]

VerdictManualOverride @Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|Verdict
Manual Override|Policy|@Model.ExternalSeverity|
rt=@Model["Time"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
cs5Label=NewVerdict cs5=@Model["NewVerdict"]
msg=Hash verdict overridden manually.
@Model["OldVerdict"] -> @Model["NewVerdict"]

WfCommunicationsStatusChanged@Model["Time"] @Model["EsmIp"] CEF:0|Palo Alto

Networks|Traps ESM|@Model["ProductVersion"]|
WildFire Communications Status Changed|System|
@Model.ExternalSeverity|rt=@Model["Time"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=WildFire communications
status changed on host '@Model["host"]'. Status:
'@Model["message"]

LEEF Format
The following table lists the events in LEEF format.

Event LEEF Format

AccessViolation LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Access Violation|
cat=Threat subtype=Access Violation
devTime=@model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
Module=@Model["EPM"] dst=@Model["AgentIp"]
msg=Access Violation- @Model["TargetName"]:
@Model["TargetValue"] [email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 267

 Event LEEF Format

AgentContentUpdate LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Content Update|
cat=Agent subtype=Agent Content Update
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=@Model["host"] received new content-
version @Model["ContentVersion"]
[email protected]

AgentPolicyChange LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Policy Changed|
cat=Agent subtype=Agent Policy Changed
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=Policy changed [email protected]

ArchivedPreventions LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Preventions
Archived|cat=System subtype=Preventions
Archived devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=@Model["totalPreventions"] preventions been
archived [email protected]

ArchivedPreventionsFailure LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Preventions Archived
Failed|cat=System subtype=Preventions Archived
Failed devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Archived preventions
failed [email protected]

ClientInstall LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Install|cat=Agent
subtype=Agent Install devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent installed
[email protected]

ClientLicenseInvalid LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Client License Invalid|
cat=Agent subtype=Client License Invalid
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=Invalid license [email protected]

268 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

ClientLicenseRequest LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Client License Request|
cat=Agent subtype=Client License Request
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=New
license request [email protected]

ClientUninstall LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Uninstall|cat=Agent
subtype=Agent Uninstall devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent uninstalled
[email protected]

ClientUpgrade LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Upgrade|cat=Agent
subtype=Agent Upgrade devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Agent upgraded
[email protected]

CommunicationsCheckWithProxy LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Communications Check With
Proxy|cat=System subtype=Communications Check With
Proxy devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Communications check
with Proxy on host '@Model["host"]'. Status:
'@Model["message"] '[email protected]

ConditionDeleted LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Condition Deleted|
cat=Config subtype=Condition Deleted
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Condition ID: @Model["id"]
was deleted [email protected]

ConditionEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Condition Edited|
cat=Config subtype=Condition Edited
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Condition ID: @Model["id"] was added/changed.
[email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 269

 Event LEEF Format

ConfigurationChange LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Settings Change|cat=Config
subtype=Settings Change devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=@Model["Property"] has changed from
@Model["OldValue"] to @Model["NewValue"].
[email protected]

DisabledProtection LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Protection Disabled|
cat=Policy subtype=Protection Disabled
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Protection disabled on all agents
[email protected]

EnabledProtection LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Endpoint Disconnected|
cat=Agent subtype=Endpoint Disconnected
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=Agent
disconnected. last HB @Model["lastHBTime"]
[email protected]

EsmConfigurationChange LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|ESM Configuration Change|
cat=System subtype=ESM Configuration Change
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Multi ESM configurations
has changed [email protected]

EsmStatusChange LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|ESM Status Change|
cat=System subtype=ESM Status Change
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=ESM status changed
[email protected]

FileUploadFailure LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|File Upload Failure|
cat=System subtype=File Upload Failure
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] duser=@Model["user"]
fname=@Model["fileName"] msg=File failed to upload
[email protected]

270 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

HashesImport LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Hashes Import|cat=Policy
subtype=Hashes Import devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
msg=@Model["Amount"] hashes were imported
[email protected]

Heartbeat LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Heartbeat|cat=Agent
subtype=Heartbeat devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Service is alive
[email protected]

IncompatibleOs LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Agent Authentication
Failed|cat=Agent subtype=Agent Incompatibility
Issue devTimeFormat=MMM dd yyyy HH:mm:ss
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=Traps
is inactive due to @Model["IncompatibilityReason"]
[email protected]

InstallationPackage LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Agent Package
Created|cat=System subtype=Agent Package
Created devTimeFormat=MMM dd yyyy HH:mm:ss
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=@Model["OSType"]
Agent Package was @Model["AgentPackageStatus"].
Package name: @Model["AgentPackageName"]
Agent Version: @Model["AgentPackageVersion"]
[email protected]

LicenseExpiration LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|License Expiration|
cat=System subtype=License Expiration
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] duser=@Model["user"]
msg=@Model["poolName"] licenses will expire in
@Model["days"] days [email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 271

 Event LEEF Format

LicensePoolAdded LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|License Pool Added|
cat=System subtype=License Pool Added
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=A pool of
@Model["licenseCount"] licenses of type
@Model["licenseType"] have been added
[email protected]

LicenseQuantity LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|License Quantity|
cat=System subtype=License Quantity
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=Agent Licenses are running
low [email protected]

LicenseRevoked LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|License Revoked|cat=Config
subtype=License Revoked devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=Licenses revoked [email protected]

LocalAnalysisFeatureExtractionFailed
LEEF:1.0|Palo Alto Networks|Traps Agent|
@Model["ProductVersion"]|Local Analysis Extraction
Failed|cat=Agent subtype=Local Analysis Extraction
Failed devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
ContentVersion=@Model["ContentVersion"]
msg=Local Analysis Feature Extraction Failed
[email protected]

LocalAnalysisModelUnavailable LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Local Analysis Model
Unavailable|cat=System subtype=Local Analysis
Model Unavailable devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=Local Analysis Model Unavailable
[email protected]

LocalAnalysisModuleFailed LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Local Analysis Module
Failed|cat=Agent subtype=Local Analysis Module
Failed devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=Add new module into Local Analysis- Failed
[email protected]

272 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

LocalAnalysisModuleSucceeded LEEF:1.0|Palo Alto Networks|Traps

Agent|@Model["ProductVersion"]|Local
Analysis Module Succeeded|cat=Agent
subtype=Local Analysis Module Succeeded
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
ModuleVersion=@Model["ModuleVersion"] msg=Add
new module into Local Analysis- Succeeded
[email protected]

MachineLicenseValidationFailed LEEF:1.0|Palo Alto Networks|Traps

ESM|@Model["ProductVersion"]|Machine
License Validation Failed|cat=System
subtype=Machine License Validation Failed
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=License Validation Failed
[email protected]

NewHash LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|New Hash Added|cat=Policy
subtype=New Hash Added devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=New hash added
[email protected]

NotificationEvent LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Notification
Event|cat=Threat subtype=Notification
Event devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] Module=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"]
ContentVersion=@Model["ContentVersion"]
dst=@Model["AgentIp"] msg=New notification
event. Prevention Key: @Model["preventionKey"]
[email protected]

OneTimeActionComplete LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|One Time Action
Complete|cat=Agent subtype=One Time
Action Complete devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=One Time Action
completed. Action Type=@Model["ActionType"]. Action
ID=@Model["ActionID"] [email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 273

 Event LEEF Format

OneTimeActionFailed LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|One Time
Action Failed|cat=Agent subtype=One Time
Action Failed devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=One Time Action
failed to run. Action Type=@Model["ActionType"]
[email protected]

PostDetectionEvent LEEF:1.0|Palo Alto Networks|Traps

Agent|@Model["ProductVersion"]|Post
Detection Event|cat=Threat subtype=Post
Detection Event devTimeFormat=MMM dd
yyyy HH:mm:ss devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] Module=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"] dst=@Model["AgentIp"]
msg=New post detection event.
Prevention Key: @Model["preventionKey"]
ContentVersion=@Model["ContentVersion"]
[email protected]

PreventionEvent LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Prevention
Event|cat=Threat subtype=Prevention
Event devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] Module=@Model["EPM"]
deviceProcessName=@Model["ProcessName"]
fileHash=@Model["Hash"] dst=@Model["AgentIp"]
msg=New prevention event. Prevention
Key: @Model["preventionKey"]
ContentVersion=@Model["ContentVersion"]
[email protected]

ProcessCrashed LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Process Crashed|
cat=Agent subtype=Process Crashed
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=Process @Model["ProcessName"] had crashed
[email protected]

ProcessDeleted LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Process Deleted|
cat=Config subtype=Process Deleted
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
deviceProcessName=@Model["Name"] msg=Process was
deleted [email protected]

274 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

ProcessEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Process Edited|
cat=Config subtype=Process Edited
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
[email protected]
msg=Process was added/edited
[email protected]

ProcessInjectionTimedOut LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Process Injection Time
Out|cat=Agent subtype=Process Injection Time
Out devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=Injection Timeout [email protected]

PublisherChanged LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Trusted Signer Changed|
cat=Policy subtype=Trusted Signer Changed
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
fileHash=@Model["Hash"] msg=Hash @Model["Hash"]
trusted signer changed automatically from
@Model["OldPublisher"] to @Model["NewPublisher"]
[email protected]

QuarantineFailed LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Quarantine Failed|
cat=Agent subtype=Quarantine Failed
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=File @Model["fileName"] could not be
quarantined, reason: @Model["FailureReason"]
[email protected]

QuarantineQuotaExceeded LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Quarantine Quota
Exceeded|cat=Agent subtype=Quarantine Quota
Exceeded devTimeFormat=MMM dd yyyy HH:mm:ss
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=File
@Model["fileName"] was permanently removed from
the quarantine folder because quota was exceeded
[email protected]

QuarantineSucceeded LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Quarantine Succeed|
cat=Agent subtype=Quarantine Succeed
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=File
@Model["fileName"] was quarantined successfully
[email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 275

 Event LEEF Format

RegistrationConflict LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Agent Registration
Conflict Detected|cat=System subtype=Agent
Registration Conflict Detected devTimeFormat=MMM
dd yyyy HH:mm:ss devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"]
msg=Agent registration conflict detected on host
@Model["host"] from IP: @Model["RequestIP"]. Saved
IP: @Model["AgentIp"] [email protected]

ReportingServiceStartFailed LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Reporting Service
Start Failed|cat=Agent subtype=Reporting
Service Start Failed devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=ReportingService start
failed. [email protected]

RestoreFailed LEEF:1.0|Palo Alto Networks|Traps

Agent|@Model["ProductVersion"]|Restore
Failed|cat=Agent subtype=Restore Failed
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=File
@Model["fileName"] could not be restored, reason:
@Model["FailureReason"] [email protected]

RestoreSucceeded LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Restore Succeeded|
cat=Agent subtype=Restore Succeeded
devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"]
msg=File @Model["fileName"] restored successfully
[email protected]

RestrictionSettingsEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Restriction Settings
Edited|cat=Config subtype=Restriction Settings
Edited devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Restriction Settings were added/changed
[email protected]

RoleDeleted LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Role Deleted|cat=Config
subtype=Role Deleted devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Role @Model["Name"] was
deleted [email protected]

276 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

RoleEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Role Edited|cat=Config
subtype=Role Edited devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Role @Model.Data.Name was
added\changed [email protected]

RoleStatusChanged LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Role Status Changed|
cat=Config subtype=Role Status Changed
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Role @Model["Name"] status was changed to
@Model["Status"] [email protected]

RuleDeleted LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Rule Deleted|cat=Policy
subtype=Rule Deleted devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] rule=@Model["id"] msg=Rule
@Model["id"]: Deleted [email protected]

RuleEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Rule Edited|cat=Policy
subtype=Rule Edited devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] [email protected] msg=Rule
@Model.Data.Id: Edited [email protected]

SendingLicenseToClient LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Sending License To
Client|cat=Config subtype=Sending License To
Client devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=New license sent
[email protected]

ServerContentRevertFailure LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Server Content Revert
Failure|cat=Policy subtype=Server Content Revert
Failure devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version failed to revert to
@Model["ContentVersion"]. Error: @Model["Error"]
[email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 277

 Event LEEF Format

ServerContentRevertSuccess LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Server Content
Revert Success|cat=Policy subtype=Server
Content Revert Success devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Content version was
reverted to @Model["ContentVersion"] successfully
[email protected]

ServerContentUpdateFailure LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Server Content Update
Failed|cat=Policy subtype=Server Content Update
Failed devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=Content version failed to update to
@Model["ContentVersion"]. Error: @Model["Error"]
[email protected]

ServerContentUpdateSuccess LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Server Content
Update Success|cat=Policy subtype=Server
Content Update Success devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=Content version was
updated to @Model["ContentVersion"] successfully
[email protected]

ServerHeartbeat LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|ESM Heartbeat|cat=System
subtype=ESM Heartbeat devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] dhost=@Model["host"] msg=ESM
heartbeat [email protected]

ServiceAlive LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Service Alive|cat=Agent
subtype=Service Alive devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Service start
[email protected]

ServiceStartFailed LEEF:1.0|Palo Alto Networks|Traps

Agent|@Model["ProductVersion"]|Service
Start Failed|cat=Agent subtype=Service
Start Failed devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Service start failed
[email protected]

278 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event LEEF Format

ServiceStopped LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Service Stopped|cat=Agent
subtype=Service Stopped devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Service stopped
[email protected]

ServiceWarning LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Service Warning|cat=Threat
subtype=Service Warning devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] Module=@Model["EPM"]
dst=@Model["AgentIp"] msg=Warning- Java
sandboxed file access to @Model["TargetValue"]
[email protected]

SystemShutdown LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|System Shutdown|cat=Agent
subtype=System Shutdown devTime=@Model["Time"]
src=@Model["EsmIp"] dhost=@Model["host"]
duser=@Model["user"] msg=Service shutdown
[email protected]

TechSupportFileStatus LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Tech Support
File|cat=System subtype=Tech Support File
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] msg=Tech Support File:
Status:@Model["Status"] [email protected]

TrapsServiceStatusChange LEEF:1.0|Palo Alto Networks|Traps Agent|

@Model["ProductVersion"]|Traps Service Status
Change|cat=Agent subtype=Traps Service Status
Change devTime=@Model["Time"] src=@Model["EsmIp"]
dhost=@Model["host"] duser=@Model["user"] msg=Agent
Service Status Changed: @Model["OldStatus"]->
@Model["NewStatus"] [email protected]

UserDeleted LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|User Deleted|cat=Config
subtype=User Deleted devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model["Name"] was
deleted. [email protected]

UserEdited LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|User Edited|cat=Config
subtype=User Edited devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] msg=User @Model.Data.Name was
added\changed. [email protected]

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 279

 Event LEEF Format

UserLogin LEEF:1.0|Palo Alto Networks|Traps

ESM|@Model["ProductVersion"]|User
Login|cat=System subtype=User Login
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=User @Model.Data.Username logged in to ESM
console [email protected]

UserStatusChanged LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|User Status Changed|
cat=Config subtype=User Status Changed
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
msg=User @Model["Name"] status was changed to
@Model["Status"] [email protected]

VerdictChange LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Verdict Changed|cat=Policy
subtype=Verdict Changed devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash
verdict changed. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

VerdictChangeAnyToMalware LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Verdict Changed
Any To Malware|cat=Policy subtype=Verdict
Changed Any To Malware devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash verdict
changed to Malware. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

VerdictChangeMalwareToAny LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Verdict Change
Malware To Any|cat=Policy subtype=Verdict
Change Malware To Any devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash verdict
changed from Malware. Awaiting to restore:
@Model["QuarantineStatus"]. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

280 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 Event LEEF Format

VerdictChangeNoConnectionToAny
LEEF:1.0|Palo Alto Networks|Traps ESM|
@Model["ProductVersion"]|Verdict Change No
Connection To Any|cat=Policy subtype=Verdict
Change No Connection To Any devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash verdict
changed from No Connection. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

VerdictChangeUnknownToAny LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Verdict Change
Unknown To Any|cat=Policy subtype=Verdict
Change Unknown To Any devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash verdict
changed from Unknown. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

VerdictManualOverride LEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|Verdict Manual
Override|cat=Policy subtype=Verdict
Manual Override devTime=@Model["Time"]
src=@Model["EsmIp"] shost=@Model["esmHost"]
suser=@Model["user"] fileHash=@Model["Hash"]
NewVerdict=@Model["NewVerdict"] msg=Hash verdict
overridden manually. @Model["OldVerdict"] ->
@Model["NewVerdict"] [email protected]

WfCommunicationsStatusChangedLEEF:1.0|Palo Alto Networks|Traps ESM|

@Model["ProductVersion"]|WildFire
Communications Status Changed|cat=System
subtype=WildFire Communications Status Changed
devTime=@Model["Time"] src=@Model["EsmIp"]
shost=@Model["esmHost"] suser=@Model["user"]
dhost=@Model["host"] msg=WildFire communications
status changed on host '@Model["host"]'. Status:
'@Model["message"] [email protected]

Syslog (RFC5424) Format

The following table lists the events in syslog (RFC5424) format.

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 281

 Event Syslog Format

AccessViolation <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Access
Violation,@Model["host"],@Model["user"],Access
Violation- @Model["TargetName"]:
@Model["TargetValue"],@Model.ExternalSeverity,@Model["EPM"],,,,

AgentContentUpdate <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent Content
Update,@Model["host"],@Model["user"],@Model["host"]
received new content- version
@Model["ContentVersion"],@Model.ExternalSeverity,,,,,,

AgentPolicyChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent Policy
Changed,@Model["host"],@Model["user"],Policy
changed,@Model.ExternalSeverity,,,,,,

ArchivedPreventions <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Preventions
Archived,@Model["esmHost"],@Model["user"],@Model["host"],,@Mode
preventions been
archived,@Model.ExternalSeverity,,,,,

ArchivedPreventionsFailure <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Preventions
Archived
Failed,@Model["esmHost"],@Model["user"],,,Archived
preventions failed,@Model.ExternalSeverity,,,,,

ClientInstall <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent
Install,@Model["host"],@Model["user"],Agent
installed,@Model.ExternalSeverity,,,,,,

ClientLicenseInvalid <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Client License
Invalid,@Model["host"],@Model["user"],Invalid
license ,@Model.ExternalSeverity,,,,,,

ClientLicenseRequest <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Client License
Request,@Model["host"],@Model["user"],New license
request,@Model.ExternalSeverity,,,,,,

282 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

ClientUninstall <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent
Uninstall,@Model["host"],@Model["user"],Agent
uninstalled,@Model.ExternalSeverity,,,,,,

ClientUpgrade <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent
Upgrade,@Model["host"],@Model["user"],Agent
upgraded,@Model.ExternalSeverity,,,,,,

CommunicationsCheckWithProxy <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Communications
Check With
Proxy,@Model["esmHost"],@Model["user"],,,Communications
check with Proxy on host '@Model["host"]'. Status:
'@Model["message"]',@Model.ExternalSeverity,,,,,

ConditionDeleted <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Condition
Deleted,@Model["esmHost"],@Model["user"],,Condition
ID: @Model["id"] was
deleted,@Model.ExternalSeverity,,,,

ConditionEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Condition
Edited,@Model["esmHost"],@Model["user"],,Condition
ID: @Model["id"] was added/
changed.,@Model.ExternalSeverity,,,,

ConfigurationChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Settings
Change,@Model["esmHost"],@Model["user"],,@Model["Property"]
has changed from @Model["OldValue"] to
@Model["NewValue"].,@Model.ExternalSeverity,,,,

DisabledProtection <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Protection
Disabled,@Model["esmHost"],@Model["user"],Protection
disabled on all agents,@Model.ExternalSeverity,,,,,

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 283

 Event Syslog Format

EnabledProtection <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Endpoint
Disconnected,@Model["host"],@Model["user"],Agent
disconnected. last HB
@Model["lastHBTime"],@Model.ExternalSeverity,,,,,,

EsmConfigurationChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,EPM
Init Failed,@Model["host"],@Model["user"],EPM
@Model["EPM"] failed to
initialize,@Model.ExternalSeverity,@Model["EPM"],,,,,

EsmStatusChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,ESM
Configuration
Change,@Model["esmHost"],@Model["user"],,,Multi
ESM configurations has
changed,@Model.ExternalSeverity,,,,,

FileUploadFailure <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Report to
Windows Event
Viewer,@Model["host"],@Model["user"],Report to
Windows Event Viewer,@Model.ExternalSeverity,,,,,,

HashesImport <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,File Upload
Failure,@Model["esmHost"],@Model["user"],@Model["host"],@Model[
failed to
upload,@Model.ExternalSeverity,@Model["fileName"],,,,

Heartbeat <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Hashes
Upload,@Model["esmHost"],@Model["user"],@Model["Amount"]
hashes were
uploaded,@Model.ExternalSeverity,@Model["Hash"],,,,

IncompatibleOs <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Agent
Incompatibility
Issue,@Model["host"],@Model["user"],Traps is
inactive due to
@Model["IncompatibilityReason"],@Model.ExternalSeverity,,,,@Mod

284 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

InstallationPackage <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Agent Package
Created,@Model["esmHost"],@Model["user"],,,@Model["OSType"]
Agent Package was @Model["AgentPackageStatus"].
Package name: @Model["AgentPackageName"] Agent
Version:
@Model["AgentPackageVersion"],@Model.ExternalSeverity,,,,,

LicenseExpiration <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Heartbeat,@Model["host"],@
is alive,@Model.ExternalSeverity,,,,,,

LicensePoolAdded <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,License
Expiration,@Model["esmHost"],@Model["user"],,@Model["user"],@Mo
licenses will expire in @Model["days"]
days,@Model.ExternalSeverity,,,,,

LicenseQuantity <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,License
Pool Added,@Model["esmHost"],@Model["user"],,,A
pool of @Model["licenseCount"] licenses
of type @Model["licenseType"] have been
added,@Model.ExternalSeverity,,,,,

LicenseRevoked <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,License
Quantity,@Model["esmHost"],@Model["user"],,,Agent
Licenses are running
low,@Model.ExternalSeverity,,,,,

LocalAnalysisFeatureExtractionFailed
<134>1 @Model["Rfc5424Time"]
@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,License
Revoked,@Model["esmHost"],@Model["user"] ,@Model["host"],Licens
revoked,@Model.ExternalSeverity,,,,

LocalAnalysisModelUnavailable <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Local
Analysis Extraction
Failed,@Model["host"],@Model["user"],Local
Analysis Feature Extraction
Failed,@Model.ExternalSeverity,,@Model["ContentVersion"],,,,

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 285

 Event Syslog Format

LocalAnalysisModuleFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Local Analysis
Model
Unavailable,@Model["esmHost"],@Model["user"],@Model["host"],,Lo
Analysis Model
Unavailable,@Model.ExternalSeverity,,,,,

LocalAnalysisModuleSucceeded <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Local Analysis
Module Failed,@Model["host"],@Model["user"],Add
new module into Local Analysis-
Failed,@Model.ExternalSeverity,,,,,,

MachineLicenseValidationFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Local Analysis
Module Succeeded,@Model["host"],@Model["user"],Add
new module into Local Analysis-
Succeeded,@Model.ExternalSeverity,,,@Model["ModuleVersion"],,,

NewHash <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Machine License
Validation
Failed,@Model["esmHost"],@Model["user"],@Model["host"],,License
Validation Failed,@Model.ExternalSeverity,,,,,

NotificationEvent <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,New Hash
Added,@Model["esmHost"],@Model["user"],New hash
added,@Model.ExternalSeverity,@Model["Hash"],,,@Model["NewVerdi

OneTimeActionComplete <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Notification
Event,@Model["host"],@Model["user"],New
notification event. Prevention Key:
@Model["preventionKey"],@Model.ExternalSeverity,@Model["EPM"],@

OneTimeActionFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,One Time
Action Complete,@Model["host"],@Model["user"],One
Time Action completed. Action
Type=@Model["ActionType"]. Action
ID=@Model["ActionID"],@Model.ExternalSeverity,,,,,,

286 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

PostDetectionEvent <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Post
Detection Event,@Model["host"],@Model["user"],New
post detection event. Prevention Key:
@Model["preventionKey"],@Model.ExternalSeverity,@Model["EPM"],@

PreventionEvent <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Post
Detection Event,@Model["host"],@Model["user"],New
post detection event. Prevention Key:
@Model["preventionKey"],@Model.ExternalSeverity,@Model["EPM"],@

ProcessCrashed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Prevention
Event,@Model["host"],@Model["user"],New
prevention event. Prevention Key:
@Model["preventionKey"],@Model.ExternalSeverity,@Model["EPM"],@

ProcessDeleted <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Process
Crashed,@Model["host"],@Model["user"],
Process @Model["ProcessName"] had
crashed,@Model.ExternalSeverity,,,,,,

ProcessEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Process
Deleted,@Model["esmHost"],@Model["user"],,Process
was
deleted,@Model.ExternalSeverity,@Model["Name"],,,

ProcessInjectionTimedOut <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Process
Edited,@Model["esmHost"],@Model["user"],,Process
was added/
edited,@Model.ExternalSeverity,@Model.Data.ProcessFilename,,,

ProvisionalEvent <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Process
Injection Time
Out,@Model["host"],@Model["user"],Injection
Timeout,@Model.ExternalSeverity,,,,,,

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 287

 Event Syslog Format

PublisherChanged <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Trusted Signer
Changed,@Model["esmHost"],@Model["user"],Hash
@Model["Hash"] trusted signer changed
automatically from @Model["OldPublisher"] to
@Model["NewPublisher"],@Model.ExternalSeverity,@Model["Hash"],,

QuarantineFailed <134> 1 @Model["Rfc5424Time"]

@Model["esmHost"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Quarantine
Failed,@Model["host"],@Model["user"],File
@Model["fileName"] could
not be quarantined. Reason:
@Model["FailureReason"],@Model.ExternalSeverity,,,,

QuarantineQuotaExceeded <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Quarantine
Failed,@Model["host"],@Model["user"],File
@Model["fileName"] could
not be quarantined. Reason:
@Model["FailureReason"],@Model.ExternalSeverity,,,,,,

QuarantineSucceeded <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Quarantine
Quota Exceeded,@Model["host"],@Model["user"],File
@Model["fileName"] was permanently removed
from the quarantine folder because quota was
exceeded,@Model.ExternalSeverity,,,,,,

RegistrationConflict <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Agent
Registration Conflict
Detected,@Model["esmHost"],@Model["user"],,,Agent
registration conflict detected on host
@Model["host"] from IP: @Model["RequestIP"]. Saved
IP: @Model["AgentIp"],@Model.ExternalSeverity,,,,,

ReportingServiceStartFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Quarantine
Succeed,@Model["host"],@Model["user"],File
@Model["fileName"] was quarantined
successfully,@Model.ExternalSeverity,,,,,,

288 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

RestoreFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Reporting
Service Start
Failed,@Model["host"],@Model["user"],ReportingService
start failed.,@Model.ExternalSeverity,,,,,,

RestoreSucceeded <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Restore
Failed,@Model["host"],@Model["user"],File
@Model["fileName"] could not be restored. Reason:
@Model["FailureReason"],@Model.ExternalSeverity,,,,,,

RestrictionSettingsEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Restore
Succeeded,@Model["host"],@Model["user"],File
@Model["fileName"] restored
successfully,@Model.ExternalSeverity,,,,,,

RoleDeleted <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Restriction
Settings
Edited,@Model["esmHost"],@Model["user"],,Restriction
Settings were added/
changed,@Model.ExternalSeverity,,,,

RoleEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Role
Deleted,@Model["esmHost"],@Model["user"],,Role
@Model["Name"] was
deleted,@Model.ExternalSeverity,,,,

RoleStatusChanged <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Role
Edited,@Model["esmHost"],@Model["user"],,Role
@Model.Data.Name was added
\changed,@Model.ExternalSeverity,,,,

RuleDeleted <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Role Status
Changed,@Model["esmHost"],@Model["user"],,Role
@Model["Name"] status was changed to
@Model["Status"],@Model.ExternalSeverity,,,,

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 289

 Event Syslog Format

RuleEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Rule
Deleted,@Model["esmHost"],@Model["user"],Rule
@Model["id"]:
Deleted,@Model.ExternalSeverity,,@Model["id"],,,

SendingLicenseToClient <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Rule
Edited,@Model["esmHost"],@Model["user"],Rule
@Model.Data.Id:
Edited,@Model.ExternalSeverity,,@Model.Data.Id,,,

ServerContentRevertFailure <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,Sending License
To
Client,@Model["esmHost"],@Model["user"] ,@Model["host"],New
license sent,@Model.ExternalSeverity,,,,

ServerContentRevertSuccess <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Server Content
Revert
Failure,@Model["esmHost"],@Model["user"],Content
version failed to revert to
@Model["ContentVersion"]. Error:
@Model["Error"],@Model.ExternalSeverity,,,,,

ServerContentUpdateFailure <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Server Content
Revert
Success,@Model["esmHost"],@Model["user"],Content
version was reverted to @Model["ContentVersion"]
successfully,@Model.ExternalSeverity,,,,,

ServerContentUpdateSuccess <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Server Content
Update
Failed,@Model["esmHost"],@Model["user"],Content
version failed to update to
@Model["ContentVersion"]. Error:
@Model["Error"],@Model.ExternalSeverity,,,,,

290 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

ServerHeartbeat <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Server Content
Update
Success,@Model["esmHost"],@Model["user"],Content
version was updated to @Model["ContentVersion"]
successfully,@Model.ExternalSeverity,,,,,

ServiceAlive <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,ESM
Heartbeat,@Model["esmHost"],@Model["user"],,,ESM
heartbeat,@Model.ExternalSeverity,,,,,

ServiceStartFailed <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Service
Paused,@Model["host"],@Model["user"],Service
paused,@Model.ExternalSeverity,,,,,,

ServiceStopped <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Service Start
Failed,@Model["host"],@Model["user"],Service start
failed,@Model.ExternalSeverity,,,,,,

ServiceWarning <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Service
Stopped,@Model["host"],@Model["user"],Service
stopped,@Model.ExternalSeverity,,,,,,

SystemShutdown <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Threat,Service
Warning,@Model["host"],@Model["user"],Warning-
Java sandboxed file access to
@Model["TargetValue"],@Model.ExternalSeverity,@Model["EPM"],,,,

TechSupportFileStatus <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,System
Shutdown,@Model["host"],@Model["user"],Service
shutdown,@Model.ExternalSeverity,,,,,,

TrapsServiceStatusChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,Tech Support
File,@Model["esmHost"],,,,Tech Support File:
Status:@Model["Status"],@Model.ExternalSeverity,,,,,

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 291

 Event Syslog Format

UserDeleted <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
Agent,@Model["ProductVersion"],Agent,Traps Service
Status Change,@Model["host"],@Model["user"],Agent
Service Status Changed: @Model["OldStatus"]->
@Model["NewStatus"],@Model.ExternalSeverity,,,,,,

UserEdited <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,User
Deleted,@Model["esmHost"],@Model["user"],,User
@Model["Name"] was
deleted.,@Model.ExternalSeverity,,,,

UserLogin <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,User
Edited,@Model["esmHost"],@Model["user"],,User
@Model.Data.Name was added
\changed.,@Model.ExternalSeverity,,,,

UserStatusChanged <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],System,User
Login,@Model["esmHost"],@Model["user"],,,User
@Model.Data.Username logged in to ESM
console,@Model.ExternalSeverity,,,,,

VerdictChange <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Config,User Status
Changed,@Model["esmHost"],@Model["user"],,User
@Model["Name"] status was changed to
@Model["Status"],@Model.ExternalSeverity,,,,

VerdictChangeAnyToMalware <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict
Changed,@Model["esmHost"],@Model["user"],Hash
verdict changed. @Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

VerdictChangeMalwareToAny <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict Changed
Any To
Malware,@Model["esmHost"],@Model["user"],Hash
verdict changed to Malware. @Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

292 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Syslog Format

VerdictChangeNoConnectionToAny
<134>1 @Model["Rfc5424Time"]
@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict Change
Malware To
Any,@Model["esmHost"],@Model["user"],Hash verdict
changed from Malware. Awaiting to restore:
@Model["QuarantineStatus"]. @Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

VerdictChangeUnknownToAny <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict
Change No Connection To
Any,@Model["esmHost"],@Model["user"],Hash verdict
changed from No Connection. @Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

VerdictManualOverride <134>1 @Model["Rfc5424Time"]

@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict Change
Unknown To
Any,@Model["esmHost"],@Model["user"],Hash verdict
changed from Unknown. @Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

WfCommunicationsStatusChanged<134>1 @Model["Rfc5424Time"]
@Model["EsmIp"] - - - @Model["Time"],Traps
ESM,@Model["ProductVersion"],Policy,Verdict
Reverted To
Wildfire,@Model["esmHost"],@Model["user"],Hash
verdict reverted to WildFire.
@Model["OldVerdict"] ->
@Model["NewVerdict"],@Model.ExternalSeverity,@Model["Hash"],,,@

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 293

Forward Logs to Panorama
The ESM supports additional log forwarding to Panorama. When integrated with the ESM, Panorama serves
as a Syslog receiver that ingests logs from ESM components using Syslog over TCP, UDP or SSL. The ESM
supports external log forwarding to up to two different devicesone of which can be to a log collector or
a Panorama which also serves as a log collectorand to email. However, unlike the configuration for an
external logging platform or email address, you cannot select individual events to forward to Panorama.
Instead, the ESM automatically sends all events to Panorama.
Forwarding logs to a Panorama log collector yields the following benefits:
Panorama provides a single user interface through which you can view all ESM and Traps activity. This
enables you to manage both network and endpoint health in one place.
Panorama can correlate discrete security-events that occur on the endpoints with whats happening
on the network to trace any suspicious or malicious activity across the endpoints and the firewall. This
integrated view gives you more context on the chronology of events and the evidence you need to
detect, identify, and respond to an incident.

Because a Panorama virtual appliance in legacy mode cannot ingest Traps logs, you must
use a Panorama virtual appliance in Panorama mode.

Set up Secure Communication with Panorama

Enable Log Forwarding to Panorama
View ESM Logs and Correlated Events on Panorama

Set Up Secure Communication with Panorama

To set up secure communication, use the following workflow:

STEP 1 | On your enterprise domain controller, create a DNS A record that points to the IP address of
the Panorama log collector (for example, you can use the DNS snap-in available in Windows
Administrative Tools to create the DNS record).

STEP 2 | Create the server certificate for the ESM components to use to trust and verify the identity of
Panorama. The certificate must be generated from a certificate authority (CA) that is trusted
by the ESM. The Common Name of the certificate must also identify Panorama using the name
you specified in the DNS record.
There are multiple methods for creating the server certificate:
Obtain a certificate from an external CA (see Steps 1 and 2 in the procedure and then follow the
instructions below to import the certificate)
Obtain a certificate from your Active Directory CA.
The following procedure describes how to create a certificate from your Active Directory CA:
1. Open IIS Manager and navigate to the level you want to manage.
2. Double-click Server Certificates.
3. In the Actions pane, click Create Domain Certificate.
4. On the Distinguished Name Properties page of the Create Certificate Wizard, enter the information
for your certificate. In the Common name field, make sure to specify Panorama using the name you
used to identify the server in the DNS record.

294 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 5. Click Next.
6. On the Online Certification Authority page, in the Specify Online Certification Authority box, enter
or Select the name of a CA server in your Windows domain.
7. Enter a Friendly name for the certificate and then click Finish.
8. Export the certificate and private key as a PFX file.

STEP 3 | In Panorama, import the certificate.

1. In Panorama, select Certificate Management > Certificates and then select Import.
2. Enter a name to identify the certificate name and browse to the certificate PFX file containing the
private key.
3. Select the file format as Encrypted Private Key and Certificate (PKCS12).
4. Enter the Passphrase you used when creating the certificate and confirm it.
5. Click OK. The Device Certificates tab displays the certificate with a Status of valid.

STEP 4 | Click the certificate Name and enable the Certificate for Secure Syslog, then click OK.

STEP 5 | On Panorama, associate the certificate that you configured for secure communication with the
managed collector:
1. Select Panorama > Managed Collectors > <collector> > General.
2. Select the Inbound Certificate for Secure Syslog. This is the certificate you created and imported
earlier in the workflow.
3. Click OK and then Commit your changes.

STEP 6 | Enable communication between the ESM Server and Panorama to use TLS 1.1 and higher
protocols.
1. On the ESM Server, open regedit.exe: Click Start, and type regedit in the Run or Search field and
press Enter.
2. Browse to the following path: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework
\v4.0.30319\
3. Select Edit > New > DWORD (32-bit) Value.
4. Name the value SchUseStrongCrypto.
5. Double-click the new value and enter 1 as the value data in Hexadecimal format, then click OK.
6. Reboot the ESM Server.

STEP 7 | Configure the ESM to forward logs to Panorama as described in Enable Log Forwarding to
Panorama and then verify your connectivity.

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 295

Enable Log Forwarding to Panorama
To enable log forwarding to a Panorama log collector, use the following workflow:
STEP 1 | Before you begin: If you are enabling SSL for secure syslog communication between Panorama
and the ESM Server(s), you must Set Up Secure Communication with Panorama.

STEP 2 | To Configure a Panorama log collector to receiveESMandTraps logs, first define the log
ingestion profile on Panorama:
1. Select Panorama > Log Ingestion Profile, and click Add.
2. Enter a Name for the profile.
3. Add a new profile and enter the details for the ESM Server. You can add up to four ESM Servers to a
profile.
4. Enter a Source Name.
5. Specify the Port on which Panorama will be listening for syslog messages. The range is 23000 to
23999.
6. Select the Transport layer protocolTCP, UDP, or SSL.
7. Select Traps_ESM for External Log type and 3.4.1+ from the Version drop-down.

As Traps log formats are updated, the updated log definitions will be available through content updates
on Panorama.

STEP 3 | Attach the log ingestion profile to a Collector Group.

1. Select Panorama > Collector Groups > Log Ingestion and Add the log ingestion profile so that the
Collector Group can receive logs from the ESM Server(s) listed in the profile.
If you are enabling SSL for secure syslog communication between Panorama and the ESM Server(s),
verify that an Inbound Certificate for Secure Syslog is selected. For more information, see the Set Up
Secure Communication with Panorama.

2. Commit changes to Panorama and the Collector Group.

STEP 4 | Enable log forwarding to Panorama on the ESM Console.

If you use a Panorama High Availability (HA) configuration, you can also specify the server and port
information of the redundant server. Panorama in HA provides redundancy in the event of a system or
network failure.

296 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

 1. From the ESM Console, select Settings > ESM > Panorama.
2. Enable log forwarding to Panorama.
3. Configure the following settings:
Panorama ServerHostname or IP address of the Panorama server.
Panorama Server PortPort on which Panorama will be listening for syslog messages.
Panorama Failover Server (Optional)Hostname or IP address of a secondary Panorama server.
Panorama Failover Server PortPort of the secondary Panorama on which Panorama will be
listening for syslog messages.
Communication ProtocolTransport layer protocol that the ESM uses to send logs to Panorama:
TCP, TCP with SSL, or UDP. If you are enabling SSL for secure syslog communication between
Panorama and the ESM Server(s), you must also import the Panorama root CA certificate on to the
ESM Server as described in the following step.
4. Click Save.

STEP 5 | Verify connectivity between the ESM and Panorama.

Click Check Connectivity. The ESM Console sends a test communication to the external logging
platform using the settings you configured. If you do not receive the test message, confirm that your
settings are correct and then try again.

View ESM Logs and Correlated Events on Panorama

After you Setup Secure Communication with Panorama and EnableLog Forwarding to Panorama, you can
view logs and correlated events on Panorama.

STEP 1 | Log in to Panorama.

STEP 2 | Select Monitor > External Logs > Traps ESM to view the logs ingested in to Panorama.

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 297

STEP 3 | To view correlated events that Panorama generates when a Traps agent and the firewall have
observed command and control activity from one or more infected hosts on your network,
select Monitor > Automated Correlation Engine > Correlated Events.

298 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Forward Logs to Email
Enable Log Forwarding to Email on page 299
Email Format on page 300

Enable Log Forwarding to Email

The ESM Console generates logs for over 60 types of events including security events, policy configuration
changes, and monitoring events (agent and server). Depending on the type and severity of the data in the
log files, you may want to be receive email alerts when critical events require your attention. The ESM
Console forwards logs to an email address using the SMTP service. If you want to forward all or some of
these logs to an external email address, you can use SSL for reliable and secure transport of logs. After
configuring the email reporting settings, you can send a test message to verify the log forwarding settings.

The date/time of the each logged event is in Universal Time Coordinated (UTC).

Use the following workflow to configure the ESM Console to send logs and events to an email account.
STEP 1 | Enable email reporting.
From the ESM Console, select Settings > ESM > Email, and then select Enable Mail Reporting.

STEP 2 | Configure the email settings.

Specify the following email settings:
Display NameDisplay name for the email account that sends the logs.
User nameName of the user who can access the SMTP service.
PasswordPassword for the user account that can access the SMTP service.
HostHostname or IP address of the SMTP service.
Smtp PortCommunication port of the SMTP service (default is 0).
Enable SSLSelect this option for secure transport of logs in email.
Email AddressEmail address of the sender from which the logs are sent.
RecipientEmail address of the recipient to which the logs are sent.
Email Timeout (Seconds)Period (in seconds) after which the ESM stops trying to send logs (default
is 60; range is 1 to 120).

STEP 3 | Select the events that you want to send to an external email address.
In the Logging Events area, select one or more of the events. Scroll through the list to see additional
types of events you can send.

STEP 4 | Save your settings.

Click Save.

STEP 5 | Verify the configuration of your email settings.

Click Send Test Message. The ESM Console sends a test communication to the email address using the
information on the Email page. If you do not receive the test message, confirm that your settings are
correct and then try again.

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 299

Email Format
The following table lists the events in Email format.

Event Email Format

AccessViolation <html><body><p><div>Log Event:<strong>

Agent Access Violation</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Target Name:<strong>
@Model["TargetName"]</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

AgentContentUpdate <html><body><p><div>Log Event:<strong> Agent

@Model["host"] received new content version
@Model["ContentVersion"].</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong>@Model["host"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

AgentPolicyChange <html><body><p><div>Log Event:<strong>

Agent Policy Change</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

ArchivedPreventions <html><body><p><div>Log Event:<strong>

Archive Threats Events</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>User:<strong> @Model["user"]</strong></
div><div>Number of Archived Events:<strong>
@Model["totalPreventions"]</strong></div></p></
body></html>

ArchivedPreventionsFailure <html><body><p><div>Log Event:<strong> Archive

Threats Events Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>User:<strong> @Model["user"]</
strong></div><div>Number of Archived Events
(Actual):<strong> @Model["progressCount"]</
strong></div><div>Number of Archived Events
(Total):<strong> @Model["totalPreventions"]</
strong></div></p></body></html>

300 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

ClientInstall <html><body><p><div>Log Event:<strong> Agent

Installed to System</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

ClientLicenseInvalid <html><body><p><div>Log Event:<strong>

Agent License Invalid</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div></p></body></html>

ClientLicenseRequest <html><body><p><div>Log Event:<strong>

Agent License Request</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div></p></body></html>

ClientUninstall <html><body><p><div>Log Event:<strong> Agent

Uninstalled from System</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

ClientUpgrade <html><body><p><div>Log Event:<strong>

Agent Upgraded</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

CommunicationsCheckWithProxy <html><body><p><div>Log Event:<strong>

Communications Check With Proxy</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Host:<strong>
@Model["esmHost"], @Model["EsmIp"]</
strong></div><div>ESM Version:<strong>
@Model["ProductVersion"]</strong></
div><div>Status:<strong> @Model["message"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 301

 Event Email Format

ConditionDeleted <html><body><p><div>Log Event:<strong> Condition

Deleted</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Condition
Name:<strong> @Model["Name"]</strong></
div><div>Condition ID:<strong> @Model["id"]</
strong></div><div>Condition Description:<strong>
@Model["Description"]</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

ConditionEdited <html><body><p><div>Log Event:<strong>

Condition Added/Edited</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Condition Name:<strong>
@Model.Data.Name</strong></div><div>Condition
Description:<strong> @Model.Data.Description</
strong></div><div>By User:<strong>
@Model["user"]</strong></div></p></body></html>

ConfigurationChange <html><body><p><div>Log Event:<strong>

Settings Change</strong></div><p></
p><div>Description:<strong> @Model["Property"]
changed from @Model["OldValue"]
to @Model["NewValue"].</strong></
div><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>By User:<strong>
@Model["user"]</strong></div><div>Server:<strong>
@Model["esmHost"], @Model["EsmIp"]</strong></
div></p></body></html>

DisabledProtection <html><body><p><div>Log Event:<strong>

Protection Disabled</strong></div><p></
p><div>Description:<strong> Protection is
disabled across the entire organization! </
strong></div><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>By User:<strong>
@Model["user"]</strong></div></p></body></html>

EnabledProtection <html><body><p><div>Log Event:<strong>

Protection Enabled</strong></div><p></
p><div>Description:<strong> Protection is
restored across the entire organization!</
strong></div><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>By User:<strong>
@Model["user"]</strong></div></p></body></html>

302 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

EsmConfigurationChange <html><body><p><div>Log Event:<strong> ESM

Configuration Changed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Server Name:<strong>
@Model["esmHost"], @Model["EsmIp"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

EsmStatusChange <html><body><p><div>Log Event:<strong> ESM Status

Changed</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Server
Name:<strong> @Model["host"]</strong></
div><div>Status:<strong> @Model["NewStatus"]</
strong></div><div>Message:<strong> Server Status
Change</strong></div></p></body></html>

FileUploadFailure <html><body><p><div>Log Event:<strong>

Agent File Upload Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></
div><div>File Name:<strong> @Model["fileName"]</
strong></div><div>Failure Reason:<strong>
@Model["message"]</strong></div></p></body></
html>

HashesImport <html><body><p><div>Log Event:<strong>

Hashes Imported</strong></div><p></
p><div>Description:<strong> Hashes were
Imported into the ESM</strong></div><div>Hash
Count:<strong> @Model["Amount"]</strong></
div><div>Hash:<strong> @Model["Hash"]</strong></
div></p></body></html>

Heartbeat <html><body><p><div>Log Event:<strong>

Agent Heartbeat - Any</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

IncompatibleOs <html><body><p><div>Log Event:<strong> Traps is

inactive due to @Model["IncompatibilityReason"]</
strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></
div><div>Computer:<strong>@Model["AgentIp"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 303

 Event Email Format

InstallationPackage <html><body><p><div>Log Event:<strong>

Agent Package Created</strong></div><p></
p><div>Description:<strong> @Model["OSType"]
Agent Package was @Model["AgentPackageStatus"].</
strong></div><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Package
name:<strong> @Model["AgentPackageName"]</
strong></div><div>Agent Version:<strong>
@Model["AgentPackageVersion"]</strong></div></
p></body></html>

LicenseExpiration <html><body><p><div>Log Event:<strong>

License Expiration</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>License Type:<strong> @Model["poolName"]
</strong></div><div>Expiration in (days):<strong>
@Model["days"] </strong></div></p></body></html>

LicensePoolAdded <html><body><p><div>Log Event:<strong>

License Pool Added</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>License Type:<strong>
@Model["licenseType"]</strong></div><div>License
Count:<strong> @Model["licenseCount"]</strong></
div></p></body></html>

LicenseQuantity <html><body><p><div>Log Event:<strong>

License Quantity</strong></div><p></
p><div>Description:<strong> Agent Licenses are
running low</strong></div><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Used
Licenses:<strong> @Model["deployedLicenses"]</
strong></div><div>Total Licenses :<strong>
@Model["totalLicenses"]</strong></div></p></
body></html>

LicenseRevoked <html><body><p><div>Log Event:<strong>

Agent License Revoked</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div></p></body></html>

304 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

LocalAnalysisFeatureExtractionFailed<html><body><p><div>Log Event:<strong>
Local Analysis Feature Extraction Failed</
strong></div><p></p><div>Description:<strong>
Local Analysis Feature Extraction
Failed</strong></div><div>Content
Version:<strong>@Model["ContentVersion"]</
strong></div><div>Hash:<strong>@Model["Hash"]</
strong></div><div>Model
Version:<strong>@Model["ContentVersion"]</
strong></div><div>Server
Name:<strong>@Model["esmHost"],
@Model["EsmIp"]</strong></div><div>By
User:<strong>@Model["user"]</strong></
div><div>Product Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

LocalAnalysisModelUnavailable <html><body><p><div>Log Event:<strong> Local

Analysis Model Unavailable</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Server Name:<strong>@Model["esmHost"],
@Model["EsmIp"]</strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

LocalAnalysisModuleFailed <html><body><p><div>Log Event:<strong> Local

Analysis Module Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></p></body></
html>

LocalAnalysisModuleSucceeded <html><body><p><div>Log Event:<strong> Local

Analysis Module Succeeded</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></
div>Local Analysis Module Version:<strong>
@Model["ModuleVersion"]</strong></div></p></
body></html>

MachineLicenseValidationFailed <html><body><p><div>Log Event:<strong> Agent

License Validation Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 305

 Event Email Format

NewHash <html><body><p><div>Log Event:<strong>

Hash Added</strong></div><p></
p><div>Description:<strong> Hash was
added to the ESM Hash list</strong></
div><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Hash:<strong> @Model["Hash"]</
strong></div></p></body></html>

NotificationEvent <html><body><p><div>Log Event:<strong>

Notification Event</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>User:<strong>
@Model["user"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><p></p><div>Module Name:<strong>
@Model["EPM"]</strong></div><div>Process
Name:<strong> @Model["ProcessName"]</
strong></div><div>Hash:<strong>
@Model["Hash"]</strong></div><div>Prevention
Key:<strong> @Model["preventionKey"]</
strong></div><div>Content
Version:<strong>@Model["ContentVersion"]</
strong></div></p></body></html>

OneTimeActionComplete <html><body><p><div>Log Event:<strong>

Agent One Time Action Completed</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Action Type:<strong>
@Model["ActionType"]</strong></div><div>Action
ID:<strong> @Model["ActionID"]</strong></div></
p></body></html>

OneTimeActionFailed <html><body><p><div>Log Event:<strong>

Agent One Time Action Failed</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Action Type:<strong>
@Model["ActionType"]</strong></div><div>Action
ID:<strong> @Model["ActionID"]</strong></div></
p></body></html>

306 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

PostDetectionEvent <html><body><p><div>Log Event:<strong>

Post Detection Event</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>User:<strong>
@Model["user"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><p></p><div>Module Name:<strong>
@Model["EPM"]</strong></div><div>Process
Name:<strong> @Model["ProcessName"]</
strong></div><div>Hash:<strong>
@Model["Hash"]</strong></div><div>Prevention
Key:<strong> @Model["preventionKey"]</
strong></div><div>Content
Version:<strong>@Model["ContentVersion"]</
strong></div></p></body></html>

PreventionEvent <html><body><p><div>Log Event:<strong>

Prevention Event</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>User:<strong>
@Model["user"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><p></p><div>Module Name:<strong>
@Model["EPM"]</strong></div><div>Process
Name:<strong> @Model["ProcessName"]</
strong></div><div>Hash:<strong>
@Model["Hash"]</strong></div><div>Prevention
Key:<strong> @Model["preventionKey"]</
strong></div><div>Content
Version:<strong>@Model["ContentVersion"]</
strong></div></p></body></html>

ProcessCrashed <html><body><p><div>Log Event:<strong>

Agent Process Crashed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Process name:<strong>
@Model["ProcessName"]</strong></div><div>Error
message:<strong> @Model["message"]</strong></
div></p></body></html>

ProcessDeleted <html><body><p><div>Log Event:<strong> Process

Deleted</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Process
Name:<strong> @Model["Name"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 307

 Event Email Format

ProcessEdited <html><body><p><div>Log Event:<strong>

Process Added/Edited</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Process Name:<strong>
@Model.Data.ProcessFilename</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

ProcessInjectionTimedOut <html><body><p><div>Log Event:<strong>

Agent Process Injection Timeout</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Process Name:<strong>
@Model["ProcessName"]</strong></
div><div>PID:<strong> @Model["pId"]</
strong></div><div>Severity:<strong>
@Model.ExternalSeverity</strong></div></p></
body></html>

PublisherChanged <html><body><p><div>Log Event:<strong>

Trusted Signer changed automatically</
strong></div><p></p><div>Description:<strong>
Hash trusted signer has changed</strong></
div><div>Hash:<strong>@Model["Hash"]</
strong></div><div>Previous Trusted
Signer:<strong>@Model["OldPublisher"]</
strong></div><div>New Trusted Signer:<strong>
@Model["NewPublisher"]</strong></div><div>Server
Name:<strong>@Model["esmHost"], @Model["EsmIp"]</
strong></div><div>By User:<strong>
@Model["user"]</strong></div></p></body></html>

QuarantineFailed <html><body><p><div>Log Event:<strong>

File Quarantine Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>File Name:<strong> @Model["fileName"]</
strong></div><div>Failure Reason:<strong>
@Model["FailureReason"]</strong></
div><div>Computer:<strong>@Model["host"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

308 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

QuarantineQuotaExceeded <html><body><p><div>Log Event:<strong>

Quarantine Quota Exceeded</strong></
div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>File
Name:<strong> @Model["fileName"]</strong></
div><div>Computer:<strong>@Model["host"]</
strong><div>By User:<strong>@Model["user"]</
strong></div></p></body></html>

QuarantineSucceeded <html><body><p><div>Log Event:<strong> File

Quarantine Succeeded</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>File Name:<strong>
@Model["fileName"]</strong></
div><div>Computer:<strong>@Model["host"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div></p></body></html>

RegistrationConflict <html><body><p><div>Log Event:<strong> Agent

Registration Conflict Detected</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Server Name:<strong>
@Model["esmHost"]</strong></div><div>Requested
IP:<strong> @Model["RequestIP"]</strong></
div><div>Existing IP:<strong> @Model["AgentIp"]</
strong></div></p></body></html>

ReportingServiceStartFailed <html><body><p><div>Log Event:<strong> Agent

Reporting Service Start Failed</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Exception:<strong>
@Model["msg"]</strong></div></p></body></html>

RestoreFailed <html><body><p><div>Log Event:<strong>

File Restore Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>File Name:<strong> @Model["fileName"]</
strong></div><div>Failure Reason:<strong>
@Model["FailureReason"]</strong></
div><div>Computer:<strong>@Model["host"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 309

 Event Email Format

RestoreSucceeded <html><body><p><div>Log Event:<strong>

File Restore Succeeded</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>File Name:<strong>
@Model["fileName"]</strong></
div><div>Computer:<strong>@Model["host"]</
strong></div><div>Agent
Version:<strong>@Model["ProductVersion"]</
strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

RestrictionSettingsEdited <html><body><p><div>Log Event:<strong>

Restrictions Settings Add/Edit</strong></
div><p></p><div>Description:<strong> Restrictions
Settings in the ESM were Added/Edited</
strong></div><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>By User:<strong>
@Model["user"]</strong></div></p></body></html>

RoleDeleted <html><body><p><div>Log Event:<strong> Role

Deleted</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Role
Name:<strong> @Model["Name"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

RoleEdited <html><body><p><div>Log Event:<strong>

Role Added/Edited</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Role Name:<strong>
@Model.Data.Name</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

RoleStatusChanged <html><body><p><div>Log Event:<strong>

Role Status Changed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Role Name:<strong>
@Model["Name"]</strong></div><div>Status:<strong>
@Model["Status"]</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

310 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

RuleDeleted <html><body><p><div>Log Event:<strong> Rule

Deleted</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Rule
Name:<strong> @Model["Name"]</strong></
div><div>Rule ID:<strong> @Model["id"]</
strong></div><div>Rule Description:<strong>
@Model["Description"]</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

RuleEdited <html><body><p><div>Log Event:<strong>

Rule Added/Edited</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Rule Name:<strong>
@Model.Data.Name</strong></div><div>Rule
ID:<strong> @Model.Data.Id</strong></
div><div>Rule Description:<strong>
@Model.Data.Description</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

SendingLicenseToClient <html><body><p><div>Log Event:<strong>

License Sent to Agent</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div></p></body></html>

ServerContentRevertFailure <html><body><p><div>Log Event:<strong>

Content version failed to revert
to @Model["ContentVersion"]. Error:
@Model["Error"]</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>Server Name:<strong>
@Model["esmHost"], @Model["EsmIp"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

ServerContentRevertSuccess <html><body><p><div>Log Event:<strong> Content

version was reverted to @Model["ContentVersion"]
successfully.</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 311

 Event Email Format

ServerContentUpdateFailure <html><body><p><div>Log Event:<strong>

Content version failed to update
to @Model["ContentVersion"]. Error:
@Model["Error"]</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Server Name:<strong>@Model["esmHost"],
@Model["EsmIp"]</strong></div><div>By
User:<strong>@Model["user"]</strong></div></p></
body></html>

ServerContentUpdateSuccess <html><body><p><div>Log Event:<strong> Content

version was updated to @Model["ContentVersion"]
successfully.</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Server Name:<strong>@Model["esmHost"],
@Model["EsmIp"]</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

ServerHeartbeat <html><body><p><div>Log Event:<strong>

ESM Heartbeat</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Server Name:<strong> @Model["esmHost"],
@Model["EsmIp"]</strong></div></p></body></html>

ServiceAlive <html><body><p><div>Log Event:<strong>

Agent Service Start</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

ServiceStartFailed <html><body><p><div>Log Event:<strong> Agent

Service Start Failed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></
div><div>Error:<strong> @Model["Error"]</
strong></div></p></body></html>

ServiceStopped <html><body><p><div>Log Event:<strong>

Agent Service Stopped</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

312 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

ServiceWarning <html><body><p><div>Log Event:<strong>

Agent Service Warning</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></
div><div>Java sandbox file access to:<strong>
@Model["TargetValue"]</strong></div></p></body></
html>

SystemShutdown <html><body><p><div>Log Event:<strong>

Agent Shutdown</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Computer:<strong> @Model["host"]</
strong></div><div>Agent Version:<strong>
@Model["ProductVersion"]</strong></div></p></
body></html>

TechSupportFileStatus <html><body><p><div>Log Event:<strong>

Tech Support File</strong></div><p></
p><div>Description:<strong> Tech Support
File Generation</strong><div>Time:<strong>
@Model.Time (UTC)</strong></div></
div><div>Job:<strong> @Model["JobID"]</strong></
div><div>Status:<strong> @Model["Status"]</
strong></div><div>Server Name:<strong>
@Model["esmHost"], @Model["EsmIp"]</strong></
div></p></body></html>

TrapsServiceStatusChange <html><body><p><div>Log Event:<strong>

Agent Service Status Changed</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Computer:<strong>
@Model["host"]</strong></div><div>Agent
Version:<strong> @Model["ProductVersion"]</
strong></div><div>Previous Status:<strong>
@Model["OldStatus"]</strong></div><div>New
Status:<strong> @Model["NewStatus"]</strong></
div></p></body></html>

UserDeleted <html><body><p><div>Log Event:<strong> User

Deleted</strong></div><p></p><div>Time:<strong>
@Model.Time (UTC)</strong></div><div>Deleted
User Name:<strong> @Model["Name"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 313

 Event Email Format

UserEdited <html><body><p><div>Log Event:<strong>

User Added/Edited</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>Added/Edited User Name:<strong>
@Model.Data.Name</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

UserLogin <html><body><p><div>Log Event:<strong>

User Login</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</strong></
div><div>User:<strong> @Model.Data.Username</
strong></div></p></body></html>

UserStatusChanged <html><body><p><div>Log Event:<strong>

User Status Changed</strong></div><p></
p><div>Time:<strong> @Model.Time (UTC)</
strong></div><div>User Name:<strong>
@Model["Name"]</strong></div><div>Status:<strong>
@Model["Status"]</strong></div><div>By
User:<strong> @Model["user"]</strong></div></p></
body></html>

VerdictChange <html><body><p><div>Log Event:<strong> Verdict

Changed - Any to Any</strong></div><p></
p><div>Description:<strong> Hash Verdict
has Changed</strong></div><div>Hash:<strong>
@Model["Hash"]</strong></div><div>Previous
Verdict:<strong> @Model["OldVerdict"]</
strong></div><div>New Verdict:<strong>
@Model["NewVerdict"]</strong></div></p></body></
html>

VerdictChangeAnyToMalware <html><body><p><div>Log Event:<strong>

Verdict Changed - Any to Malware</strong></
div><p></p><div>Description:<strong> Hash
Verdict has Changed to Malware</strong></
div><div>Hash:<strong> @Model["Hash"]</
strong></div><div>Previous Verdict:<strong>
@Model["OldVerdict"]</strong></div><div>New
Verdict:<strong> @Model["NewVerdict"]</strong></
div></p></body></html>

314 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging

Event Email Format

VerdictChangeMalwareToAny <html><body><p><div>Log Event:<strong>

Verdict Changed - Malware to Any</strong></
div><p></p><div>Description:<strong> Hash
Verdict has Changed from Malware.</strong></
div><div>Hash:<strong> @Model["Hash"]</
strong></div><div>Awaiting to restore:<strong>
@Model["QuarantineStatus"]</strong></
div><div>Previous Verdict:<strong>
@Model["OldVerdict"]</strong></div><div>New
Verdict:<strong> @Model["NewVerdict"]</strong></
div></p></body></html>

VerdictChangeNoConnectionToAny <html><body><p><div>Log Event:<strong> Verdict

Changed - No connection to Any</strong></
div><p></p><div>Description:<strong> Hash
Verdict has Changed from No connection</
strong></div><div>Hash:<strong> @Model["Hash"]</
strong></div><div>Previous Verdict:<strong>
@Model["OldVerdict"]</strong></div><div>New
Verdict:<strong> @Model["NewVerdict"]</strong></
div></p></body></html>

VerdictChangeUnknownToAny <html><body><p><div>Log Event:<strong>

Verdict Changed - Unknown to Any</strong></
div><p></p><div>Description:<strong> Hash
Verdict has Changed from Unknown</strong></
div><div>Hash:<strong> @Model["Hash"]</
strong></div><div>Previous Verdict:<strong>
@Model["OldVerdict"]</strong></div><div>New
Verdict:<strong> @Model["NewVerdict"]</strong></
div></p></body></html>

VerdictManualOverride <html><body><p><div>Log Event:<strong>

Verdict Manual Override</strong></
div><p></p><div>Description:<strong> Hash
verdict overridden manually</strong></
div><div>Hash:<strong> @Model["Hash"]</
strong></div><div>Previous Verdict:<strong>
@Model["OldVerdict"]</strong></div><div>New
Verdict:<strong> @Model["NewVerdict"]</strong></
div><div>By User:<strong> @Model["user"]</
strong></div></p></body></html>

WfCommunicationsStatusChanged <html><body><p><div>Log Event:<strong> WildFire

Communications Status Changed</strong></
div><p></p><div>Time:<strong> @Model.Time
(UTC)</strong></div><div>Server Name:<strong>
@Model["esmHost"], @Model["EsmIp"]</
strong></div><div>ESM Version:<strong>
@Model["ProductVersion"]</strong></
div><div>Status:<strong> @Model["message"]</
strong></div></p></body></html>

TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging 315

316 TRAPS ADMINISTRATOR'S GUIDE | Reports and Logging
Troubleshooting
> Traps Troubleshooting Resources on page 319
> Traps and Endpoint Security Manager Processes on page 321
> ESM Tech Support File on page 322
> Database (DB) Configuration Tool on page 323
> Cytool on page 329
> Troubleshoot Traps Issues on page 346
> Troubleshoot ESM Console Issues on page 350

317
318 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting
Traps Troubleshooting Resources
To troubleshoot Traps and the Endpoint Security Manager (comprising an ESM Server, the ESM Console,
and a database), use the following resources:

Resource Description

ESM Resources

ESM Console Web interface, which provides reports and logs. The information is useful
for monitoring and filtering the logs to interpret unusual behavior on your
network. After analyzing a security event, you can choose to create a custom
rule for the endpoint or process.

ESM Server DebugWeb Indicates information, warnings, and errors related to the Endpoint Security
log Manager. The DebugWeb log is located in the %ProgramData%\Cyvera
\Logs folder of the ESM Server.

ESM Server log Indicates information, warnings, and errors related to the Endpoint Database
and ESM Server. The Server log is located in the %ProgramData%\Cyvera
\Logs folder of the ESM Server.

ESM Tech Support file On-demand aggregation of active ESM Console and ESM Server logs and
settings to aid Technical Support in troubleshooting and diagnosing issues.
For more information, see ESM Tech Support File.

Database (DB) Command-line interface that provides an alternative to managing basic server
Configuration Tool settings using the ESM Console. You can access the DB Configuration Tool
(dbconfig.exe) using a Microsoft MS-DOS command prompt run as an administrator. For
more information, see Database (DB) Configuration Tool.

Traps Resources

Traps installation log Specifies any errors encountered during installation of Traps or ESM
components. Use this log file when you need to troubleshoot installation
issues. On Windows endpoints, the installer stores the log files in the %temp%
or C:\Users\<user_name>\AppData\Local\Temp folder.

Traps Service log Indicates information, warnings, and errors related to the Traps service. The
Service log is located in the following folder on the endpoint:
Windows Vista and later: %ProgramData%\Cyvera\Logs
Windows XP: C:\Document and Settings\All Users
\Application Data\Cyvera\Logs
Mac OS X 10.10 and OSX 10.11/var/log/traps/
macOS 10.12View logs from the Console application

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 319

 Resource Description

Traps Console log Indicates information, warnings, and errors related to the Traps console.
The Console log is located in the following folder on the endpoint:
Windows Vista and later: C:\Users\<username>\AppData\Roaming
\Cyvera
Windows XP: C:\Document and Settings\<username>
\Application Data\Cyvera\Logs
Mac OS X 10.10 and OSX 10.11/var/log/traps/agent/
macOS 10.12View logs from the Console application

Traps and ESM initiated See Traps and Endpoint Security Manager Processes.
processes

Supervisor Command Allows you to enumerate protected processes, enable or disable protection
Line Tool (cytool.exe) features, and enable or disable Traps management actions from a command
line interface. For more information, see Cytool.

320 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

Traps and Endpoint Security Manager
Processes
The following processes are initiated by Traps and the Endpoint Security Manager (ESM).

Component Process Name Description

ESM

ESM CyveraServer.exe ESM Server core service, which communicates with the agents and
Server with WildFire.

Traps for Mac

Traps trapsd Main Traps process.

agent

Traps authorized Traps process which communicates with WildFire to obtain the latest
agent verdicts.

Traps pmd Traps process which communicates with the ESM Server to obtain the
agent latest security policies.

Traps kproc_ctrl Kernel extension which enforces the policy and prevent security
agent attacks, when needed.

Traps for Windows

Traps CyveraConsole.exe User interface for the Traps console. Runs only after the user launches
agent the console from the notification area (system tray).

Traps CyveraService.exe Traps agent core service, which works with Cyserver.exe to enforce
agent the policy, communicate with the server, and prevent security attacks,
when needed.

Traps Cyserver.exe Traps agent core service, which works with CyveraService.exe to
agent enforce the policy, communicate with the server, and prevent security
attacks, when needed.

Traps Cytray.exe Traps Tray process, allows the user to click on the tray icon and run
agent the console. Runs constantly in the background.

Traps Tda.exe Traps dump analyzer, which analyzes the contents of memory
agent locations and other data when a prevention event occurs on the
endpoint.

Traps Tdawork.exe Traps dump analyzer worker processes, one per processor. These
agent processes run in the background and should run constantly.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 321

ESM Tech Support File
From the ESM Console, you can create an ESM tech support file containing the following information:
Effective security policy
ESM Console and ESM Server settings
ESM Console and ESM Server logs
Database query results
The ESM Console aggregates and packages these logs into a ZIP file (< 1GB) that you can then download
and send to Technical Support. Each time you generate a new ESM tech support file, the ESM Console
logs the event. You can view the status and history of all tech support files from the ESM Console and can
also configure log forwarding to send logs about the status of ESM tech support files to an external logging
platform or to an email address.
You can generate an ESM tech support file from the Settings page. On average, this process takes 10
minutes or fewer.

STEP 1 | From the ESM Console, select Settings.

STEP 2 | Select Generate to start the collection process. The ESM Console deactivates (grays out) the
Generate button during generation process.

STEP 3 | Refresh the page to view the status of the file. When the file is available, the ESM Console
displays the time the file was created and updates the file size in the download link. The ESM
Console reports a failure if it fails to generate the file within the preconfigured timeout period
(25 minutes).
You can also monitor logs related to ESM tech support file generation on the Monitor > ESM > Logs
page. From there, you can filter the Report Type by Tech Support File Status, or filter the Message by a
specific job ID.

STEP 4 | Click Download to save the file and then send it to Technical Support, as needed. To view the
history of all available ESM tech support file requests, select Monitor > Data Retrieval page.
From there, you can download previous files or delete them as needed. If the tech support file
failed to generate, the Download button is hidden and you can only Delete the request.

322 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

Database (DB) Configuration Tool
The DB Configuration Tool is a command-line interface that provides an alternative to managing basic
server settings using the ESM Console. You can access the DB Configuration Tool using a Microsoft MS-
DOS command prompt run as an administrator. The DB Configuration Tool is located in the Server folder of
the Endpoint Security Manager (ESM) Server.
Use the DB Configuration Tool to perform the following functions:
Access the Database Configuration Tool on page 323
Configure Administrative Access to the ESM Console Using the DB Configuration Tool on page 324
Configure ESM Server Settings Using the DB Configuration Tool on page 325
Customizable ESM Server Settings on page 326
Change the Ninja-Mode Password on page 98
Enable Log Forwarding to an External Logging Platform Using the DB Configuration Tool on page 253

Access the Database Configuration Tool

Run the DB Configuration Tool from the Server folder on an ESM Server to view syntax and usage
examples.

All commands run using the DB Configuration Tool are case sensitive.

STEP 1 | Open a command prompt as an administrator:

Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server

STEP 3 | View usage and options for the DB Configuration Tool:

c:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig
Usage:
> DBConfig.exe importLicense [1]
Add a new license to the database.
1) CyveraLicense.xml full path
> DBConfig.exe [1] [2] [3]
Write a configuration to the database.
1) Configuration Type (Server, Reflector, UserManagement, Reporting)
2) Key Name
3) Value
> DBConfig.exe [1] show
Show the values of a specific configuration.
1) Configuration Type (Server, Reflector, UserManagement, Reporting)
Examples:

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 323

 > DBConfig.exe importLicense c:\Foldername\CyveraLicense.xml
> DBConfig.exe server inventoryinterval 200
> DBConfig.exe server show

Configure Administrative Access to the ESM Console Using the

DB Configuration Tool
When you install the ESM Console, you specify the administrative account and type of authentication
(machine or domain) that you will use for initial access to the ESM Console. From the ESM Console, you can
then configure role-based access control to define Administrative Roles to assign to Administrative Users
(and/or groups). This enables you to enforce the separation of information among functional or regional
areas of your organization to protect the privacy of data on the ESM Console. For more information, see
Manage Administrator Access to the ESM Console.
If after setting up role-based access you have difficulty accessing the ESM Console and need to verify
or change administrative account settings, you can use a command line interface (CLI) called the DB
Configuration Tool. This allows you to manage basic ESM Console settings including the administrative
users that have access to the ESM Console, and the authentication mode by which to authenticate them.
The DB Configuration Tool does not validate or authenticate the users and only provides a mechanism for
making changes when you cannot do so using the ESM Console.

To enforce role-based access control, use the ESM Console to make changes to
administrative access, when possible.

You can access the DB Configuration Tool using a Microsoft MS-DOS command prompt that you run as an
administrator. The DB Configuration Tool is located in the Server folder on the ESM Server.

All commands you run using the DB Configuration Tool are case sensitive.

STEP 1 | Open a command prompt as an administrator in either of two ways:

Select Start > All Programs > Accessories, right-click Command prompt, and then select Run as
administrator.
Select Start and, in the Start Search box, type cmd but do not press Enter, yet. Then, to open the
command prompt as an administrator, press Ctrl+Shift+Enter.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server

STEP 3 | (Optional) View the existing administrator settings:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig usermanagement show
AuthMode = Machine
AllowedUsers = Administrator
AllowedGroups =

STEP 4 | (Optional) Specify the authentication mode: either domain or machine.

324 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 C:\Program Files\Palo Alto Networks\Endpoint Security Manager
\Server> dbconfig usermanagement AuthMode [domain|machine]

STEP 5 | (Optional) Add an administrative user.

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig usermanagement AllowedUsers <newuser>

Repeat this step to add additional administrative users. The DB Configuration Tool appends the
usernames to the existing list of administrative users.

To remove administrative users, you must use the ESM Console.

Configure ESM Server Settings Using the DB Configuration Tool

The DB Configuration Tool is a command-line interface (CLI) that provides an alternative to managing basic
server settings through the ESM Console. Examples of settings that you can change include the ninja mode
password, active directory caching, and number of logs included in the ESM Tech Support file. For the full
list, see Customizable ESM Server Settings.
You can access the DB Configuration Tool using a Microsoft MS-DOS command prompt that you run as an
administrator. The DB Configuration Tool is located in the Server folder on the ESM Server.

All commands you run using the DB Configuration Tool are case sensitive.

STEP 1 | Open a command prompt as an administrator in either of two ways:

Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start and, in the Start Search box, type cmd but do not press Enter, yet. Then, to open the CLI
command window as an administrator, press Ctrl+Shift+Enter.

STEP 2 | Navigate to the folder that contains the DB Configuration Tool:

C:\Users\Administrator> cd C:\Program Files\Palo Alto Networks\Endpoint

Security Manager\Server

STEP 3 | View the existing server settings:

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server show
PreventionsDestFolder =
InventoryInterval = 284
HeartBeatGracePeriod = 4200
NinjaModePassword = Password2
BitsUrl = http://CYVERASERVER:80/BitsUploads
MaxActions = 1000
BitsUploadTimeoutInterval = 360
BitsUploadTimeout = 720
KeepAliveTimeout = 0
ExternalAddress =

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 325

 VdiHeartbeatGracePeriod = 25
UseDnsForAddressResolution = True
TaskTimeout = 30
SqlDateTimeFormat = yyyy-MM-dd HH:mm:ss
TaskOverrideInMinutes = 30
EnableStatistics = True
ActiveDirectoryPathUpdateInterval = 1440
ActiveDirectoryGroupsUpdateInterval = 1440
EnableADCaching = True
ContentVersion = 6-472
ContentUpdateTimeoutMinutes = 30
SupportFileCollectionTimeout = 10
SupportFileAggregationTimeout = 20
MaxCollectedIisLogs = 100
MaxCollectedNlogLogs = 1000
MaxCollectedDbRows = 100000
UseContentProductionKey = True

STEP 4 | (Optional) Configure or change any of the ESM Server settings, as needed. For usage guidelines
and default values, see Customizable ESM Server Settings. For example, to specify the
allowable grace period, in seconds, for an endpoint that is not responding (range is 300 to
86,400; default is 4200):

C:\Program Files\Palo Alto Networks\Endpoint Security Manager

\Server> dbconfig server HeartBeatGracePeriod <value>

For example, a value of 300 means that if the ESM Server does not receive any communication from the
endpoint within five minutes (300 seconds), the Endpoint Security Manager reports the endpoint status
as disconnected.

Customizable ESM Server Settings

The following table lists the settings that you can configure for the ESM Server.

Setting Description Default

PreventionsDestFolder = Legacy upload network location (required N/A

<folder> for Traps 3.1 and earlier agents).

InventoryInterval = Frequency at which Traps sends the list 284;

<hours> of applications running on the endpoint to
range 1 to 14400
the ESM Server.

HeartBeatGracePeriod = Period of no communication between 4200;

<seconds> the Traps agent and the ESM Server
range is 300 to
after which, the Endpoint Security
86400
Manager reports the endpoint status as
disconnected.

NinjaModePassword = Password required to access Password2

<password> configuration settings that are available in
ninja mode on the ESM Console.

326 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

Setting Description Default

BitsUrl = <url> URL of the BITS server to which the N/A

agent uploads forensic data, for example
http://ESMSERVER:80/BitsUploads.

MaxActions = Maximum number of actions the ESM 1000;

<totalnumber> Server can send in a single call to an
range is 1 to
agent.
2147483647

BitsUploadTimeoutInterval Interval at which the Traps agent retries 360;

= <minutes> to upload data to the BITS server.
range is 1 to 2000

BitsUploadTimeout = Period after which the Traps agent 720;

<minutes> stops trying to upload data to the BITS
range is 1 to 2000
folder. After this period, the upload state
changes from in progress to failed.

KeepAliveTimeout = Interval at which the ESM Server sends 0;

<seconds> keep-alive messages to the SIEM. A value
range is 0 to
of 0 indicates the ESM Server will not
2147483647
send messages.

ExternalAddress = <url> Changes the URL of the external BITS N/A

server address for the specific ESM
Server on which you run the command.
This field is used in deployments with
multiple ESM Servers.

VdiHeartbeatGracePeriod = Period after which the ESM Console 25;

<minutes> detaches a license for a disconnected VDI
range is 1 to 120
session to free it up for reuse.

UseDnsForAddressResolution Use DNS for address resolution if the True

= [True | False] agent does not send the address.

TaskTimeout = <minutes> The period of time at which the status 30;

of a scheduled task changes from in
range is 0 to
progress to failed.
2147483647

SqlDateTimeFormat Not used. N/A

TaskOverrideInMinutes = The period of time at which the status 30

<minutes> of a scheduled buffer processing task
changes from in progress to failed.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 327

 Setting Description Default

EnableStatistics = [True Enables tracking of real-time performance True

| False] counters between the agent, ESM Server,
and WildFire. To view the statistics of
communication requests that succeed
or fail, use the Windows Performance
console (perfmon) and output that data to
a file.

Interval at which the ESM Server updates

ActiveDirectoryPathUpdateInterval 1440
= <minutes> the Active Directory machine path.

Interval at which the ESM Server updates

ActiveDirectoryGroupsUpdateInterval 1440
= <minutes> the Active Directory group members.

EnableADCaching = [True | Enable Active Directory caching. When True

False] this is set to False, the ESM Console
queries Active Directory on every agent
heartbeat for every Active Directory
target object.

ContentVersion = Reserved for internal use. N/A

<version>

ContentUpdateTimeoutMinutes The period of time after which a content 30

= <minutes> update reports an error if installation fails.

The period of time in which the ESM

SupportFileCollectionTimeout 10
= <minutes> Console must finish collecting logs for the
ESM Tech Support file.

The period of time in which the ESM

SupportFileAggregationTimeout 20
= <minutes> Console must finish aggregating logs
for the ESM Tech Support file. After
this period, the status changes from in
progress to failed.

MaxCollectedIisLogs = The maximum number of collected IIS 100

<iislogs> logs the ESM Console collects when
creating the ESM Tech Support file.

MaxCollectedNlogLogs = The maximum number of collected server 1000

<nlogs> logs the ESM Console collects when
creating the ESM Tech Support file.

MaxCollectedDbRows = The maximum number of database 100000

<dbrows> records the ESM Console collects when
creating the ESM Tech Support file.

UseContentProductionKey = When set to True, the ESM Console uses True

[True | False] only production content packages.

328 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

Cytool
Cytool is a command-line interface that is integrated into Traps that enables you to query and manage
basic functions of Traps. Changes made using Cytool are active until Traps receives the next heartbeat
communication from the ESM Server.
You can access the Cytool using a Microsoft MS-DOS command prompt run as an administrator. Cytool is
located in the Traps folder on the Endpoint.
Use Cytool to perform the following functions on Windows endpoints:
Access Cytool
View Processes Currently Protected by Traps Using Cytool
Manage Protection Settings on the Endpoint Using Cytool
Manage Traps Drivers and Services on the Endpoint Using Cytool
View and Compare Security Policies on an Endpoint Using Cytool
Manage Logging of Traps Components Using Cytool
Restore a Quarantined File Using Cytool
View Statistics for a Protected Process Using Cytool
View Details About the Traps Local Analysis Module Using Cytool
View Hash Details About a File Using Cytool
Use Cytool to perform the following functions on Mac endpoints:
Access Cytool
View Processes Currently Protected by Traps Using Cytool
Connect or Disconnect from an ESM Server Using Cytool
Manage Traps Drivers and Services on the Endpoint Using Cytool
View Information about the Database
Manage Logging of Traps Components Using Cytool
Wake Up Traps from an OS Incompatibility State
Manage Memory Dumps

Access Cytool
To view syntax and usage examples for Cytool commands, use the /? option after any command.

STEP 1 | Open a command prompt (on Windows) or Terminal (on Mac) as an administrator:
Windows:
Select Start > All Programs > Accessories. Right-click Command prompt, and then select Run as
administrator.
Select Start. In the Start Search box, type cmd. Then, to open the command prompt as an
administrator, press CTRL+SHIFT+ENTER.
Mac:
From Finder, select Applications > Utilities. Double-click Terminal.

STEP 2 | Navigate to the folder that contains Cytool:

Windows:

C:\Users\Administrator> cd C:\Program Files\Palo Alto Networks\Traps

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 329

 Mac:

PANM2637HQ:~ jdoe$ cd /Library/Application\ Support/PaloAltoNetworks/Traps/

bin

STEP 3 | View usage and options for the cytool command:

Windows:

c:\Program Files\Palo Alto Networks\Traps> cytool

Traps (R) supervisor tool 4.0
(c) Palo Alto Networks, Inc. All rights reserved
Usage: CYTOOL [/?] [/a] [command [options]]
Options:
/? Display this help message.
/a Authenticate as supervisor.
command enum | protect | startup | runtime | policy | log |
quarantine
| stat | tla | info | image | wf
For more information on a specific command run
CYTOOL command /?

Mac:

On Mac endpoints, you must run the command as a superuser (sudo) and supply the
administrator password.

PANM2637HQ:bin jdoe$ sudo ./cytool

Usage: cytool <options>
cytool - Support tool

Options:
-h --help Display help
information.
enum List processes protected
by Traps.
rpc <enable | disable> <process_name | all> Enable/Disable RPC
services for daemon(s) and agent(s).
esm <connect | disconnect> [address=hostname:port] Connect/Disconnect Traps
to/from ESM.
startup query List startup status for
traps endpoint agent(s) and daemon(s).
startup <enable | disable> <process_name | all> Enable/Disable agent(s)
and daemon(s) after reboot.
runtime query List runtime status for
agent(s), daemon(s) and kernel extensions.
runtime <start | stop> <process_name | all> Start/Stop agent(s),
daemon(s) and kernel extensions immediately.
persist list Display list of
persistent databases.
persist export <db_name | all> Export database(s) to
the file(s) in JSON format.
persist import <db_name> <file_name> Import data into the
database from the given file.
persist print <db_name | all> [csv] Print database to the
command prompt.
log <log_level> <process_name | all> Set log level for the
desired process.

330 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 wakeup Wake up from OS
incompatibility state.
dump <enable | disable | restore> Enable/Disable dump
generation or restore policy settings.

View the Status of the Agent Using Cytool

To view information about the status of the Traps agent on Windows endpoints, use the cytool info
command.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view the Traps agent version:

C:\Program Files\Palo Alto Networks\Traps> cytool info

Traps (R) supervisor tool 4.0.0.24100
(c) Palo Alto Networks, Inc. All rights reserved

General Traps information

USAGE: cytool info query

STEP 3 | For more detailed information on the Traps version and status of the agent, use the cytool
info query command.

C:\Program Files\Palo Alto Networks\Traps>cytool info query

Content Type: 0
Content Build: 0
Content Version: 13
Event Log: 0
Enable Gui: 1
Notifications: 1
Heartbeat Interval: 60 Minutes
Quarantine Quota: 1048576 KB
Send Heartbeat: 1 Minutes
Report Interval: 0 Minutes
Quota: 5120 MB

View Processes Currently Protected by Traps Using Cytool

To view processes that Traps is currently injected into, run the enum command using Cytool or view the
Protection tab on the Traps Console (see View Processes Currently Protected by Traps Using Cytool). On
Windows endpoints, the Traps Console and Cytool display only the processes run by the current user. To
view processes run by all users and processes initiated by the operating system, specify the /a option. This
option is not required on Mac endpoints.
Viewing protected processes run by all users requires you to enter the supervisor (uninstall) password.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | View processes initiated by the current user by entering the cytool enum command. To view
processes for all users including those initiated by the operating system, specify the /a option,
and enter the supervisor password when prompted.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 331

 Windows:

c:\Program Files\Palo Alto Networks\Traps>cytool /a enum

Enter supervisor password:
Process ID Agent Version
1000 3.1.1546
1468 3.1.1546
452 3.1.1546
[...]

Mac:

You must enable remote process calls (RPCs) before you can run this command. See
Enable or Disable RPC Services.

PANM2637HQ:bin jdoe$ sudo ./cytool enum

List of protected processes:
Process name Process ID
User
Google Chrome Helper 5469
jdoe
Google Chrome Helper 5473
jdoe
Google Chrome Helper 5491
jdoe
Photos 5599
jdoe
com.apple.SafariServices 5763
jdoe
com.apple.WebKit.WebContent 5783
jdoe

Manage Protection Settings on the Endpoint Using Cytool

By default, Traps protects core processes, registry keys, Traps files, and Traps services according to the
service protection rules defined in the security policy (for information about configuring service protection
rules in the Endpoint Security Manager, see Manage Service Protection on page 209). You can use Cytool
to override the security rules and manage the following layers of protection that Traps applies on the
endpoint:
Enable or Disable Core Process Protection on the Endpoint on page 332
Enable or Disable Registry Protection Settings on the Endpoint on page 333
Enable or Disable Traps File Protection Settings on the Endpoint on page 334
Enable or Disable Service Protection Settings on the Endpoint on page 334
Use the Security Policy to Manage Service Protection on page 335

Enable or Disable Core Process Protection on the Endpoint

By default, Traps protects core processes including Cyserver.exe and CyveraService.exe based on the
service protection rules defined in the local security policy. If required, you can override the behavior of
core process protection using the cytool protect [enable|disable] process command.
Changing the protection settings requires you to enter the supervisor (uninstall password).

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

332 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

STEP 2 | To manage the protection settings of core processes on the endpoint, use the following
command:

C:\Program Files\Palo Alto Networks\Traps> cytool protect [enable|disable]

process

The following example displays output for enabling protection of core processes. The Mode column
displays the revised protection status, either Enabled or Disabled, or Policy when using the
settings in the local security policy to protect core processes.

C:\Program Files\Palo Alto Networks\Traps>cytool protect enable process

Enter supervisor password:
Protection Mode State
Process Enabled Enabled
Registry Policy Disabled
File Policy Disabled
Service Policy Disabled

To use the default policy rule settings to protect core processes on the endpoint, see Use the Security
Policy to Manage Service Protection.

Enable or Disable Registry Protection Settings on the Endpoint

To prevent attackers from tampering with the Traps registry keys, use the cytool protect enable
registry command to restrict access to the registry keys stored in HKLM\SYSTEM\Cyvera. To disable
protection of the registry keys, use the cytool protect disable registry command.
Making changes to the registry protection settings requires you to enter the supervisor (uninstall) password
when prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To manage the protection settings of registry keys on the endpoint, use the following
command:

C:\Program Files\Palo Alto Networks\Traps>cytool protect [enable|disable]

registry

The following example displays output for enabling protection of registry keys. The Mode column
displays the revised protection status, either Enabled or Disabled, or Policy when using the
settings in the local security policy to protect registry keys.

C:\Program Files\Palo Alto Networks\Traps>cytool protect enable registry

Enter supervisor password:
Protection Mode State
Process Policy Disabled
Registry Enabled Enabled
File Policy Disabled
Service Policy Disabled

To use the settings in the local security policy to protect registry keys on the endpoint, see Use the
Security Policy to Manage Service Protection.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 333

Enable or Disable Traps File Protection Settings on the Endpoint
To prevent attackers from tampering with the Traps files, use the cytool protect enable
file command to restrict access to the system files stored in %Program Files%\Palo Alto
Networks\Traps and %ProgramData%\Cyvera (or C:\ Documents and Settings\All Users
\Application Data\Cyvera on Windows XP). To disable protection of Traps files, use the cytool
protect disable file command.
Making changes to the Traps file protection settings requires you to enter the supervisor (uninstall)
password when prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To manage the protection settings of Traps files on the endpoint, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool protect [enable|disable]

file

The following example displays output for enabling protection of files. The Mode column displays the
revised protection status, either Enabled or Disabled, or Policy when using the settings in the local
security policy to protect Traps files.

C:\Program Files\Palo Alto Networks\Traps>cytool protect enable file

Enter supervisor password:
Protection Mode State
Process Policy Disabled
Registry Policy Disabled
File Enabled Enabled
Service Policy Disabled

To use the default policy rule settings to protect Traps files on the endpoint, see Use the Security Policy
to Manage Service Protection.

Enable or Disable Service Protection Settings on the Endpoint

To bypass the Traps security policy, attackers can attempt to disable or change the status of Traps services.
Use the cytool protect enable service command to protect Traps services. To disable protection
of Traps services, use the cytool protect disable service command.
Making changes to the service protection settings requires you to enter the supervisor (uninstall) password
when prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To manage the protection settings of Traps services on the endpoint, use the following
command:

C:\Program Files\Palo Alto Networks\Traps> cytool protect [enable|disable]

service

The following example displays output for enabling protection of services. The Mode column displays the
revised protection status, either Enabled or Disabled, or Policy when Traps uses the settings in the
local security policy to protect Traps services.

334 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 C:\Program Files\Palo Alto Networks\Traps> cytool protect enable service
Enter supervisor password:
Protection Mode State
Process Policy Disabled
Registry Policy Disabled
File Policy Disabled
Service Enabled Enabled

To use the default policy rule settings to protect Traps services on the endpoint, see Use the Security
Policy to Manage Service Protection.

Use the Security Policy to Manage Service Protection

After changing protection settings using Cytool, you can restore the default security policy at any time using
the cytool protect policy <feature> command.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To use the rules in the security policy to manage service protection, use the following
command:

C:\Program Files\Palo Alto Networks\Traps>cytool protect policy <feature>

where <feature> is either process, registry, file, or service.

The following example displays output for managing the protection on Traps files using the local security
policy. The Mode column displays the revised protection status as Policy.

C:\Program Files\Palo Alto Networks\Traps> cytool protect policy <feature>

Enter supervisor password:
Protection Mode State
Process Enabled Enabled
Registry Enabled Enabled
File Policy Disabled
Service Enabled Enabled

Manage Traps Drivers and Services on the Endpoint Using Cytool

When an endpoint boots, Traps starts drivers (Cyverak, Cyvrmtgn, and Cyvrfsfd) and services (Cyvera and
CyveraService) by default. You can use Cytool to override the default behavior and manage the startup or
current status of drivers and services on a global or individual basis. Changes to the default startup behavior
take effect when the endpoint restarts. Changes to the runtime behavior take immediate effect.
View Traps Startup Components on the Endpoint
Enable or Disable the Startup of Traps Components on the Endpoint
View Traps Runtime Components on the Endpoint
Start or Stop Traps Runtime Components on the Endpoint
Enable or Disable RPC Services (Mac endpoints only)

View Traps Startup Components on the Endpoint

Use the cytool startup query command to view the status of startup components on the endpoint.
When a service or driver is disabled, Cytool displays the component as Disabled. When a driver is

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 335

 enabled, Cytool displays the component as System. When a service is enabled, Cytool displays the
component Startup as Automatic.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view the current startup behavior of Traps drivers and services, use the following command:
Windows:

C:\Program Files\Palo Alto Networks\Traps>cytool startup query

Service Startup
cyverak System
cyvrmtgn System
cyvrfsfd System
cyserver Automatic
CyveraService Automatic

Mac:

PANM2637HQ:bin jdoe$ sudo ./cytool startup query

Password:
Process name Startup status
traps_agent Enabled
trapsd Enabled
authorized Enabled
pmd Enabled
kproc-ctrl Loaded

Enable or Disable the Startup of Traps Components on the Endpoint

Use the cytool startup [enable|disable] command optionally followed by the component name
to override the default behavior for starting Traps drivers and services on and endpoint.
Making changes to the startup behavior requires you to enter the supervisor password when prompted.

Changes to Traps drivers and services do not take effect until the system restarts.
To make changes to Traps drivers and services that take effect immediately, see
StartorStopTrapsRuntime Components on the Endpoint.

STEP 1 | Open a command prompt or terminal as an administrator and navigate to the Traps folder (see
Access Cytool).

STEP 2 | To change the startup behavior for a specific driver or service, use the cytool startup
command:
Windows:

C:\Program Files\Palo Alto Networks\Traps> cytool startup [enable|disable]

<component>

where <component> is either a driver: cyverak, cyvrmtgn, cyvrfsfd; or a service: cyserver,

CyveraService.

336 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 Alternatively, you can omit <component> from the command to change the startup behavior for all
drivers and services.
The following example displays output for disabling the startup behavior of the cyvrmtgn driver. The
Startup column displays the revised behavior as Disabled.

C:\Program Files\Palo Alto Networks\Traps> cytool startup disable cyvrmtgn

Enter supervisor password:
Service Startup
cyverak System
cyvrmtgn Disabled
cyvrfsfd System
cyserver Automatic
CyveraService Automatic

Mac:

PANM2637HQ:bin jdoe$ sudo ./cytool startup [enable|disable] <component|all>

Where <component> is a process on the Mac endpoint. Alternatively, you can specify all to change
the startup behavior for all startup processes.
The following example displays output for disabling the startup behavior of the trapsd process. The
Startup status column displays the revised behavior as Disabled.

PANM2637HQ:bin jdoe$ sudo ./cytool startup disable trapsd

Process name Startup status
traps_agent Enabled
trapsd Disabled
authorized Enabled
pmd Enabled
kproc-ctrl Loaded

View Traps Runtime Components on the Endpoint

Use the cytool runtime query command to view the status of Traps components on the endpoint.
When a service or driver is active, Cytool displays the state as Running. When a service or driver is not
running, Cytool displays the state as Stopped.

STEP 1 | Open a command prompt (as an administrator) or terminal and navigate to the Traps folder (see
AccessCytool).

STEP 2 | To view the current runtime state of Traps drivers and services, run the cytool runtime
query command:

You must enter the administrative password when prompted.

Windows:

C:\Program Files\Palo Alto Networks\Traps>cytool runtime query

Enter supervisor password:
Service Startup
cyverak Running
cyvrmtgn Running

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 337

 cyvrfsfd Running
cyserver Stopped
CyveraService Running

Mac:

PANM2637HQ:bin jdoe$ sudo ./cytool runtime query

Password:
Name PID User Status Command
traps_agent 358 jdoe Running /Library/Application
Support/PaloAltoNetworks/Traps/bin/traps_agent.app/Contents/MacOS/
traps_agent
trapsd 55 root Running /Library/Application
Support/PaloAltoNetworks/Traps/bin/trapsd
authorized 82 root Running /Library/Application
Support/PaloAltoNetworks/Traps/bin/authorized
pmd 78 root Running /Library/Application
Support/PaloAltoNetworks/Traps/bin/pmd
kproc-ctrl 134 root Loaded
com.paloaltonetworks.driver.kproc-ctrl

Start or Stop Traps Runtime Components on the Endpoint

In situations where the Traps agent cannot reach the ESM Server or you do not have permission to change
the behavior of Traps from the ESM Console but must solve an urgent issue related to Traps drivers
and services, you can use the cytool runtime [start|stop] command to override the default
runtime behavior. The command is useful when you must take immediate action to start or stop all Traps
components or start or stop a specific Traps driver or service.

Changes to the runtime behavior of Traps drivers and services reset when the system
restarts. To make changes to the startup behavior of Traps drivers and services, see Enable
or Disable the Startup of Traps Components on the Endpoint.

Making changes to the runtime behavior requires you to enter the supervisor (uninstall) password when
prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To start or stop a driver or service, use the cytool runtime start <component> command:
Windows:

C:\Program Files\Palo Alto Networks\Traps> cytool

runtime start <component>

where <component> is either a driver: cyverak, cyvrmtgn, cyvrfsfd; or a service: cyserver,

CyveraService.
Alternatively, you can omit <component> from the command to change the runtime behavior for all
drivers and services.
The following example displays output for stopping the cyserver service. The Startup column
displays the revised component status, either Running or Stopped.

C:\Program Files\Palo Alto Networks\Traps> cytool runtime stop cyserver

Enter supervisor password:

338 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 Service Startup
cyverak Running
cyvrmtgn Running
cyvrfsfd Running
cyserver Stopped
CyveraService Running

Enable or Disable RPC Services

On Mac endpoints, you can enable or disable remote procedure calls used by the Traps agent and daemons
using the cytool rpc [enable|disable] <process_name|all> command. RPCs are used by the
Traps agent and daemons to access persistent databases, change log levels, and connect or disconnect from
the ESM Server.

STEP 1 | Open a terminal as an administrator and navigate to the Traps folder (see Access Cytool).

STEP 2 | To enable RPC services for all daemons and the Traps agent, use the cytool rpc enable all
command:

PANM2637HQ:bin jdoe$ sudo ./cytool rpc enable all

Password:

STEP 3 | To enable RPC services for a specific service, use the cytool rpc enable <process_name>
command, for example:

PANM2637HQ:bin jdoe$ sudo ./cytool rpc enable trapsd

Password:

STEP 4 | To disable RPC services for all daemons and the Traps agent, use the cytool rpc disable
all command:

PANM2637HQ:bin jdoe$ sudo ./cytool rpc disable all

Password:

STEP 5 | To disable RPC services for a specific service, use the cytool rpc disable <process_name>
command, for example:

PANM2637HQ:bin jdoe$ sudo ./cytool rpc disable trapsd

Password:

View and Compare Security Policies on an Endpoint Using Cytool

Using Cytool, you can display details about security policies on the Windows endpoint.
View Details About an Active Policy
Compare Policies

View Details About an Active Policy

Use the cytool policy query <process> command to view details about policies associated with a
specific process on Windows endpoints. Specifying the process name displays details about the intended
policy whereas specifying the process ID (PID) displays details about the active policy that is currently

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 339

 applied to the process. The output is helpful when you want to verify that a policy is implemented in the
way you intended to configure it.
To view policy details, you must enter the supervisor (uninstall) password when prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view the active policy for a process, use the following command:

C:\Program Files\Palo Alto Networks\Traps>cytool policy query <process>

where <process> is either the process name or PID. For example, to view details about a policy for
notepad, enter cytool policy query notepad. The following example displays policy details for a
process with PID 1234.

C:\Program Files\Palo Alto Networks\Traps> cytool policy query 1234

Enter supervisor password:
Generic
Enable 0x00000001
SuspendOnce 0x00000001
AdvancedHooks 0x00000001
[...]

Compare Policies
At regular intervals, Traps requests an updated security policy from the ESM Server and stores it in the
system registry on Windows endpoints. When a user starts a process, Traps determines whether or not to
protect the process based on the settings in the security policy.
In troubleshooting scenarios where Traps does not behave as expected, use the cytool policy
compare command to view differences in policies that are applied to processes running on the endpoint.
Using the command, you can compare a policy for a process to the default security policy or compare a
policy for a process to a policy for another process. In both cases, you can specify either the name of the
process or the process ID (PID). Specifying the process name simulates the application of the policy to the
process. Specifying the PID queries the effective policy for the running process. Cytool displays the policy
settings side-by-side and indicates any differences between policies in red.
To compare policies, you must enter the supervisor password when prompted.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | Compare the details of two policies:

To compare the policy to the default policy, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool policy compare <process>

default

where <process> is either the process name or process ID (PID).

The following example displays output for comparing a policy that applies to notepad to the default
policy. Differences between the two policies are shown in red.

340 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 C:\Program Files\Palo Alto Networks\Traps>cytool policy compare notepad
default
Enter supervisor password:
Generic
Enable 0x00000001 0x00000001
SuspendOnce 0x00000001 0x00000001
AdvancedHooks 0x00000001 0x00000001
[...]
DllSec
Enable 0x00000001 0x00000000
Optimize 0x00000001 0x000000011
[...]
To compare the policies for two processes, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool policy

compare <process1> <process2>

where <process1> and <process2> are either the process name or process ID (PID). For example,
to compare the policy applied to iexplorer to the policy applied to chrome, enter cytool policy
compare iexplorer chrome. You can also compare the policies for two PIDs or compare the
policy of a process to a policy of a PID.
The following example displays output for comparing the policies applied to two PIDs, 1592 and
1000. Differences between the two policies are shown in red.

C:\Program Files\Palo Alto Networks\Traps> cytool policy compare 1592 1000

Enter supervisor password:
Generic
Enable 0x00000001 0x00000001
SuspendOnce 0x00000001 0x00000001
AdvancedHooks 0x00000001 0x00000001
[...]
DllSec
Enable 0x00000001 0x00000000
Optimize 0x00000001 0x000000011
[...]

Manage Logging of Traps Components Using Cytool

Using cytool, you can start, stop, or flush the logging of Traps drivers and services. This enables you to
troubleshoot one or more components and log errors, warnings, or information to a log file which you
can then view using the Windows Event Viewer. You can also specify the maximum file size of the log, in
MB. On Windows endpoints, Cytool outputs the ETL trace logs to the C:\Program Files\Palo Alto
Networks\Traps\ folder. On Mac endpoints running OS X 10.10 and OSX 10.11, Cytool outputs the logs
to the /var/log/traps. On Mac endpoints running macOS 10.12, you can view logs from the Console
application. You can also enable logging of one or all processes on Mac endpoints.

STEP 1 | Open a command prompt or terminal as an administrator and navigate to the Traps folder (see
Access Cytool).

STEP 2 | To start logging a Traps component, use the cytool log start command:
Windows:

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 341

 C:\Program Files\Palo Alto Networks\Traps> cytool log start <components>
[None | Critical | Error | Warning | Information | Verbose [log_size]]
<max_log_size>

where <components> is either an * to start logging on all Traps services, or one or more Traps services
encased in quotes and separated by spaces, for example "cyverak cyvrfsfd".
The following example displays output for using cytool to log Errors on the cyverak and cyvrmtgn files to
a log file with a maximum file size of 20 MB.

C:\Program Files\Palo Alto Networks\Traps> cytool log start "cyverak

cyvrmtgn" Error 20
Log session started.

Mac:

PANM2637HQ:bin jdoe$ sudo ./cytool log <log_level> <process_name | all>

where <log_level> is the integer value of the log level:

1Fatal error. The application terminated. This is the highest priority.
2Critical error. The application cannot continue to run successfully.
3Error. An operation did not complete successfully, but the application as a whole is not affected.
4Warning. An operation completed with an unexpected result.
5Notice. Informational message with a higher priority.
6Info. Informational message, usually denoting the successful completion of an operation.
7Debug. Debugging message.
8Trace. Tracing message. This is the message with the lowest priority.
0Turn off logging.
You can also configure logging for a specific process or specify all to start logging for all processes.

STEP 3 | Stop or flush the active log sessions on Windows endpoints:

To stop logging a Traps component, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool log stop

Log session stopped.
To flush active log sessions to disk, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool log flush

Log session flushed to directory C:\ProgramData\Cyvera\Logs.

Restore a Quarantined File Using Cytool

If a quarantined file turns out not to be malware, you can restore it using the ESM Console or by using
Cytool from a Windows endpoint.
Use the cytool quarantine list command to view details about all quarantined files on the endpoint.
Or, to restore a file to its original location use the cytool quarantine restore <guid> command.
To restore a file to a new location, use the cytool quarantine restore <guid> <filepath>
command.

342 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 To view and restore quarantined details, you must enter the supervisor (uninstall) password when
prompted.

Using Cytool, you can restore a file to any non-network writable file system including NTFS,
ExFAT, FAT32, FAT16, ReFS.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view all files that Traps has quarantined on the endpoint, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool quarantine list

The following example displays output for using cytool to query for all quarantined files.

c:\Program Files\Palo Alto Networks\Traps>cytool quarantine list

Enter supervisor password:
Guid State Date/Time
Path
c92e84c0-1770-40d5-b5b8-544d02381ea6 Quarantined Thursday, August 18, 2016,
14:40:21 PM C:\Malware\malware1.exe

STEP 3 | To restore a quarantined file, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool quarantine restore <guid>

<filepath>

where <guid> is the unique identifier of the file. If you want to restore the executable file to its original
location leave the <filepath> blank. Otherwise, enter the locationincluding the filenameto which
you want to restore the executable file
The following example displays output for using cytool to restore the malware1.exe file to an alternate
location.

C:\Program Files\Palo Alto Networks\Traps> cytool quarantine restore

c92e84c0-1770-40d5-b5b8-544d02381ea6 C:\myfolder\not-malware.exe
Enter supervisor password:
Restored prevention c92e84c0-1770-40d5-b5b8-544d02381ea6 to C:\myfolder\not-
malware.exe

View Statistics for a Protected Process Using Cytool

At any time you can query Traps for injection statistics on a specific protected process that is running on
the endpoint using Cytool. Use the cytool stat <pid> command to view the injection statistics for the
process.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | Identify the process identifier (PID) of the running process for which you want statistics. To
determine which processes are being actively protected, see the Protection tab on the Traps
console.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 343

STEP 3 | To view statistics for a specific process, use the following command:

C:\Program Files\Palo Alto Networks\Traps> cytool stat <pid>

where <pid> is the specific process id.

The following example displays output for using cytool to display statistics about the Chrome process
with PID 4080.

c:\Program Files\Palo Alto Networks\Traps> cytool stat 4080

DllSec Invocations: 0
DllSec Time: 00:00:00.0
G01 Invocations: 0
G01 Time: 00:00:00.0
G01 Thunk 00 Resolution: 0
G01 Thunk 01 Resolution: 0
G01 Thunk 02 Resolution: 0
G01 Thunk 03 Resolution: 0
G01 Thunk 04 Resolution: 0
G01 Thunk 05 Resolution: 0
G01 Thunk 06 Resolution: 0
G01 Thunk 07 Resolution: 0
G01 Thunk 08 Resolution: 0
G01 Thunk 09 Resolution: 0
G01 Thunk 10 Resolution: 0
G01 Thunk 11 Resolution: 0
G01 Thunk 12 Resolution: 0
G01 Thunk 13 Resolution: 0
G01 Thunk 14 Resolution: 0
G01 Thunk 15 Resolution: 0
G01 Stack Walk Resolution: 0
J01 Minimum Stack Depth: 166
J01 Checks: 25
J01 Stack Walk Checks: 0

View Details About the Traps Local Analysis Module Using Cytool
Using Cytool, you can determine the current version of the Traps local analysis module.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view the local analysis version and associated release date, use the following command:

344 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 C:\Program Files\Palo Alto Networks\Traps> cytool tla query
Build: 225
Timestamp: Monday, July 18, 2016, 6:55:34 AM

View Hash Details About a File Using Cytool

Using Cytool, you can identify hash information about files inside of DLLs, drivers, and other portable
executable (PE) files. For each file, Cytool displays the path, file size in bytes, and file hash using SHA256
encoding. If the file is a PE, Cytool also displays information about the target PE inside the file including file
size, architecture type (i386 or x64), platform (for example, Win32 GUI, Win32 Console, or NT native), and
hash value. After you identify the hash associated with the target file, you can manage Hash Control from
the ESM Console or you can add the hash to an SFX whitelist in the database.
Use the cytool image <filepath>\<filename> to identify hash information about a file.

STEP 1 | Open a command prompt as an administrator and navigate to the Traps folder (see Access
Cytool).

STEP 2 | To view hash details about a file, use the cytool image <filepath>\<filename>
command. For example, the following output displays information about iexplorer.exe.

C:\Program Files\Palo Alto Networks\Traps> cytool image C:\Program Files

\Internet Explorer\iexplore.exe
Image Information
Location: C:\Program Files\Internet Explorer\iexplore.exe
Size: 795.20 KB (814280 bytes)
File SHA256:
1130c581e0e88111ec02d09ab4fc1f6d532f762c9339c7d54abaf8f43c796fe5
Architecture: x86-64
Subsystem: Windows GUI
PE Size: 780.00 KB (798720 bytes)
PE SHA256: 79dc738ce785befcc315d004e15f2748ffd967eede830c4f9f0a59a5f6902203

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 345

Troubleshoot Traps Issues
This topic addresses the following issues related to Traps:
Why cant I install Traps? on page 346
Why cant I upgrade or uninstall Traps? on page 346
Why cant Traps connect to the ESM Server? on page 347
How do I fix a Traps server certificate error? on page 349

Why cant I install Traps?

Symptom
Traps Setup reports the following error: Service Traps (CyveraService) failed to start. Verify that you have
sufficient privileges.

Possible Causes
You do not have administrative privileges to start services on the endpoint.
Solution
After each step in the following procedure, verify if you can install Traps. If Traps still reports an error,
proceed to each subsequent step until the issue is resolved.

STEP 1 | Verify that you have administrative rights on the endpoint:

Windows 7: Click Start > Control Panel > User Accounts > Manage User Accounts. On the users tab,
verify that your username is in the Administrators group.
Windows 8: Click Start > Control Panel > User Accounts > Change User Accounts. Verify that your
account appears as an Administrator.
Log in to the endpoint as a valid administrator.

STEP 2 | The service log file contains information, warnings, and errors related to the Traps service. To
further troubleshoot an issue related to the Traps service, open the C:\ProgramData\Cyvera
\Logs\Service.log file in a text editor and review any errors in the log file that occurred at the
time of the event.

By default, the ProgramData folder may be hidden. To view the folder in Windows
Explorer, select Organize > Folder and Search Options > View > Show hidden files
and folders.

STEP 3 | If the problems persists, contact Palo Alto Networks support.

Why cant I upgrade or uninstall Traps?

Symptom

346 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

 Traps Setup reports the following error: Service Traps (CyveraService) failed to start. Verify that you have
sufficient privileges.

Possible Causes
In earlier versions of Traps, the service protection feature prevents you from modifying or tampering with
Traps system files.
Solution

STEP 1 | Create an action rule to disable service protection (see Manage Service Protection on page
209).

STEP 2 | Verify that you can install or uninstall Traps.

STEP 3 | Delete the action rule (see Save Rules on page 129).

STEP 4 | Try to upgrade Traps. To further troubleshoot an issue related to the Traps service, view the
logs to see if Traps reports a specific error:
From the Traps Console, select Open Log File.
From the Traps Console, select Send Support File to send the logs to the ESM Server.
Create an action rule to retrieve the logs from the endpoint (see Manage Data Collected by Traps on
page 198).

STEP 5 | If the problems persists, contact Palo Alto Networks support.

Why cant Traps connect to the ESM Server?

Symptom
Traps cannot communicate with the ESM Server to retrieve the latest security policy and reports a status of
No connection to server!.
Possible Causes
The server or endpoint specifications do not meet the installation and criteria prerequisites.
The Traps service is down on the endpoint.
The Endpoint Security Manager core service is down on the ESM Server.
The endpoint is not connected to the network.
Inbound traffic is not allowed on the port for the ESM Server (default is 2125).
The Windows Firewall is enabled on the ESM Server and prevents the server from communicating with
the client.
The certificate on the endpoint does not match the certificate on the ESM Server (see How do I fix a
Traps server certificate error?)
Solution
After each step in the following procedure, verify if Traps can connect to the ESM Server by selecting
Check In Now. If Traps still cant connect to the server proceed to each subsequent step until the issue is
resolved.

STEP 1 | Verify that the server and endpoint both meet the prerequisites.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 347

 See Prerequisites.

STEP 2 | Verify that the Traps service is running on the endpoint.

1. Open the Services Manager:
Windows XP: From the Start Menu, select Control Panel > Administrative Tools > Services.
Windows Vista and later: From the Start Menu, select Control Panel > System and Security >
Administrative Tools > Services.
2. Locate the Traps service (called CyveraService in older versions of Traps) and verify that the service
status is Started.
3. If the service status is Stopped, double-click the service, then select Start. Click Close.

STEP 3 | Verify that the Endpoint Security Manager core service is running on the ESM Server.
1. Open the Services Manager:
Windows Server 2008: From the Start Menu, select Control Panel > Administrative Tools >
Services.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security >
Administrative Tools > Services.
2. Locate the Endpoint Security Manager core service (called CyveraServer in older versions of the
Endpoint Security Manager) and verify that the service status is Started (Windows Server 2008) or
Running (Windows Server 2012).
3. If the service status is Stopped or Paused, double-click the service, then select Start. Click Close.

STEP 4 | Verify that you can reach the ESM Server from the endpoint.
From the endpoint, open a command prompt and ping the IP address or hostname of the ESM Server. If
the ESM Server is unreachable, examine the network connectivity settings between the devices.

STEP 5 | Verify that you can reach the endpoint from the ESM Server.
From the ESM Server, open a command prompt and ping the IP address or hostname of the endpoint. If
the endpoint is unreachable, examine the network connectivity settings between the devices.

STEP 6 | Verify that the port for the ESM Server is open on the Windows Firewall (default is 2125).
1. To check port access from the endpoint:
1. Open a command prompt as an administrator.
2. Enter the following command to telnet to port 2125 on the ESM Server:

C:\> telnet <esmServerName> 2125

where <esmServerName> is the hostname or IP address of the ESM Server.

2. If you are unable to telnet to port 2125, create an inbound rule to open that port:
1. Open the Windows Firewall advanced settings:
Windows Server 2008: From the Start Menu, select Control Panel > Windows Firewall >
Advanced Settings.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security >
Windows Firewall > Advanced Settings.
2. Select Inbound Rules.
3. Create a new rule to allow Traps to communicate with the Endpoint Security Manager on port
2125 by selecting the New Rule wizard and following the guided instructions.
3. Verify that you can now telnet to port 2125 on the ESM Server from the endpoint.

348 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

STEP 7 | Temporarily disable Windows Firewall.
1. Open the Change Action Center settings:
Windows Server 2008: From the Start Menu, select Control Panel. Double-click Action Center
and select Change Action Center settings.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security.
Double-click Action Center and select Change Action Center settings.
2. Clear the Network firewall option.
3. Click OK.

STEP 8 | Verify that connectivity is restored between Traps and the ESM Server.
From the Traps Console, click Check In Now. If the connectivity is established, the connection status
appears as Successful.

STEP 9 | View the logs to see if Traps reports a specific error:

From the Traps Console, select Open Log File.
From the Traps Console, select Send Support File to send the logs to the ESM Server
Create an action rule to retrieve the logs from the endpoint (see Manage Data Collected by Traps).

STEP 10 | If the problem persists, contact Palo Alto Networks Support.

How do I fix a Traps server certificate error?

Symptom
The following error appears in the services.log on the endpoint:
An error occurred while making the HTTP request to https://<hostname>:2125/CyveraServer/. This could
be due to the fact that the server certificate is not configured properly with HTTP.SYS in the HTTPS case.
This could also be caused by a mismatch of the security binding between the client and the server.
Possible Causes
When installing the ESM Server software, the following certificate configuration settings are available:
No Certificate (No SSL) and External Certificate (SSL). To install Traps, you must select SSL if you selected
External Certificate during the ESM Server software installation or No SSL if you selected No Certificate.
The mismatch in settings causes the error reported to the service.log.
Solution

STEP 1 | Reinstall the Traps software.

Verify the SSL settings for the ESM Server and then reinstall Traps on the endpoint, taking care to select
the appropriate SSL setting during installation (see Install Traps on Windows Endpoints on page 54).

STEP 2 | Verify that the error doesnt appear in the log.

From the Traps Console, select Open Log File, or open the services.log on the endpoint and review any
recent errors. If the server certificate error persists, contact Palo Alto Networks support.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 349

Troubleshoot ESM Console Issues
This topic addresses the following issues related to the Endpoint Security Manager (ESM) Console:
Why cant I log in to the ESM Console? on page 350
Why do I get a server error when launching the ESM Console? on page 351
Why do all endpoints appear as disconnected in the ESM Console? on page 351

Why cant I log in to the ESM Console?

Symptom
The Endpoint Security Manager (ESM) Console displays an error message that the username or password is
invalid.

Possible Causes
The username or password was not entered correctly.
The user specified during the initial installation does not have DB Owner privileges.
The user was not added as an administrator.
The user who installed the server was not a local administrator on the server.
Solution

STEP 1 | Verify that you entered the correct username and password.

STEP 2 | Verify that the user has DB Owner privileges (see Configure the MS-SQL Server Database on
page 45).

STEP 3 | Log in as an administrator and verify that the authentication mode is correct and that the user
account appears on the User Management page. To add an administrative user, see Configure
the Authentication Mode on page 98. Alternatively, you can add the administrator using the
Database Configuration Tool (see Configure Administrative Access to the ESM Console Using
the DB Configuration Tool on page 324).

STEP 4 | If you cannot log in as an administrator, reinstall the Endpoint Security Manager as a local
administrator.

STEP 5 | Restart IIS: Click Start > Run, type IISReset, and then click OK.

350 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

STEP 6 | Verify that you can log in to the ESM Console using the account. If the problems persists,
contact Palo Alto Networks support.

Why do I get a server error when launching the ESM Console?

Symptom
When opening the ESM Console, you receive an error in the browser indicating a Server Error in the /
CyveraManagement or /EndpointSecurityManager Application.

Possible Causes
The server does not meet the prerequisite for .NET Framework 4.0 patched with the KB2468871 update.
Solution
Install .NET Framework 4.0 and the KB2468871 patch.

Why do all endpoints appear as disconnected in the ESM

Console?
Symptom
The Health page of the ESM Console reports that all endpoints are disconnected even when the endpoint
can reach the ESM Server.
Possible Causes
The ESM Server does not meet the prerequisites.
The Endpoint Security Manager Core service stops and must be restarted. This occurs if you wait more
than one hour to install the license key after initially installing the ESM Console software.
Inbound traffic is not allowed on the port associated with the ESM Server (default is 2125).
Solution
After each step in the following procedure, verify if Traps can connect to the ESM Server by selecting
Check In Now. If Traps still cant connect to the server proceed to each subsequent step until the issue is
resolved.

STEP 1 | Verify that the server meets the prerequisites.

See ESM Server Software Requirements.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 351

STEP 2 | Verify that the Traps service is running on the endpoint.
1. Open the Services Manager:
Windows XP: From the Start Menu, select Control Panel > Administrative Tools > Services.
Windows Vista and later: From the Start Menu, select Control Panel > System and Security >
Administrative Tools > Services.
2. Locate the Traps service (called CyveraService in older versions of Traps) and verify that the service
status is Started.
3. If the service status is Stopped, double-click the service, then select Start. Click Close.

STEP 3 | Verify that the Endpoint Security Manager core service is running on the ESM Server.
1. Open the Services Manager:
Windows Server 2008: From the Start Menu, select Control Panel > Administrative Tools >
Services.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security >
Administrative Tools > Services.
2. Locate the Endpoint Security Manager core service (called CyveraServer in older versions of the
Endpoint Security Manager) and verify that the service status is Started (Windows Server 2008) or
Running (Windows Server 2012).
3. If the service status is Stopped or Paused, double-click the service, then select Start. Click Close.

STEP 4 | Verify that the port for the ESM Server is open on the Windows Firewall (default is 2125).
1. To check port access from the endpoint:
1. Open a command prompt as an administrator.
2. Enter the following command to telnet to port 2125 on the ESM Server:

C:\> telnet <esmServerName> 2125

where <esmServerName> is the hostname or IP address of the ESM Server.

2. If you are unable to telnet to port 2125, create an inbound rule to open that port:
1. Open the Windows Firewall advanced settings:
Windows Server 2008: From the Start Menu, select Control Panel > Windows Firewall >
Advanced Settings.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security >
Windows Firewall > Advanced Settings.
2. Select Inbound Rules.
3. Create a new rule to allow Traps to communicate with the Endpoint Security Manager on port
2125 by selecting the New Rule wizard and following the guided instructions.
3. Verify that you can now telnet to port 2125 on the ESM Server from the endpoint.

STEP 5 | Temporarily disable Windows Firewall.

1. Open the Change Action Center settings:
Windows Server 2008: From the Start Menu, select Control Panel. Double-click Action Center
and select Change Action Center settings.
Windows Server 2012: From the Start Menu, select Control Panel > System and Security.
Double-click Action Center and select Change Action Center settings.
2. Deselect the Network firewall option.
3. Click OK.

352 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting

STEP 6 | Verify that connectivity is restored between Traps and the ESM Server.
From the Traps Console, click Check In Now. If the connectivity is established, the connection status
appears as Successful. If the problems persists, contact Palo Alto Networks support.

TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting 353

354 TRAPS ADMINISTRATOR'S GUIDE | Troubleshooting