HX DG V 5.3.0 PDF
HX DG V 5.3.0 PDF
HX DG V 5.3.0 PDF
PART I: Planning 9
PART I: Planning
In this guide, you will see the Endpoint Security server and DMZ server referred to
as an Endpoint Security appliance or HXD appliance, respectively. These terms refer
to the same products.
Using Endpoint Security servers, you can continuously monitor endpoints for advanced
malware and indicators of compromise (IOCs) that routinely bypass signature-based and
defense-in-depth security systems. The Endpoint Security servers and DMZ servers allow
you to:
A single Endpoint Security ecosystem, which includes the Endpoint Security server
and its attached DMZ servers, can support up to 100,000 agents.
Your Endpoint Security (and DMZ) servers must run the same version of Endpoint
Security software. If they use different versions, communication between them will
fail.
You must identify the servers that will be your provisioning servers before you
download and deploy the FireEye Endpoint Security Agent installation software to
your host endpoints. When agent installation software is downloaded, the IP
addresses or DNS names of the provisioning Endpoint Security servers are
identified in the agent download package. See Setting up Provisioning on page 73.
The Central Management platform can be used to upgrade and manage Endpoint Security
(and DMZ) servers. See Integrating Central Management Appliances and Endpoint
Security Servers on page 87 for important details.
Appliance Addressing
Your enterprise can use IP addresses or domain names (DNS) when configuring
hostnames for agent communications with Endpoint Security servers.
l Configure a single DNS address that resolves to the Endpoint Security server and
DMZ server (also known as a split DNS). This option is the most flexible
arrangement. It allows you to move and renumber appliances without reconfiguring
agents and eliminates unnecessary agent connection attempts to unreachable
appliances. However, this solution requires a more complex DNS configuration. It
may be challenging to execute consistently in large networks. See also Designating
CHAPTER 2: System
Requirements
Before you deploy an Endpoint Security server, make sure the following requirements are
met.
This guide does not provide information about appliance throughput, performance,
or capacity. For information on this, see your FireEye representative.
Maximum
Model Supported Endpoint
Type Number of
Number Security Software Versions
Endpoints
Virtual Endpoint Security server performance will vary depending on the hardware
resources you have selected for the appliance.
Virtual servers can be either VMware ESXi or Windows Hyper-V servers. Hyper-V is only
supported for the HX 2502V, HX 4502V, 2500DV, and 4500DV server models.
l Modified virtual machine (VM) configuration that changes the number of CPUs,
amount of memory, number of NICs, or hard drive size.
l Hyper-V cluster storage mode is not supported for use with virtual Endpoint
Security instances.
l Use of checkpoints
l Replication of the VM
l Dynamic Memory1
Disk
Model Type CPU Cores Memory Virtual NICs
Space
l VMware ESXi host version 6.0 or later. Earlier ESXi versions are not supported.
l VMware vSphere Client
l VMware VCenter Server (recommended). When you use vSphere Client to add your
virtual appliances to vCenter Server, the Deploy OVG Template wizard provides an
easy way to enter your activation code. Otherwise, you must type it in the virtual
appliance console, because you cannot paste into this console.
l VMXNET 3 network drivers
l Link aggregation enabled on ESXi host
l Standard virtual switch created for the monitoring ports of the virtual appliances,
and attached to a physical network adapter on the ESXi server.
VMware Limitations
The following VMware features are not supported:
l Virtual SMP
l Update Manager
l Data Protection
l High Availability (HA)
l Storage APIs for Data Protection
l Memory hot add
l Endpoint
l Replication
l Fault Tolerance
l Virtual Volumes
l Offline operational mode
Network Requirements
Connectivity with FireEye's Dynamic Threat Intelligence (DTI) network (one-way or two-
way sharing) is required.
Endpoint Security appliances can download software updates (security content and system
images) from the FireEye Dynamic Threat Intelligence (DTI) network. With a two-way
content license, the appliance can also upload threat intelligence information to the DTI
network. By default, Central Management-managed appliances receive software updates
from the DTI network through the Central Management appliance.
l DNS (UDP/53)
l HTTPS (TCP/443)
Management interface ether1 requires a static IP address or reserved DHCP address and
subnet mask.
l Use DNS names instead of IP addresses in the firewall rules. The firewall rules will
be automatically applied to the correct IP addresses as appropriate for
avupdate.fireeye.com.
FireEye Endpoint Security uses HTTP over port 80 to deliver antivirus (AV) content.
This allows you to use a caching proxy to distribute the contents of your download
across your endpoints. The manifest for the content is signed with a 2048-bit RSA
private key to prevent tampering. If the content is altered, validation of the content
on the endpoint agent will fail and the content is discarded.
Software Requirements
l Endpoint Security version software supported by the server type. See Supported
Appliance Models on page 15.
l Central Management version 8.0.1 or later.
l FireEye Endpoint Security Agents supported by the Endpoint Security software
version. See Endpoint Security Agent and Server Compatibility below.
Operating System
Endpoint Security Agent Minimum Endpoint Security Environments
Version Version
Windows macOS Linux
NOTE: Trellix recommends that you upgrade and deploy your Endpoint Security
server software before you upgrade and deploy your Endpoint Security Agent
software.
Licensing Requirements
The following table shows the licenses that can be installed for Endpoint Security servers.
Server Required?2
Form
License Description
Factors Server DMZ
1 Server
FIREEYE_ Required to register your server and use the All Yes Yes
APPLIANCE product features.
FIREEYE_ Allows your system to receive software image All Yes Yes
SUPPORT updates.
Server Required?2
Form
License Description
Factors Server DMZ
1 Server
1Trellix recommends that you convert dynamic disks to fixed disks to prevent the host
machine from running low on disk space. If the host machine runs low on disk space,
Hyper-V may pause all of the VMs.
VMware ESXi host version 6.0 or later or Windows Hyper-V version 10.0.14393 or
later are required. Earlier versions are not supported, and virtual server installed
using those versions will not function properly. If you are using Endpoint Security
Server version 4.9, then you can use Hyper-V 2019 (version 10.0.17763.1).
Endpoint Security, cloud Endpoint Security, and virtual Endpoint Security (models
HX4500DV and HX4502) appliances are rated up to 100,000 agents. Cloud Endpoint
Security servers have better performance than on-premises Endpoint Security appliances
due to their storage configurations, which are based on SSD volumes that are designed to
deliver guaranteed performance. Virtual Endpoint Security server performance will vary
depending on the hardware resources you have selected for the server.
For information on deploying a virtual server, see Virtual Server Deployment Steps on
page 27.
Prerequisites
l Deployment of an Endpoint Security server using a Windows Hyper-V hypervisor is
supported for Endpoint Security 4.0.2 and later versions. If you are using Endpoint
Security Server version 4.9, then you can use Hyper-V 2019 (version 10.0.17763.1).
Deployment of an Endpoint Security server using a VMware ESXi server is
supported for Endpoint Security 3.5 and later versions.
l Root user account on a VMware ESXi server or a Windows Hyper-V hypervisor
l Familiarity with deploying virtual machines and administering VMware ESXi hosts
or Windows Hyper-V hypervisors
l Requirements in Virtual Appliance Requirements on page 16
Task Instructions
2. Gather license Get license keys from FireEye if the license update service is not
information from enabled. See About Trellix License Keys on page 49.
FireEye.
Task Instructions
5. Install the required Install the FIREEYE_SUPPORT and other licenses (if the license
FireEye licenses. update feature is disabled). See License Keys on page 49.
The license update feature enables your appliance to
automatically download and apply licenses to which you are
contractually entitled. This feature is enabled with the
configuration wizard during the initial configuration and is
fully functional after the configuration wizard is completed.
6. Configure other See the FireEye System Security Guide and the Endpoint Security
system System Administration Guide.
administration
features such as
AAA, SSL certificates,
and SNMP data
access
8. Attach your DMZ See Attaching and Detaching DMZ Servers on page 65.
servers to the virtual
Endpoint Security Your Endpoint Security and DMZ servers must run the
server. same version of Endpoint Security software. If they use
different versions, communication between them will fail.
9. Set up the server See Configuring the Server Address List on page 69.
address list.
10. Identify your Agents earlier than version 20 can only provision against a
provisioning servers. single primary server. Agents version 20 or later can provision
against multiple servers. A virtual server can be used as a
provisioning server.
See Setting up Provisioning on page 73.
11. Obtain the agent If your Endpoint Security server is connected to DTI, the most
installation package. recent Windows, macOS and Linux agent images are
automatically downloaded to the server after the DTI connection
is established.
If your primary server is not connected to DTI or if you need an
older agent image than the ones that have been downloaded,
you will need to manually download the agent image you need.
12. Install the agent See the appropriate version of the Endpoint Security Agent
software on your host Deployment Guide.
endpoints.
A single virtual Endpoint Security ecosystem, which
includes the virtual primary server and any attached
DMZ servers, can support up to 100,000 agents.
Task Instructions
13. Optionally, After you have deployed your Endpoint Security server and
connect your installed the agent software on your endpoints, you can
Endpoint Security integrate the Endpoint Security server with Central Management
server to the Central and Network Security appliances. For more information, see
Management Integration on page 81. Additional information for managing
appliance or to a your Endpoint Security server through the Central Management
Network appliance is provided in the Endpoint Security System
Securityappliance. Administration Guide.
This procedure uses VMware ESXi version 6.0.0 (build 3568940) and vSphere Client
version 6.0.0 (build 3562874) on VMware vCenter Server version 6.0.0 (build
3018524). The navigation instructions and user interface may vary based on your
version of these products.
This procedure covers the required settings for a Trellix virtual server. You can
accept the default values for the other settings, or specify values that are appropriate
for your setup.
The server must be configured to set up its management interface, and to allow access to
the network, change the default administrator password, and so on. For complete
information, see Initial Configuration of Virtual Servers on page 35.
This procedure covers the required settings for a Trellix virtual server. You can
accept the default values for the other settings, or specify values that are appropriate
for your setup.
1. Download the Endpoint Security Hyper-V deployment .zip file from FireEye's
Dynamic Threat Intelligence (DTI) network to a Hyper-V server and extract the files
within it. These zip files have names in the format image-hx-fireeyehx<nnnn>v,
where <nnnn> is the Endpoint Security server model number.
After the file is unzipped, verify that it includes the Virtual Hard Disks and Virtual
Machines folders. If it does not, contact FireEye customer support.
2. Log in to Microsoft's Hyper-V Manager on the Hyper-V server. The Hyper-
V Manager console is displayed.
3. In the Actions list, select Import Virtual Machine to start the import wizard. On the
Before You Begin screen, click Next.
4. On the Locate Folder screen, browse to and select the folder to which you extracted
the .zip file in Step 1. You only need to select the top-level folder. Click Next.
5. On the Select Virtual Machine screen, select the virtual machine model associated
with the .zip file. Click Next.
6. On the Choose Import Type screen, select the option Copy the virtual machine
(create a new unique ID). Click Next.
7. On the Choose Folder for Virtual Machine Files screen, click Next.
8. On the Locate Virtual Hard Disks screen, select the top-level folder into which you
unzipped the Endpoint Security Hyper-V deployment file in Step 1. This should be
the folder that includes the Virtual Hard Disks folder. Then click Next.
9. On the Choose Folders to Store Virtual Hard Disks screen, select the top-level folder
into which you unzipped the Endpoint Security Hyper-V deployment file in Step 1.
This folder should include the Virtual Hard Disks folder. Click Next.
10. On the Connect Network screen, select the virtual switch to use for your virtual
machine. Click Next.
11. On the second Connect Network screen, select a second virtual switch to use for
your virtual machine. Click Next.
12. On the Completing Import Wizard screen, verify the information. If you are
satisfied, click Finish to import the virtual machine. If you need to make changes,
click Previous.
After the machine is imported, it appears on the Hyper-V Manager console.
13. Rename the virtual machine by double-clicking its name in the Hyper-V Manager
console and entering a new name. Click Enter when done.
14. Verify that the virtual machine settings meet the specifications listed in Windows
Hyper-V Requirements on page 17. Highlight the row for the virtual machine in the
Hyper-V Manager console, right-click on the row, and select Settings. If the virtual
machine settings do not meet the documented minimum specifications, contact your
FireEye Customer Support representative.
15. The new virtual machine is turned off by default after it is imported. To turn it on,
highlight the row for the virtual machine in the Hyper-V Manager console, right-
click on the row, and select Start.
16. Connect to the new virtual machine. Highlight its row in the Hyper-V Manager
console, right-clicking on the row and select Connect
The server needs to be configured to set up its management interface, and to allow access
to the network, change the default administrator password, and so on. For complete
information, see Initial Configuration of Virtual Servers on page 35.
password, and initial CLI commands to configure the server. You can then launch the
configuration wizard to complete the setup.
Alternatively, you can skip the set_keys.ps1 PowerShell script and use the configuration
wizard in the console of the server to fully configure the server, including entering the
activation code, changing the admin password, and supplying initial startup commands.
However, the wizard prompts will be different if you first provide settings using the set_
keys.ps1 PowerShell script.
You cannot paste the virtual server activation code in the configuration wizard
prompt in the server console. Instead, the activation code must be manually entered
into the wizard. FireEye recommends that you specify the activation code using the
Properties screen (ESXi appliances) or the set_keys.ps1 PowerShell script (Hyper-
V appliances).
l Specifying Initial Settings Using the VMware ESXi Properties Screen below
l Initial Configuration Using the VMware ESXi Server Console on page 38
l Specifying Initial Settings Using the Windows Hyper-V set_keys.ps1 PowerShell
Script on page 38
l Initial Configuration Using the Windows Hyper-V Server Console on page 41
l Configuration Wizard Steps on page 42
l Enter the activation code for your virtual server. The activation code contains many
characters. The vSphere Client prevents you from pasting the activation code into
the vSphere Client console, and it is easy to make a typing error.
l Reset the password for the admin user, if password authentication will be used to
log into the CLI or Web UI over the network. The password must be changed to a
password that is at least eight characters long.
You can also use this screen to provide commands for configuration settings that the
system will apply during the initial boot. This can be convenient if you have a large
number of virtual servers to deploy, because you can create base sets of commands, and
then customize them for each deployment.
You can use the system virtual bootstrap reset command to reset the
Properties screen values after the virtual server is deployed and running.
Field Description
Activation The code you received in a secure email from Trellix that gives the
Code virtual server its identity and access credentials.
Reset admin A password of at least eight characters. The initial admin password
password must be reset to allow the admin user to log into the CLI or Web UI
over the network unless both of the following are true:
After you have specified these initial settings on the Properties screen, access the virtual
server console and run the configuration wizard to complete the configuration of the
virtual machine. See Initial Configuration Using the VMware ESXi Server Console on the
next page and Configuration Wizard Steps on page 42
To navigate away from the vSphere Client console and return to the vSphere Client
user interface or your local machine, press Ctrl+Alt.
Trellix recommends that you use this PowerShell script to do at least the following:
l Enter the activation code for your virtual server. The activation code contains many
characters. You cannot copy and paste the activation code into the Hyper-V console,
and it is easy to make a typing error.
l Reset the password for the admin user, if password authentication will be used to
log into the CLI or Web UI over the network. The password must be changed to a
password of at least eight characters.
You can also use this script to provide initial commands for configuration settings that the
system will apply during the initial boot. This can be convenient if you have a large
number of virtual servers to deploy, because you can create base sets of commands and
then customize them for each deployment.
To use the set_keys.ps1 PowerShell script:
1. Use Remote Desktop (RDP) to connect to your Hyper-V virtual machine. Make sure
you are logged in as an administrator.
2. Change to the directory on your virtual machine where the Endpoint Security
Hyper-V deployment .zip file was extracted during installation.
3. Open the set_keys.ps1 PowerShell script in the directory using a text editor (such
as Notepad).
Field Description
activation_ The code you received in a secure email from Trellix that gives the
code
virtual server its identity and access credentials.
cli_cmds_ A set of commands that, at a minimum, allow the server to
init
connect to your network. Type the commands in plain-text format
and then paste the encoded string into this field.
Consider using this field for network connectivity only, because
the size of the string could become unwieldy. The string contain
multiple lines.
cli_cmds_ A URL that points to a file on your network (for example,
init_url
http://acme.com/operations/4500V_config.txt). To use this
field, create a text file that includes CLI commands that configure
additional settings in plain-text format, and store the file on an
HTTP server in your network.
The virtual server needs network connectivity (which the
commands in the cli_cmds_init setting can establish) to access
the file referenced in the URL.
reset_ A password of at least eight characters. The initial admin
admin_
password password must be reset to allow the admin user to log into the
CLI or Web UI over the network unless both of the following are
true:
l The CLI commands being executed set an SSH authorized
key for the admin use, which allows the admin to log in
remotely without a password.
l You disable password login using the username admin
disable password command.
6. From the directory on your virtual machine where the Endpoint Security Hyper-V
deployment .zip file was extracted during installation, enter Windows PowerShell.
<drive>:<path> powershell
The script applies the values you specified Step 4 to your virtual server.
8. After the PowerShell script has run, access the virtual server console and run the
configuration wizard to complete the configuration of the virtual machine. See
Initial Configuration Using the Windows Hyper-V Server Console below and
Configuration Wizard Steps on the next page
Press Ctrl+C to exit the configuration wizard. After the management interface is
configured, an administrator can use the configuration jump-start CLI command
to run the wizard again.
Step Response
Admin Enter a new administrator password. The new password must be from 8–
password? 32 characters.
You do not need to supply an updated admin password if you supplied
one on the Properties screen for ESXi virtual servers or in the set_
keys.ps1 PowerShell script for Hyper-V virtual servers.
NOTE—If you have not changed the admin password, do so now or the
administrator will be unable to log in to the server.
Confirm Re-enter the new administrator password, if you supplied one in the
admin previous step.
password?
Enable Enter yes to enable the administrator to log in to the server remotely. Enter
remote no to disable remote access.
access for
‘admin’
user?
Use DHCP Enter yes to use Dynamic Host Configuration Protocol (DHCP) to configure
on ether1 the server IP address and other network parameters. Enter no to manually
interface? configure your IP address and network settings. (If you enter yes, the
zeroconf and static IP addressing steps are skipped.)
Step Response
Primary Enter the IP address for the management interface in A.B.C.D format and
IPv4 enter the network mask, for example: 1.1.1.2/12.
address
and
masklen?
Domain Enter the domain for the management interface; for example: it.acme.com.
name?
Enable Enter yes to enable access to the DTI network. (If you enter no, the next
fenet three steps are skipped.)
service?
Enable Enter yes to enable the licensing service to automatically download your
fenet licenses from the DTI network and install them. (If licenses are
license downloaded and installed successfully, the wizard skips the step that
update prompts for the product license key and the step that prompts for the
service? security-content updates key.)
Sync Enter yes to synchronize the server time with the DTI server time. If you
appliance enabled the licensing service, synchronization prevents a feature from
time with being temporarily unlicensed due to a time gap. The wizard makes three
fenet? attempts to perform this step before it gives up and moves to the next step.
Update Enter yes to download and install your licenses. The wizard makes three
licenses attempts to perform this step before giving up and moving on to the next
from fenet? step.
Enable Enter yes to enable automatic time synchronization with one or more
NTP? Network Time Protocol (NTP) servers.
Enable Enter no if you want to use IPv4 for your Endpoint Security virtual server
IPv6? or enter yes to enable IPv6 for your Endpoint Security virtual server.
Step Response
Browser Support
Use one of the following browsers to access the Endpoint Security Web UI:
Prerequisites
l Before the default Admin user can log in to the appliance Web UI and create other
user accounts, the manufacturing default password (admin) must be changed to a
new password that is 8 to 32 characters long. This step is included in "Initial
Configuration" in the Endpoint Security System Administration Guide.
1. In the appliance Web UI login page, enter the local username and password for this
appliance as provided by your administrator.
l The two-way sharing license provides your appliance with malware intelligence
from the DTI network and shares data about malware analyzed by your appliance.
l The one-way sharing license provides your appliance with malware intelligence, but
no information is submitted to the DTI cloud.
If licenses have expired or will expire within 30 days, warnings are displayed on the
Appliance License Settings page. For details, see Viewing License Notifications Using the
Web UI on page 59.
Automatic License Updates
The license update feature enables the Endpoint Security appliance with basic network
connectivity to automatically download licenses from the DTI network and install them.
This feature provides the following benefits:
You can enable automatic license updates on the Endpoint Security appliance using the
configuration wizard or the CLI.
How It Works
The license update feature, if enabled, downloads and applies licenses to which the
customer is contractually entitled. If an active license for a feature is already installed and
the licensing service downloads an active license for the feature, the installed license is
replaced by the downloaded license only if the downloaded license offers more
functionality or a later expiry date. This process is automatic; however, you can also
explicitly update licenses.
The license update feature will not:
You can synchronize the system time to the DTI server time to prevent a feature from being
temporarily unlicensed due to time differences. This is a one-time synchronization, but it
can be repeated.
When an appliance is managed by the Central Management appliance, the Central
Management appliance acts as a proxy between the managed appliance and the licensing
service. The license update feature must still be enabled on the managed appliance. In
such an integrated environment, the Central Management appliance acts as the DTI server
for the managed appliances, so the licensing service uses the Central Management DTI
network credentials instead of the appliance's credentials.
For more information, see "Enabling Automatic License Updates" in the Endpoint Security
System Administration Guide.
For details about the wizard steps, see Configuration Wizard Steps on page 42.
CLI Method
The following topic describes how to use CLI commands to enable and work with the
license update feature:
l Enabling Automatic License Updates Using the CLI on the next page
Prerequisites
l An established connection between the appliance and the Internet.
l Operator or Admin access to enable the license update feature and download and
install licenses.
l DTI network access to allow the appliance to get updates directly from the
DTI network.
l (Optional) Admin access to synchronize the system clock with the DTI server clock.
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
NOTE: See "Synchronizing the System Clock to DTI Server Time Using the CLI" in
the Endpoint Security System Administration Guide for an option that prevents
potential licensing issues if there is a time gap between the two clocks.
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
2. Update licenses:
hostname (config) # fenet license update
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
2. Download the licenses and replace existing licenses with them if there are conflicts.
The system clearly indicates which licenses were replaced.
hostname (config) # fenet license update force
Examples
l The licensing service replaced an existing license with one that it downloaded:
hostname (config) # fenet license update force
Added license(s) from fenet
LK2-CONTENT_UPDATES-33XX-0X0X-0000-X000-X000-X00X-0XXX-J00
Deleted installed license(s) (superceded by license(s) shown above):
LK2-CONTENT_UPDATES-42XX-44XX-H888-X00X-000R-XX22-XYZ-0
l The licensing service installed a license that did not exist on the appliance:
hostname (config) # fenet license update force
Added license(s) from fenet
LK2-FIREEYE-SUPPORT-000X-XX00-0000-X000-X000-X00X-0XXX-X00X
No license(s) deleted
l All licenses were already installed and did not conflict with downloaded licenses:
hostname (config) # fenet license update force
All licenses fetched from fenet have already been installed
NOTE: Clicking the Enable VPN link in the Description column for an MD_
ACCESS license allows you to connect the appliance to Managed Defense over the
Internet using a secure SSL VPN connection. For details, see the Managed Defense
Quick Start Guide.
Prerequisites
l Admin or Operator access.
l The appliance does not already have the type of license key you are installing.
Prerequisites
l Admin or Operator access
Prerequisites
l Admin or Operator access
To install licenses:
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
NOTE: You can enter the license keys sequentially separated by spaces as
shown above, or enter license install and then press Enter to be prompted
to enter the license keys one at a time.
Prerequisites
l Admin or Operator access
To remove licenses:
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
3. Specify the license ID to remove an individual license. For example, 4 is the license
ID for the Support license shown in the previous example.
hostname (config) # license delete 3hostname (config) # license delete
4
Prerequisites
l Operator or Admin access
l Access to the DTI network
1. If the About tab is not visible, select Appliance Settings from the Admin menu.
2. Click the About tab.
3. Click Health Check on the upper left side.
4. Locate the Dynamic Threat Intelligence Cloud section.
Address :
Username :
User-agent :
Request Session:
Timeout : 30
Retries : 0
Speed Time : 60
Max Time : 14400
Rate Limit :
Speed Limit : 1
Dynamic Threat Intelligence Lockdown:
Enabled : no
Locked : no
Lock After : 5 failed attempts
UPDATES
Enabled Notify Scheduled Last Updated At
------- ------ -------------- ---------------
Security contents: yes no every 2020/12/03
11:40:00
Stats contents : yes none 2020/12/07
06:13:00
Your servers must run the same version of Endpoint Security software. If they use
different versions, communication between them will fail.
The Central Management appliance can be used to upgrade and manage DMZ server,
with the following caveats.
l Indicator updates from the Central Management appliance or from the DTI
(Dynamic Threat Intelligence) Cloud cannot be sent directly to the DMZ server.
Instead, they are acquired from the Central Management appliance or the DTI by the
primary Endpoint Security server and transferred to the DMZ server.
l If you have problems connecting your Central Management appliance to your
DMZ server, consider the firewalls your organization has in place. In some
circumstances, the DMZ server is not accessible to the Central Management
appliance because a firewall is blocking the connection.
Prerequisites
l Admin or fe_services access
The system displays a passphrase that you must use on the primary Endpoint
Security server by the expiration time shown.
For example:
Attach passphrase: $J^N%n@rsZ6F
This passphrase will expire at 2014-11-20 21:29:54 UTC.
If you do not use it in that time, you will need to re-initiate the
listener.
The response includes certification and ping times, which should be the same
for both servers.
3. Verify that the DMZ server is no longer attached to the primary Endpoint Security
server.
l View the ecosystem roles:
hostname (config) # show hx ecosystem
The response no longer includes the information about the DMZ server that
you detached.
For best results, the appliances should be rebooted one right after the other.
After you have performed these steps, it is safe to assign the new IP address to your
Endpoint Security server.
The address order is set by the order in which you add the servers to the
server address list. The first server added is the first one in the list. The
second server added is the second in the list.
l Provisioning Server
HX and HXD Series (Endpoint Security) releases before version 3.0 support the use
of a single provisioning appliance, identified as the primary appliance. HX Series
version 3.0 and later support the use of multiple provisioning appliances for
endpoints running FireEye Endpoint Agent software version 20 or later and a single
provisioning appliance for endpoints running FireEye Endpoint Agent software
version 11 or earlier. FireEye Endpoint Security Agents use provisioning servers to
connect and complete their installation by establishing their cryptographic agent
identity. Any Endpoint Security server, including a DMZ server, can be enabled to
do provisioning. Endpoint Security provisioning servers must be accessible by
agents within your company's network. DMZ provisioning servers must be
accessible inside and outside your company's network.
l Primary Server
If the endpoints in your environment have agent software versions earlier than
version 20 installed, a single Endpoint Security server must be designated as the
primary appliance. This appliance must be accessible within the network by all
agents when they are initially installed on hosts. The primary server manages the
initial provisioning of the agents. You can use either your internal Endpoint Security
server or a DMZ server as your primary server.
Endpoint Security server administrators and operators can add or remove servers on the
server address list.
Prerequisites
l Admin or Operator access
l The Endpoint Security server is physically installed on the network for agent access
5. In the Enter server address of appliance text box on the Server Addresses tab, enter
the hostname or the IP address of the Endpoint Security server, and click Add.
All available servers appear in the list shown in the Enable Provisioning section of
the page.
6. In the Enable Provisioning section, indicate which Endpoint Security server will be
the provisioning server by selecting the Enable Provisioning checkbox in the row
containing the server name or IP address. At least one server must be designated as
a provisioning server. See Designating Provisioning Servers on page 74.
(Optional) If the endpoints in your environment have agent software versions earlier
than version 20 installed, select the Set as primary checkbox in the row containing
the server name or IP address if the added server will be doing provisioning. This
specifies the server as the primary server for your network. Primary servers are used
to provision agents older than version 20. Only a single server can be designated as
a primary server. See Designating Provisioning Servers on page 74.
7. Click Save.
l Removing a Server from the Server Address List Using the Web UI
4. Click Save.
You must identify the servers that will be your provisioning servers before you
download the FireEye Endpoint Security Agent installation software to your host
endpoints. When agent installation software is downloaded, the IP addresses or
DNS names of the provisioning Endpoint Security servers are identified in the agent
download package.
To set up provisioning:
1. Enable provisioning on the servers you might want to use for provisioning. See
Enabling Servers for Provisioning on the next page.
Prerequisites
l Admin or fe_services access
Prerequisites
l Admin or Operator access
The provisioning server address can be a split DNS that resolves differently depending on
whether an agent is operating inside or outside your company’s internal network. When
the agent is inside the network, the DNS resolves to the primary Endpoint Security server;
when the agent is outside the network, the DNS resolves to the DMZ server.
This section covers the following topics:
Prerequisites
l Admin or Operator access
To designate the primary Endpoint Security server as a provisioning server using the
Web UI:
7. If the endpoints in your environment have agent software versions earlier than
version 20 installed, select Set as Primary to designate the DMZ server as the
provisioning server. This will deselect any other server on the Server Addresses tab
as the primary server.
If the endpoints in your environment have agent software version 20 or later
installed, select Enable Provisioning to designate the DMZ server as a provisioning
server.
8. Click Save.
To use the Endpoint Security server CLI to enable provisioning for a DMZ server:
where <dmz-ip> is the IP address of the DMZ server for which you are enabling
provisioning.
3. Save your changes.
hostname (config) # write memory
The server configuration should show an attached DMZ server with provisioning
enabled:
Appliance Role: master
Prerequisites
l Admin or fe_services access
l A split DNS set up to resolve to your internal Endpoint Security server when the
agent is inside the network and to the DMZ server when the agent is outside the
network.
1. Using the Web UI, enable both your primary Endpoint Security server and your
DMZ server for provisioning. See Designating the Endpoint Security Server as a
Provisioning Server Using the Web UI on page 75 and Designating and Enabling a
DMZ Server as a Provisioning Server on page 76.
2. In the Web UI, select Settings on the FireEye menu. The Agent Versions page
appears.
3. Select the Server Addresses tab.
4. Enter the DNS name and click Add.
5. If the endpoints in your environment have agent software versions earlier than
version 20 installed, select Set as Primary to designate the DNS as the provisioning
server. This will deselect any other appliance on the Server Addresses page as the
primary server.
If the endpoints in your environment have agent software version 20 or later
installed, select Enable Provisioning to designate the DNS server as a provisioning
server.
6. Click Save.
l Canceling the Primary Endpoint Security Server as a Provisioning Server Using the
Web UI on the facing page
l Canceling a DMZ Server as a Provisioning Server Using the Web UI on the facing
page
Prerequisites
l Admin or Operator access
To cancel the Endpoint Security server as a provisioning server using the Web UI:
4. Locate the DMZ server in the Enable Provisioning section of the page.
For agents earlier than version 20, locate another server in the list of servers and
select Primary Server to designate it as the provisioning server. This will cancel the
DMZ server as the provisioning server.
For agents version 20 or later, deselect Enable Provisioning to cancel the DMZ
server as a provisioning appliance.
5. Click Save.
l How FireEye Appliance Alerts Become Endpoint Security Alerts and Central
Management Badges on page 83
l Integrating Central Management Appliances and Endpoint Security Servers on
page 87
l Integrating Network Security Appliances and Endpoint Security Servers Directly on
page 99
l SNMP Data on page 101
l Forwarding CEF Logs to Helix and SIEM Solutions on page 109
1. A FireEye appliance triggers an alert for a web infection, malware object, or malware
callback.
2. The FireEye appliance reports the alert to the Central Management appliance.
3. The Central Management appliance determines if an IOC for the Endpoint Security
server should be created and, if so, publishes it.
4. The Endpoint Security server transforms the Central Management indicator into an
Endpoint Security IOC and publishes it for the Endpoint Security agents.
5. The Endpoint Security agents search their hosts for any indicator of compromise. If
a match is found, the agent reports back to the Endpoint Security server. The
Endpoint Security server creates an alert, which is aggregated to the Central
Management appliance if that alert was based upon an IOC from a managed
appliance.
6. The Central Management appliance correlates the Endpoint Security alert with the
managed appliance alerts and creates badges for the appropriate alerts. Network
Security alerts will have an endpoint compromised badge. Email Security — Server
Edition alerts will have a related endpoint badge.
l Not all FireEye appliance alerts provide the kind of data from which an Endpoint
Security indicator can be created.
l Only alerts originating from FireEye appliance IOCs are aggregated to the Central
Management appliance.
l By default, only alerts that are classified as major severity alerts or higher are sent to
the Endpoint Security server, resulting in only high-fidelity endpoint alerts.
Errors result if you attempt to use the Central Management CLI to set up
management of an Endpoint Security server. Use the Web UI only.
If your Endpoint Security server and other FireEye appliances are managed by a Central
Management appliance, the Endpoint Security server automatically receives indicators
from the other FireEye appliances. The Central Management appliance streamlines
management of multiple appliances and enhances detection by correlating indicators. See
How FireEye Appliance Alerts Become Endpoint Security Alerts and Central Management
Badges on page 83.
The Central Management platform can be used to upgrade and manage an Endpoint
Security DMZ server, with the following caveats.
l Indicator updates from the Central Management appliance or from the DTI
(Dynamic Threat Intelligence) Cloud to the DMZ server must be configured
separately. See Configuring a Central Management-Managed DMZ Server to Get
Updates from DTI on page 90. If these steps are not performed, indicator updates are
acquired from the Central Management appliance and the DTI by the Endpoint
Security server and transferred to the DMZ server.
l If you have problems connecting your Central Management appliance to your
DMZ server, consider the firewalls your organization has in place. In some
circumstances, the DMZ server is not accessible to the Central Management
appliance because a firewall is blocking the connection.
Central Management releases earlier than Release 7.6 do not support integration with
Endpoint Security servers. Endpoint Security releases earlier than Release 2.6 do not
support integration with Central Management appliances. If you are running a Central
Management release earlier than Release 7.6, see Integrating Network Security Appliances
and Endpoint Security Servers Directly on page 99.
The configuration of your Endpoint Security server with the Central Management
appliance happens automatically after they are both installed. Use the instructions in this
section to ensure the settings on each appliance are correct.
When you remove a managed appliance from the Central Management platform,
all data (including alert information) associated with the appliance is removed. If
you add the appliance again later, the data is restored, but all alerts generated by
the appliance are assigned new IDs. Because the alerts have new IDs, Endpoint
Security links for alerts will break if the alerts were generated by the appliance
before it was removed from the Central Management platform.
To configure Central Management 7.6 or later and Endpoint Security server integration:
The output from this command lists log file entries that include the CM Series alert
ID.
Mar 16 18:02:51 FireEye_CM notifyd[9696]: tid 5175: [notifyd.INFO]:
[inform_fireeye_hx] processing alert id=5762 infection-id=2291
infection-type=malware-object began at:2017-03-17 01:02:51, finish
at:2017-03-17 01:02:51 time cost:0 micro-seconds sequence-
id=140655883976776
3. Review the log file and choose a CM Series alert ID. The Endpoint Security server
will start collecting CM Series IOC data for this alert ID after the server attaches to
the Central Management appliance.
In Endpoint Security, the CM Series alert ID is called a bookmark.
4. On your Endpoint Security server, enable CLI configuration mode.
hostname > enable
hostname # configure terminal
where <CM-alert ID> is the starting CM Series alert ID you chose earlier in these
steps. The default is 0 (zero), which downloads all of the CM Series alerts to the
Endpoint Security server after the products are integrated.
For more information about Central Management requirements for integration with the
Endpoint Security server, see the Central Management Administration Guide.
Overview
When an Endpoint Security server is managed by a Central Management appliance, the
Central Management appliance sends a notification of the latest Alert ID to the Endpoint
Security server. The Endpoint Security server then polls the Central Management appliance
for the Alert ID and retrieves Indicators Of Compromise (IOC) details for the specified alert.
The Endpoint Security server then updates the Bookmark ID to identify the next Alert ID to
use when polling the Central Management appliance.
A newly manufactured Endpoint Security server has a Bookmark ID equal to zero. When
the Endpoint Security server is attached to the Central Management appliance, the Central
Management appliance will send the latest Alert ID to the Endpoint Security server. The
Endpoint Security server will then poll the Central Management appliance for all the Alert
IDs from zero through to the latest Alert ID. The delta between the Endpoint Security server
Bookmark ID and the Central Management appliance latest Alert ID can be in the
thousands, resulting in a performance impact on the Endpoint Security server as it gathers
all the IOCs.
Replacement scenarios
The following scenarios are explained in detail.
with a large history of alerts: In this scenario, a large delta may accrue for all of the
historic and incoming alerts on the FireEye detection devices.
2. New Central Management appliance, existing Endpoint Security server, existing
Network Security/Email Security — Server Edition/File Protect/Malware Analysis
with a high volume of alerts: In this scenario, a large delta may accrue while the
Central Management appliance is offline with a large influx of alerts.
3. New Central Management appliance, existing Endpoint Security server, existing
Network Security/Email Security — Server Edition/File Protect/Malware Analysis
with a low volume of alerts: The Bookmark ID may be greater than the actual latest
Alert ID which can potentially result in missed alert IOCs.
4. Existing Central Management appliance, New Endpoint Security server, existing
Network Security/Email Security — Server Edition/File Protect/Malware Analysis
with a large history of alerts: A large delta may accrue for all of the historic and
incoming alerts on the FireEye detection devices.
The Central Management appliance will aggregate all of the existing alert data and send
notifications for all of the Alert IDs to the managed Endpoint Security server. The Endpoint
Security server will poll the Central Management appliance for all of the alerts between
zero and the latest Alert ID. This could result in a large delta and could impact the
performance of the Endpoint Security server. The process of the Endpoint Security server
Bookmark ID catching up to the latest Alert ID can take many hours or days depending on
the amount of alert data present on the Central Management appliance. This can result in
a signification delay in the Endpoint Security server receiving the latest, most relevant
IOCs, causing missed malware detection on the endpoints. To prevent this, advance the
Endpoint Security server Bookmark ID to a recent Alert ID (see steps below) before
attaching the Endpoint Security server to the Central Management appliance.
The Central Management appliance will aggregate all of the existing alert data and send
notifications for all of the Alert IDs to the managed Endpoint Security server. The Endpoint
Security server will poll the Central Management appliance for all of the alerts between the
last Bookmark ID and the latest Alert ID. For a high-volume alert environment, this delta
can be large depending upon how long the Central Management appliance is offline and
the rate of alert influx. This could result in a large delta and could impact the performance
of the Endpoint Security server. The process of the Endpoint Security server Bookmark ID
catching up to the latest Alert ID can take several hours depending on the amount of alert
data. This can result in a delay in the Endpoint Security server receiving the latest, most
relevant IOCs.
The Central Management appliance will aggregate all of the existing alert data and send
notifications for all of the Alert IDs to the managed Endpoint Security server. In rare cases,
the Endpoint Security server Bookmark ID could be greater than the latest Central
Management appliance Alert ID. The Endpoint Security server will poll the Central
Management appliance for the larger Bookmark ID and will not receive an IOC from the
Central Management appliance until the Central Management appliance Alert ID
advances to equal the Bookmark ID. This could result in missing IOCs from alerts with
Alert IDs below the Endpoint Security server Bookmark ID, as well as missing malware
detection on the endpoints. You can modify the Endpoint Security server Bookmark ID to
equal a recent Alert ID (see steps below) before attaching the Endpoint Security server to
the Central Management appliance to prevent this.
The Central Management appliance will send notifications for all of the Alert IDs to the
managed Endpoint Security server. The Endpoint Security server will poll the Central
Management appliance for all of the alerts between zero and the latest Alert ID. This could
result in a large delta and could impact the performance of the Endpoint Security server.
The process of the Endpoint Security server Bookmark ID catching up to the latest Alert ID
can take many hours (or days) depending on the amount of alert data present on the
Central Management appliance. This can result in a signification delay in the Endpoint
Security server receiving the latest, most relevant IOCs, causing missed malware detection
on the endpoints. To prevent this, you should advance the Endpoint Security server
Bookmark ID to a recent Alert ID (see steps below) before attaching the Endpoint Security
server to the Central Management appliance.
In the example below, the Endpoint Security server Bookmark ID can be set to '5071' to
receive the latest IOC from the Central Management appliance. However, depending on the
scenario, the Endpoint Security server could have a large delta or could be missing out on
recent IOCs. To get a better Bookmark ID starting point, log into the Central Management
appliance UI, navigate to the Alerts/Alerts page, set the inline filter Date Range to 'Past 1
Week' (or any desired time-frame), and apply the filter. The total number of alerts for this
time-frame can be found in the upper left-hand corner of the alerts display. Subtract this
number from the most recent Alert ID and set the Endpoint Security server Bookmark ID to
this number to gather the past weeks IOCs. For instance, if the Central Management
appliance displays 50 alerts for the selected date range, the Bookmark ID can be set to
'5021'. The Endpoint Security server should be added to the Central Management
appliance. The Endpoint Security server will begin to gather the IOCs from the alerts from
5021 through the current Central Management appliance Alert ID as soon as it receives the
first Alert notification of the most current Alert ID from the Central Management appliance.
Example
dresden # sh log matching \bnotifyd\b.*\bdone_notify_alerts\b
Jul 11 12:51:51 dresden notifyd[28468]: tid 28468: [notifyd.INFO]: SQL:select
* from done_notify_alerts('{5069} ')
Jul 11 12:53:21 dresden notifyd[28468]: tid 28468: [notifyd.INFO]: SQL:select
* from done_notify_alerts('{5070} ')
Jul 11 12:54:22 dresden notifyd[28468]: tid 28468: [notifyd.INFO]: SQL:select
* from done_notify_alerts('{5071} ')
Do not use this procedure if you have already integrated your Endpoint Security
server with a Central Management appliance (see Integrating Central
Management Appliances and Endpoint Security Servers on page 87). Using both
types of integration will cause errors in the Central Management integration.
Alerts can only be sent from Malware Analysis or Email Security — Server
Edition appliance to the Endpoint Security server through a Central Management
appliance. Attempts to send Malware Analysis or Email Security — Server Edition
alerts to the Endpoint Security server using the direct connection set up between a
Network Security appliance and the server will fail. FireEye only provides the
direct connection between Network Security and Endpoint Security. Use the
Central Management appliance connection with the Endpoint Security server for
Malware Analysis and Email Security — Server Edition alerts.
2. Enable FireEye legacy appliance support for the Endpoint Security server:
hostname (config) # hx server detection legacy enable
4. Log in to the Web UI of the Network Security appliance and then click Settings. (On
a Central Management appliance, click CMS Settings).
5. Click Notifications in the left navigation pane.
6. Verify that all HTTP event types are selected for the appliance.
7. Click the http table heading to access HTTP notification configuration fields. These
fields allow you to define the HTTP connection with your Endpoint Security
appliance.
8. Type a name for the Network Security appliance's direct connection to the Endpoint
Security appliance in the Name box and then click Add HTTP Server.
9. Enter the Endpoint Security URL in the Server Url box:
https://<DNS-name-or-Endpoint-Security-IP>/alerts
Retrieving SNMP Data
This section describes how to retrieve SNMP information from the Endpoint Security
appliance.
A Management Information Base (MIB) is a text file written in a specific format in which
all of the manageable features of a device are arranged in a tree. Each branch of the tree
contains a number and a name, and the complete path from the top of the tree down to the
point of interest forms the Object Identifier, or OID. The OID is a string of values separated
by periods, such as .1.3.6.1.2.1.1.3.0.
You can send requests for data on an object using the OID, but it can be simpler to use the
symbolic name for the object instead. A MIB allows SNMP tools to translate the symbolic
names into OIDs before sending the requests to the managed device. Symbolic names for
objects in the Trellix MIB include feSerialNumber.0, feHardwareModel.0,
feProductLicenseActive0, feFanIsHealthy.1, and so on.
The Trellix MIB, named FE-FIREEYE-MIB, needs to be downloaded from the Endpoint
Security appliance to the SNMP manager so it can be loaded into an SNMP browser or
other tool. A typical SNMP browser can retrieve the values the appliance supports, and
then display them in a hierarchy so you can navigate to the value you need to include in
the request.
This section contains the following topics:
Prerequisites
l Operator or Admin access
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
If the output shows SNMP enabled: no, enter the snmp-server enable command.
3. SNMP v3: Specify the SNMP user and password:
hostname (config) # snmp-server user <username> v3 enable
hostname (config) # snmp-server user <username> v3 auth sha <password>
Prerequisites
l Analyst, Operator, or Admin access
7. Load the MIB into an SNMP browser or tool, or open the MIB file:
vi FE-FIREEYE-MIB.txt
1. Copy the MIB file from the appliance using the OpenSSH client:
scp -r admin@<appliance><applianceIPAddress>:/usr/share/snmp/mibs
/usr/<userDirectoryName>
4. Load the MIB into an SNMP browser or tool, or open the MIB file:
vi FE-FIREEYE-MIB.txt
4. Load the MIB into an SNMP browser or tool, or open the MIB file:
vi FE-FIREEYE-MIB.txt
Prerequisites
l Operator or Admin access
l The MIB file must be downloaded. See Downloading the MIB on page 102.
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
If the output shows SNMP enabled: no, enter the snmp-server enable command.
3. Enable the appliance to send notifications to the SNMP manager:
hostname (config) # snmp-server enable notify
5. Enable SNMP communities:
hostname (config) # snmp-server enable communities
where <community> is the string needed by the SNMP server to query the appliance.
The default community string is public.
7. Limit SNMP access to the listen interface called ether1:
hostname (config) # snmp-server listen interface ether1
Examples of basic commands that retrieve SNMP data follow. The commands are entered
from the SNMP manager application. The IP address in the commands is the appliance
IP address.
SNMP v3 commands:
snmpmgr # snmpget -m +FE-FIREEYE-MIB -v 3 -u myname -a MD5 -A mypassword -l
authNoPriv 172.0.0.0 feTemperatureValue.0
snmpmgr # snmpwalk -m +FE-FIREEYE-MIB -v 3 -u myname -a MD5 -A mypassword -l
authNoPriv 172.0.0.0 enterprises.25597
SNMP v2c commands:
snmpmgr # snmpget -m +FE-FIREEYE-MIB -v 2c -c public 172.0.0.0
feSupportLicenseActive.0
snmpmgr # snmpwalk -m +FE-FIREEYE-MIB -v 2c -c public 172.0.0.0 fireeye
snmpmgr # snmpwalk -v 2c -c public 172.0.0.0 enterprises.25597
To retrieve license expiration dates formatted in a table, use a command similar to the
following (different commands are required by different SNMP manager applications):
snmpmgr # snmptable -c public -Of -v 2c localhost feLicenseFeatureTable
Check the number of days in the rightmost column. If the value is less than 30, contact
your system administrator.
Sending Traps
This section describes how to configure basic SNMP support on the Endpoint Security
appliance, enable and configure traps, and set up trap logging. For detailed information
about SNMP commands and options for more advanced configurations, see the Trellix CLI
Command Reference.
Prerequisites
l Operator or Admin access
1. Go to CLI configuration mode:
hostname > enable
hostname # configure terminal
If the output shows SNMP enabled: no, enter the snmp-server enable command.
2. Disable an event:
hostname (config) # no snmp-server notify event <event>
For example, the following command stops a trap from being sent when the
temperature of the appliance is normal:
hostname (config) # no snmp-server notify event normal-temperature
3. Enable an event:
hostname (config) # snmp-server notify event <event>
For example, the following command enables the appliance to send a trap when
there is a change in an interface link:
hostname (config) # snmp-server notify event if-link-change
l You can send common event format (CEF) logs from the Endpoint Security server to
one or more remote SIEMs. This includes hits (referred to as alerts), containment
state events, and triage status. For more information, see Configuring CEF Logging
for Endpoint Events on the next page. For information on the data that is logged, see
"CEF Logs and Output" in the Endpoint Security Server User Guide.
l You can perform two-way communications with SIEM solutions, such as acquiring
triage collections.
l With SIEM solutions, you can execute analyst actions initiated in a URL context.
Specifically, you can:
o Listen for traffic from SIEMs that initiate analyst actions via URL requests.
o Parse the arguments in these requests.
o Format and execute commands.
The integration between the Endpoint Security server and most SIEM solutions can be
accomplished using an external integration connector and an API Analyst user account.
See "Roles for Local User Accounts" in the System Security Guide. For an example of setting
up an integration connector with a SIEM solution, see SIEM Example: Setting Up an
Endpoint Security Integration Connector with ArcSight on page 113.
An integration connector can only be used for communications from the SIEM
solution to the Endpoint Security server, not from the Endpoint Security server to the
SIEM solution.
Similar integration can be accomplished using the Endpoint Security API. See the
Endpoint Security REST API Guide.
Descriptions of the collected CEF log data can be found in "CEF Logs and Output" in the
Endpoint Security Server User Guide.
Prerequisites
l Admin or fe_services access
l To forward CEF logs to Helix, a FireEye Cloud Collector or Comm Broker must be
installed. See the Cloud Collector Installation Guide or the Unmanaged Communications
Broker Installation Guide for details.
In this example, CEF logging is actually disabled because the Override for class
cef setting is not set to info. All CEF logging occurs for messages logged at the
info system log level. If this level is set to anything other than info, CEF logging
will not occur. See Enabling Local CEF Logging on page 113.
Adding a Destination
Define a Cloud Collector or Comm Broker destination to forward CEF log messages to
Helix. Define a remote syslog server destination to integrate Endpoint Security with your
SIEM solution.
To add a destination:
where <IP-address> is the IP address of the Cloud Collector or the remote syslog
server destination.
3. Save your settings:
hostname # write mem
Removing a Destination
To remove a destination:
where <IP-address> is the IP address of the Cloud Collector or the remote syslog
server destination.
3. Save your settings:
hostname # write mem
2. Enable CEF logging:
hostname # logging local override class cef priority info
All CEF logging occurs for messages logged at the info system log level. If you set
this to any other system log level, CEF logging will not occur.
3. Save your settings:
hostname # write mem
2. Disable CEF logging:
hostname # logging local override class cef priority none
This guide refers to ArcSight and its ESM manager or console as examples of SIEM
integration methods and objectives. For example, analysts can use the ArcSight ESM
console's Integration Command menu or rules to automate the process of requesting
acquisitions for a SIEM event. Your ArcSight vendor can provide information about
creating and using ArcSight integration commands. FireEye Support can provide you with
information about using the integration connector with other SIEM solutions.
FireEye supports the use of the ArcSight Smart Connector type 10.0.5. The ArcSight
to Endpoint Security connector port must be 3000 (TCP). The Endpoint Security to
ArcSight syslog port is configurable.
FireEye recommends that you use Java 7 or later with ArcSight and that your Java
class path is updated to point to this Java version. If you use an earlier version of
Java, SSL errors may occur.
Prerequisites
l Administrative permissions to the machine on which you are installing the
integration connector.
l An Endpoint Security Admin or Operator account.
l An Endpoint Security API Analyst account you have created specifically for the
connector.
l A copy of the integration connector installation package
(FireEye\ArcSight\Connector\Install\10.0.5.zip available on SFDC).
l Either of the following types of certificates:
o A self-signed development certificate created using OpenSSL (according to the
procedure described in Creating a Self-Signed Development Certificate).
o A valid certificate that you have purchased from your chosen provider.
The certificate must be in .pem format, and it must match the hostname of the
Endpoint Security server.
1. On a machine on which you have installed OpenSSL, enter the following command:
C:\OpenSSL\bin> openssl req -x509 -nodes -newkey rsa:2048 -keyout
key.pem -out cert.pem -days 3000
2. At the end of each line, enter the appropriate information for your enterprise in the
format indicated. For example:
Country Name (2 letter code) [XX]: US
State or Province Name (full name) []: Virginia
Locality Name (e.g., city) [Default City]: Bristol
Organization Name (e.g., company) [Default Company Ltd]: FireEye
Organizational Unit Name (e.g., section) []: IT
Common Name (e.g., your name or your server's hostname) []: dti-hx-dev
Email Address []: [email protected]
OpenSSL generates two files: a self-signed certificate (named cert.pem) and a key
(named key.pem).
3. Download and save the certificate and key files.
1. On the machine where you are installing the connector, extract the files from the HX
Connector Installer .zip package to a local folder.
2. Copy the certificate and key files that you generated, or the ones supplied by your
chosen provider into the same folder as the installer files.
3. Rename the certificate: certname.pem.
4. Log in to the server Web UI as an administrator.
5. On the Admin menu, select Appliance Settings.
6. Select Certificates on the sidebar. The Certificate Management page appears.
7. On the Certificate Management page, install the certificate:
l To install the self-signed certificate that you created in Creating a Self-Signed
Development Certificate, upload the Certificate and Private Key.
l To install a certificate provided by your chosen provider, upload the
Certificate, Private Key, and CA Certificate.
8. Click Update.
You are logged out of the Endpoint Security server, and the login screen reloads
with the following message:
1 notice
l The Web Server is currently restarting
l Please wait for about 20 seconds and try again
l If this condition persists, please Contact FireEye Support
9. On the machine where you installed the connector, edit the fireeye-
connector.properties file, and enter the appropriate parameters for the Endpoint
Security target:
appliance HX
cert certname.pem
The hostname you enter must match the hostname in the certificate.
If the hostname you enter is not registered in the DNS, then you must connect
the hostname and IP address in your operating system's host file on the
machine where you are installing the connector.
Record the full path of the directory and folder that you use for this
installation. You will need it later. If your enterprise will be using more than
one ArcSight SmartConnector, make sure to choose a unique folder name.
d. Import the certificate, navigate to the certificate file, and then save the
keystore.
15. Return to the ArcSight SmartConnector Configuration Wizard.
16. In the Configuration File box, enter HXFlexConnector, and then click Next.
17. Finish performing the steps in the ArcSight SmartConnector Configuration Wizard,
choosing default settings or customizing for your enterprise's SIEM solution, as
appropriate.
If you want the SmartConnector to run as a service, choose the following options:
l Select Yes to start the service automatically when you restart the server on
which it is running.
l Enter unique names for Service Internal Name and Service Display Name, if
your enterprise will have more than one SmartConnector on the server where
you are installing this Connector.
If you want to run the SmartConnector service before the server restarts, you
must start the service manually.
You can validate the success of the installation by using your SIEM console to view events
or perform other actions, such as requesting a triage collection.
PART V: Appendices
Prerequisites
l Admin or fe_services access
The following snippet represents the quiesce information from the output of this
show command:
Quiesce Mode:
App Proc: enabled
Message Bus: enabled
You can review the complete quiesce mode status of an Endpoint Security server or the
separate quiesce mode status for the server application processor and message bus using
the CLI.
To review the quiesce mode status of an Endpoint Security server:
The following snippet from the output of this command shows that quiesce mode is
enabled for both the application processor and the message bus.
Quiesce Mode:
App Proc: enabled
Message Bus: enabled
The following output from this command displays when quiesce mode enabling is
in process for the application processor:
HX App Proc Configuration:
The following output from this command displays when the application processor
is fully quiesced:
HX App Proc Configuration:
The following output from this command displays when quiesce mode disabling is
in process for the application processor:
HX App Proc Configuration:
The following output from this command displays when the application processor
is not in quiesce mode:
HX App Proc Configuration:
The following sample output from this command shows that quiesce mode is
disabled for the appliance message bus:
HX Message Bus Configuration:
Prerequisites
l Admin or fe_services access
Prefix: <prefix>
Agent CA days: 7300
Agent CA key bits: 2048
Agent cert days: 1825
Server CA days: 7300
Server cert key bits: 2048
Server cert days: 1825
Server CRL days: 30
CA: comms
valid from: <timestamp> to <timestamp>
subject: <subject>
fingerprint: <fingerprint>
CA: distro
valid from: <timestamp> to <timestamp>
subject: <subject>
fingerprint: <fingerprint>
CA: agent
valid from: <timestamp> to <timestamp>
subject: <subject>
fingerprint: <fingerprint>
CRL: comms
issued: <timestamp> and expires on <timestamp>
number: <comms_CRL_number>
fingerprint: <fingerprint>
CRL: distro
issued: <timestamp> and expires on <timestamp>
number: <distro_CRL_number>
fingerprint: <fingerprint>
host: <HX_appliance_hostname>
role: ca
last ping: <timestamp>
Exporting Certificates
You can export Endpoint Security public key infrastructure (PKI) certificates to a file. This
is recommended before you upgrade the Endpoint Security server.
To export Endpoint Security PKI certificates:
For example:
hostname (config) # hx pki export file scp://user@host/path/to/file
passphrase abc123
Importing Certificates
You can import Endpoint Security public key infrastructure (PKI) certificates from a backup
file. If there were any problems upgrading your appliance that required you to reimage it or
to fully reinstall the software, import the Endpoint Security certificates you exported earlier
so you do not have to reinstall all of your agents.
To import Endpoint Security PKI certificates:
2. Import the certificates from the file containing your exported certificates, identified
by <fileURL>:
hostname (config) # hx pki import file <fileURL> passphrase
<passphrase>
For example:
hostname (config) # hx pki import file scp://user@host/path/to/file
passphrase abc123
Regenerating Certificates
You can reset the FireEye Endpoint Security Agent and Endpoint Security communications
server public key infrastructure (PKI), including a certificate authorities (CA).
Regenerating certificates automatically detaches any DMZ server from the Endpoint
Security server. You need to reattach them after the certificates are regenerated. See
the Endpoint Security Server Deployment Guide.
where <days> is the number of days that the agent CA remains active. Valid values
range from 0 and 65535 days. The default is 7300 days.
To set the duration back to the default, use the no form of this command:
hostname (config) # no hx pki agent ca-days
where <bits> is the number of bits for the agent certificates. Valid values range
from 1024 and 4096 bits. The default is 2048 bits.
To set the length back to the default, use the no form of this command:
hostname (config) # no hx pki agent cert-bits
where <days> is the number of days that the agent certificate remains active. Valid
values range from 0and 65535 days. The default is 1825 days (5 years).
To set the duration back to the default, use the no form of this command:
hostname (config) # no hx pki agent cert-days
where <days> is the number of days that the Endpoint Security CA remains active.
Valid values range from 0 and 65535 days. The default is 7300 days.
To set the duration back to the default, use the no form of this command:
hostname (config) # no hx pki server ca-days
where <bits> is the number of bits for the Endpoint Security certificates. Valid
values range from 1024 and 4096 bits. The default is 2048 bits.
To set the length back to the default, use the no form of this command:
hostname (config) # no hx pki server cert-bits
where <days> is the number of days that the Endpoint Security certificate remains
active. Valid values range from 0 and 65535days. The default is 1825 days (5 years).
To set the duration back to the default, use the no form of this command:
hostname (config) # no hx pki server cert-days
where <days> is the number of days that the Endpoint Security CRL remains active.
Valid values range from 0 and 65535days. The default is 30 days.
To set the duration back to the default, use the no form of this command:
hostname (config) # no hx pki server crl-days
where <url> is the URL from which the CRL should be uploaded.
For example:
hostname (config) # hx pki server crl-upload distro
https://10.42.138.20
An invalid CRL should correct itself automatically within 30 minutes of the date or
time discrepancy. This command forces the correction to occur immediately.
Using this command detaches any DMZ server from the Endpoint Security server.
You need to reattach them after running this command.
Using this command detaches any DMZ server from the Endpoint Security server.
You need to reattach them after running this command.
Documentation
Documentation for all Trellix products is available on the Trellix Documentation Portal
(login required):
https://docs.fireeye.com/
© 2022 FireEye Security Holdings US LLC. All rights reserved.Trellix, FireEye, and Skyhigh Security are the trademarks or
registered trademarks of Musarubra US LLC, FireEye Security Holdings US LLC, and their affiliates in the US and/or other
countries.