Smartconnector User'S Guide: Topics Applicable To All Arcsight Smartconnectors
Smartconnector User'S Guide: Topics Applicable To All Arcsight Smartconnectors
User’s Guide
Topics Applicable to All ArcsightTM SmartConnectors
Revision History
Date Description
11/17/2008 Added AUP and Connector Appliance sections. Updated for latest changes
within ESM. SmartConnector build #5177.
08/13/2008 Added CSV Import/export feature, and notation on using multiple connectors
within a single JVM.
12/18/2007 Two new parameters for the HTTP (ESM) destination type have been added to
allow non-ESM destinations to use the automatic updates (AUPs) pushed by
an ESM Manager. See revised installation chapter. Some organizational
changes for usability.
09/30/2006 First edition of this user’s guide. The former SmartConnector Installation
Guide has been revised and updated to become part of this new book.
E-mail support@arcsight.com
Overview ..................................................................................................................... 13
Supported Platforms ...................................................................................................... 14
Deployment Scenarios ................................................................................................... 14
Deployment Scenario One ........................................................................................ 15
Deployment Scenario Two ........................................................................................ 16
Overview ..................................................................................................................... 65
Obtaining SmartConnector Status .................................................................................... 66
Selecting and Setting SmartConnector Parameters ............................................................ 66
Connector Editor Option Tabs ................................................................................... 67
Configuration Fields ................................................................................................. 67
Default Content Tab Configuration Fields .................................................................... 69
SmartConnector Processing Categories ...................................................................... 81
Using Filters in the SmartConnector Configuration Wizard ................................................... 83
SmartConnector Time Interval Options ............................................................................. 85
Managing SmartConnector Filter Conditions ................................................................ 85
Setting Special Severity Levels ........................................................................................ 86
Sending Control Commands to SmartConnectors ............................................................... 87
Disabling Event Compression .......................................................................................... 89
Managing SmartConnector Groups ............................................................................ 90
Creating a SmartConnector Group ....................................................................... 90
Renaming a SmartConnector Group ..................................................................... 90
Editing a SmartConnector Group ......................................................................... 91
Moving or Linking a SmartConnector Group ......................................................... 91
Deleting a SmartConnector Group ....................................................................... 91
Introduction ................................................................................................................111
Working with Payload Data ............................................................................................111
Summary ....................................................................................................................113
Installation ..................................................................................................................113
Event Data Rotation .....................................................................................................114
The audience for this book is primarily security administrators who install SmartConnectors
and ensure their connectivity to ArcSight ESM. This can include administrators for:
Networks
Security
Systems
Databases
If this is the first time you are installing an ArcSight component, ArcSight recommends that
you first read the latest ArcSight ESM Administrator’s Guide.
Related Documentation
Document Title Description
ArcSight™ ESM User’s Describes how to use the ArcSight Console. These are
Guide printable versions of the online Help topics and glossary.
ArcSight™ ESM
Reference Guide
ArcSight™ ESM Web Provides user and reference information from the ArcSight
User’s Guide Web online Help system.
ArcSight makes available the following ESM and SmartConnector product documentation.
Many of these documents are available for download from the ArcSight ESM Console by
choosing the menu option Help > Browse Documentation. The latest and most
complete set of documentation is always offered on the ArcSight Customer Support site
(https://support.arcsight.com) through the Product Documentation link in the Knowledge
Center section.
Resource Description
ArcSight ESM collects, normalizes, aggregates, and filters millions of events from
thousands of assets across your network into a manageable stream prioritized according to
risk, exposed vulnerabilities, and the criticality of the assets involved.
ESM provides ready-made security solutions you can implement as-is, as well as powerful
tools you can use to build customized solutions.
Correlation. Often, interesting activities are represented by more than one event.
Correlation is a process that discovers the relationships between events, infers the
significance of those relationships, prioritizes them, and provides a framework for
taking action.
Monitoring. Once events have been processed and correlated to pinpoint the most
critical or potentially dangerous, ArcSight provides a variety of monitoring tools to
assist you in investigating and remediating potential threats before they can damage
your network.
Workflow. The workflow framework provides a customizable structure of escalation
levels to ensure that events of interest are escalated to the right people in the right
timeframe. This lets members of your team investigate immediately to make informed
decisions and take appropriate and timely action.
Analysis. When events occur that require investigation, ArcSight provides an array of
investigative tools that let your team members drill down into an event to discover its
details and connections, and to perform functions (such as nslookup, ping, portinfo,
traceroute, WebSearch, and whois).
Reporting. Briefing others on the status of your network security is vital to all who
have a stake in the health of your network, including IT and Security Managers,
executive management, and regulatory auditors. You can use ArcSight’s reporting
ArcSight Components
ArcSight products comprise several separately installable components working together to
process event data from your network. These components connect to your network
through sensors that report to ArcSight SmartConnectors.
SmartConnectors translate device output into a normalized event schema that becomes the
starting point for ArcSight ESM correlation.
The following graphic illustrates ArcSight basic components. For complete descriptions of
these components, see ESM 101, Concepts for ArcSight ESM v4.0.
ArcSight SmartConnectors gather and process event data from network devices and
pass it to the ArcSight ESM Manager to be processed and stored in the database.
Users interact with ArcSight ESM using the ArcSight ESM Console or ArcSight Web.
ArcSight NSP uses NCM/TRM software to provide network device inventory,
configuration settings, and additional analysis features.
ArcSight Logger is a hardware storage solution optimized for extremely high event
throughput.
ArcSight ESM
ArcSight ESM consists of several separately installable components that work together to
process event data from your network. These components connect to your network via
sensors that report to ESM SmartConnectors. SmartConnectors translate a multitude of
device output into a normalized ESM schema that becomes the starting point for ESM
correlation capabilities. ArcSight ESM components are described in the following pages.
SmartConnectors
SmartConnectors are the interface between the ArcSight ESM Manager and the network
devices that generate ESM-relevant data on your network.
SmartConnectors collect event data from network devices, then normalize it in two ways.
First, they normalize values (such as severity, priority, and time zone) into a common
format. Then they normalize the data structure into a common schema. SmartConnectors
can filter and aggregate the events to reduce the volume sent to the Manager, which
increases ArcSight’s efficiency and reduces event processing time.
In brief, SmartConnectors:
Parse individual events and normalize them into a common schema (format) for use by
ArcSight ESM.
Collect all the data you need from a source device, which eliminates the need to return
to the device during an investigation or audit.
Filter out data you know is not needed for analysis, thus saving network bandwidth
and storage space.
Aggregate events to reduce the quantity of events sent to the Manager.
Pass processed events to the Manager.
Categorize events using a common, human-readable format, saving you time and
making it easier to use those event categories to build filters, rules, reports, and data
monitors.
Depending upon the network device, some SmartConnectors also can instruct the
device to issue commands to devices. These actions can be executed manually or
through automated actions from rules and some data monitors.
ArcSight releases new and updated SmartConnectors approximately every six weeks.
FlexConnectors
ArcSight’s FlexConnector framework is a software development kit (SDK) that lets you
create a SmartConnector tailored to the devices on your network and their specific event
data. The following ArcSight FlexConnectors types are available:
File
Regular Expression File
Time-Based Database
Key-Value File
SNMP
Multiple Database
ID-Based Database
Regular Expression Folder File
XML File
CounterACT
Regular Expression Multiple File
Multi-Folder File
Syslog
In addition, beta support is currently available for the following FlexConnectors:
Scanner Database
Scanner XML Reports
Scanner Text Reports
For complete information about these FlexConnectors and how to use them, contact your
ArcSight Customer Support representative or see the ArcSight FlexConnector Developer's
Guide.
ESM Manager
As events stream into the system, the ESM Manager writes them to the ArcSight database.
It simultaneously processes the events through the correlation engine, which evaluates
each event with network model and vulnerability information to develop real time threat
summaries.
ESM Database
As events stream into the ESM Manager from the SmartConnectors, they are written to the
ESM Database with a normalized schema. This lets ESM collect all events generated by the
devices on your network, which you can analyze and refer to at any time.
The ESM Database is based upon Oracle 9i. A typical installation retains active data online
from weeks to months.
ESM Console
The ArcSight ESM Console is a workstation-based interface intended for use by your
full-time security staff in a Security Operations Center (SOC) or similar security-monitoring
environment. The Console is the authoring tool for building ArcSight ESM filters, rules,
reports, Pattern Discovery, dashboards, and data monitors. It also is the interface for
administering users and resources.
The ArcSight ESM Console version should match the ArcSight ESM Manager
version to ensure that resources and schemas match.
ArcSight Web
ArcSight Web is an independent and remotely installable Web server that provides a secure
interface with the ArcSight ESM Manager for browser clients. ArcSight Web is intended for
use as a streamlined interface for customers of Managed Service Security Providers
(MSSPs), SOC operators, and business users who require access to ArcSight ESM to
investigate events from outside the protected network.
ArcSight NSP
ArcSight NSP is an appliance that consists of these two licensed software components.
ArcSight Logger
ArcSight Logger is an event data storage appliance optimized for extremely high event
throughput. Logger stores security events onboard in compressed form, but can always
retrieve unmodified events on demand for forensics-quality litigation data.
Logger can be deployed stand-alone to receive events from syslog messages or log files, or
to receive events in Common Event Format from SmartConnectors. Logger can forward
selected events as syslog messages to ESM.
Multiple Loggers work together to support high sustained input rates. Event queries are
distributed across a peer network of Loggers.
Connector Appliance
ArcSight Connector Appliance is a hardware solution that incorporates a number of
onboard ArcSight SmartConnectors and a web-based user interface that provides
centralized management for SmartConnectors across a potentially large number of hosts.
Event Severity
During the normalization process, the SmartConnector collects data about the level of
danger associated with a particular event, as interpreted by the data source that reported
the event to the SmartConnector. These data points, device severity and
SmartConnector severity, become factors in calculating the event’s overall priority.
Device severity captures the language used by the data source to describe its
interpretation of the danger posed by a particular event. For example, if a network IDS
detects a DHCP packet that does not contain enough data to conform to the DHCP format,
the device flags this as a high-priority exploit.
For example, routine file access and successful authentications by authorized users would
be translated into the ArcSight-normalized values as very low severity, whereas a short
DHCP packet would be translated as very high severity.
You can configure the SmartConnector to aggregate (summarize and merge) events that
have the same values in a specified set of fields, either for a specified number of times or
within a specified time limit.
SmartConnector aggregation compiles events with matching values into a single event. The
aggregated event contains only the values the events have in common plus the earliest
start time and latest end time. This reduces the number of individual events the Manager
must evaluate.
For example, suppose the SmartConnector is configured to aggregate events with a certain
Source IP and Port, Destination IP and Port, and Device Action whenever the events occur
10 times in 30 seconds. If ten events with these matching values are received by the
SmartConnector within that timeframe, they are grouped together into a single event with
an aggregated event count of 10.
If the 30-second timeframe expires and the SmartConnector has received only two
matching events, the SmartConnector creates a single aggregated event with an
aggregated event count of two. If 900 matching events were to come in during the 30
seconds, the SmartConnector would create 90 aggregated events, each with an
aggregated event count of 10.
Firewalls are a good candidate for aggregation because of the volume of events with
similar data coming in from multiple devices.
Configurable Attributes
All SmartConnector configurable attributes are set during the installation and configuration
process. The following attributes can be edited after installation by the ArcSight ESM
Administrator.
This chapter provides an overview of ArcSight SmartConnectors and how they collect and
send events (generated by various vendor devices) to the ArcSight ESM Manager.
Once SmartConnectors normalize and send events to the ArcSight Manager, the events are
stored in the centralized ESM Database. ArcSight ESM then filters and cross-correlates
these events with rules to generate meta-events. The meta-events then are automatically
sent to administrators with corresponding Knowledge Base articles which contain
information supporting their enterprise’s policies and procedures.
Features
For complete information about how the following features work, see the ArcSight ESM
v4.0 Administrator’s Guide and ArcSight ESM Console Help.
Feature Description
Filtering and Data Uses AND/OR based Boolean logic to determine what data
Reduction is to be included from the device and what data is filtered
out when the event is sent to the ESM Manager.
Time Error Synchronizes the time between the device and the
Correction SmartConnector, and between the SmartConnector and the
ESM Manager.
Time Zone Correction Corrects the local time zone, as necessary, to support
device-time queries, correlation, and filters.
The following illustration shows the communication between network devices and ArcSight
SmartConnectors, and between ArcSight SmartConnectors and ArcSight ESM Manager.
SmartConnectors both receive and retrieve information from network devices. If the device
sends information, the SmartConnector becomes a receiver; if the device does not send
information, the SmartConnector retrieves it.
An ArcSight message is created for each event the devices collect. Once an event is
received, the SmartConnector adds device and event information to the event to complete
the message, which is then sent to the ESM Manager.
Data collection and event reporting formats for various SmartConnectors include:
For specific mappings between the SmartConnector data fields and supported vendor-
specific event definitions, see the configuration guide for the device-specific
SmartConnector. For example, for mappings for the SmartConnector for Cisco PIX Syslog,
refer to the SmartConnector for Cisco PIX Syslog Configuration Guide.
For additional information about mappings and parsing information from third-party
devices, see “Advanced Topics” in the FlexConnector Developer’s Guide.
“Overview” on page 13
“Supported Platforms” on page 14
“Deployment Scenarios” on page 14
“Estimating Storage Requirements” on page 17
“Understanding ArcSight Turbo Modes” on page 17
The scenarios and deployments shown here are only examples of how you might introduce
ArcSight ESM into your enterprise. ArcSight ESM is not limited to just these scenarios and
deployments.
Overview
ArcSight components install consistently across UNIX, Windows, and Macintosh platforms.
Whether a host is dedicated to the ArcSight ESM Database, Manager, Console, or other
component, ArcSight ESM software is installed in a directory tree under a single root
directory on each host (DBMS and other third-party software is not necessarily installed
under this directory, however.) The path to this root directory is called $ARCSIGHT_HOME.
ArcSight SmartConnectors collect and process the data generated by various vendor
devices throughout your enterprise. Devices consist of routers, email logs, anti-virus
products, firewalls, intrusion prevention systems (IPS), access control servers, VPN
systems, antiDoS appliances, operating system logs, and other sources where information
about security threats are detected and reported.
Supported Platforms
For information about supported platforms, see the ArcSight SmartConnector Product and
Platform Support document that is shipped with each SmartConnector release. Only
differences to the support detailed in that document are specified in the device's
SmartConnector Configuration Guide.
Deployment Scenarios
You can install SmartConnectors on the ArcSight ESM Manager, a host machine, or a
device. Based upon configuration, they also can receive events over the network using
SNMP, HTTP, syslog, proprietary protocols (such as OPSEC), or direct database connections
to the device's repository (such as ODBC or proprietary database connections).
The best deployment scenario for your system depends upon the SmartConnector type,
your network architecture, and your operating system.
Scenarios for syslog deployment are documented in the SmartConnector for UNIX OS
Syslog Configuration Guide.
Scenarios for deploying Windows Event Log connectors are documented in the
SmartConnector for Microsoft Windows Event Log Configuration Guide.
Once events are received by the Manager, it cross-correlates the events using rules and
sends meta-events to the ESM Database and to any ESM Consoles that access the
Database.
The ESM Manager also can perform preset actions. Events and meta-events within the ESM
Database can be played back using the Replay channel to investigate, analyze, or create a
report about event history.
The average size of the data stored for each event depends upon the turbo mode
(Fastest, Faster, or Complete) specified for a particular SmartConnector. For detailed
information on turbo modes, see the following section, “Understanding ArcSight Turbo
Modes”.
SmartConnectors can aggregate events to reduce event traffic. An event that repeats every
500 ms, for example, can be represented by a single event that fires every ten seconds,
producing a 20:1 event compression. Individual SmartConnectors can be configured to
aggregate events in this manner, reducing event traffic to the ESM Manager and the
storage requirements in the Database.
In a distributed environment with multiple ESM Managers, the event volume metric must
consider both the SmartConnector feeds to the Manager and the event forwarding from
other Managers.
The Fastest mode requires the fewest bytes and is most suited to devices such as
firewalls, which have relatively little event data. The Faster mode is the Manager default,
and requires less storage space. Rich event data sources, such as a network operating
system, might use Complete mode, the SmartConnector default. The Complete mode
passes all the data arriving from the device, including any custom or vendor-specific (for
example, "additional") data.
You can configure SmartConnectors to send more or less event data on a per-
SmartConnector basis, and the ESM Manager can be set to read and maintain more or less
event data, independent of the SmartConnector setting.
Some events require more data than others. For example, operating system syslogs often
capture a considerable amount of environmental data that may not be relevant to a
particular security event. Firewalls, on the other hand, typically report only basic
information.
Mode Description
Faster (Mode 2) ESM Manager default. Eliminates all but a core set of event
attributes to achieve the best throughput. Because the
event data is smaller, it requires less storage space and
provides the best performance.
When a turbo mode is not specified, Mode 3, Complete, is the default. Versions of ArcSight
ESM prior to v3.0 run in turbo mode Complete.
The ESM Manager uses its own turbo mode setting when processing event data. If a
SmartConnector is set at a higher turbo mode than the Manager, it reports more event data
than the Manager requires. The Manager ignores these extra fields.
However, if a Manager is set at a higher turbo mode than the SmartConnector, the
SmartConnector has less event data to report to the Manager. The Manager maintains
fields that remain empty of event data.
Both situations are normal in real-world scenarios because the Manager configuration must
reflect the requirements of a diverse set of SmartConnectors.
2-3 Default: Manager does not process additional data sent by SmartConnector.
3-2 Manager maintains additional data, but SmartConnector does not send it.
When you have purchased and are ready to install an ArcSight SmartConnector, see the
configuration guide of the individual connector for customized information for the device
the connector is monitoring. (For example, when installing a SmartConnector for Windows
Event Log, refer to the SmartConnector for Microsoft Windows Event Log Configuration
Guide.)
1 Ensure that the ArcSight ESM Manager, Database, and Console are installed correctly.
2 Run the ArcSight ESM Manager. The command prompt window or terminal box
displays a "Ready" message when the ESM Manager has started successfully. If the
ArcSight ESM Manager is running as a Windows NT/2000 Service, monitor the
server.std.log file located in ARCSIGHT_HOME\current\logs\default.
3 Run the ArcSight ESM Console. Although not required, it is helpful to have the Console
running when installing the SmartConnector to verify successful installation.
1 Insert the ArcSight Installation CD into your CD-ROM drive or navigate to the location
of the ArcSight SmartConnector Installer directory.
Linux ArcSight-4.0.x.nnnn.y-Connector-Linux.bin
Solaris ArcSight-4.0.x.nnnn.y-Connector-Solaris.bin
Windows ArcSight-4.0.x.nnnn.y-Connector-Windows.exe
A window such as the following is displayed; once you have verified that the ESM
Database, Manager, and Console are installed and operating, click Next.
3 When the Introduction window is displayed, read the information and click Next when
ready.
4 Next, accept the default location for "Where Would You Like to Install?," or click
Choose… to select another folder for installation. Click Next when ready.
5 Choose from the following types installation; for most connectors, Typical is the
appropriate selection. Click Next.
6 On the following window, accept the default shortcut folder location or select a new or
existing Program Group. (You can also create icons for all users accessing ArcSight
SmartConnector by selecting the Create Icons for All Users check box.) Click Next
when you have finished making your selections.
For information about NSP Device Poll Listener, see Chapter 6‚ Deploying a Syslog
SmartConnector with NCM/TRM‚ on page 58. The SmartConnector Configuration
Wizard prompts you to specify whether the ArcSight ESM Manager to which you are
going to connect uses a demo certificate to authenticate SmartConnector requests.
11 The Wizard first prompts you for Manager certificate information. The default selection
is No, the ArcSight Manager is not using a demo certificate. Choose Yes if ArcSight
Manager is using a demo certificate. (Before selecting this option, make sure the
Manager is, in fact, using a demo SSL certificate. If you are not certain, select No or
consult your system administrator.). If your ArcSight Manager is using a self-signed or
CA-signed SSL certificate, select No, the ArcSight Manager is not using a demo
certificate and click Next.
12 On the next window, replace localhost with the host name of the Manager with
which the SmartConnector is to communicate (localhost is appropriate only when
the SmartConnector is installed on the same host as the Manager, which is not
recommended in a production environment). This name must match the host name in
the Manager’s certificate, which is usually the fully-qualified name. For example,
instead of gabriel, specify gabriel.sales.mycompany.com.
For AUP Master Destination, generally leave this false. If, however, you will have
one or more non-ESM destinations, and you want to share this ESM destination's AUP
configuration (such as zones) with those destinations, select true. Only do so for one
primary destination; if you select true for more than one primary destination or any
failover destination, the setting is ignored for all but the first such primary destination.
For Filter Out All Events, select true if you want a ll events filtered out. This means
the connector sends no events to this destination. This is useful when an ESM
destination is added solely for the purpose of being the AUP master; this value is
usually false unless the AUP Master Destination parameter is set to true.
13 Enter a valid ArcSight user name and password for the ArcSight ESM Manager. This is
the same user name and password you created during ESM Manager installation.
14 Select one of the possible SmartConnectors from the window displayed. Scroll down to
find the appropriate SmartConnector. If you are installing a syslog SmartConnector,
select the Syslog Pipe, File, or Daemon SmartConnector.
The SmartConnectors that appear in the list are those that can be installed on the
same platform from which you are running the installation program. For example, if
you are running on Windows, the list contains a list of those SmartConnectors that are
supported on Windows. Similarly, if you are running the installer on a Linux or Solaris-
based system, the installer displays a list of SmartConnectors supported on those
platforms.
15 After selecting the connector you want to install from the list of SmartConnectors, in
this example, Symantec Gateway Security/Enterprise Firewall NG File, click
Next.
16 The next window requests specific parameters for the particular SmartConnector you
selected. These parameters vary depending upon the device and are described and
explained in the SmartConnector Configuration Guide for the selected SmartConnector.
To manually enter parameter values, click the Add button. See “Manually Entering
Parameter Values” on page 30 for details.
Click the Import button to locate the .csv file you want to import. Click the Export
button to create a .csv file containing the values you have entered in the parameter
table. See “Importing and Exporting CSV Files” on page 30 for details.
If there are no Import and Export buttons on the parameter entry window
for the connector you’ve selected, the parameters are not entered into a table
format and this feature does not apply.
18 Give your new SmartConnector a descriptive name to identify it for ArcSight Console
users. You also can specify optional location information and add any appropriate
comments.
In this context, SmartConnector Location refers to the host where you are
installing the SmartConnector and Device Location describes the host on which the
IDS, syslog, or other software is running. If the device is physical hardware, the
Device Location is particularly useful for specifying, for example, a certain position
within a specific rack.
If you choose to configure the SmartConnector to run as a service, the wizard prompts
you for the service’s internal and display names.
If you choose not to run the SmartConnector as a service, a window such as the
following is displayed.
For some SmartConnectors, a system restart is required before the configuration settings
you made can take effect. If a System Restart window is displayed, read the information
and initiate the system restart operation.
Save any work on your computer or desktop and shut down any other running applications,
including the ArcSight Console, if it is running; then shut down the system.
The parameters for this type of SmartConnector can be entered manually for a few lines of
data, or, for a larger number of entries, you can import a .csv file. You can also create a
.csv file by exporting data you’ve already entered. See “Importing and Exporting CSV Files”
on page 30 for specific steps.
Columns that contain private data (shown as asterisks), such as passwords, will not
appear in exported files after using the Export button.
After importing a .csv file (using the Import button), data in private columns remain
hidden (shown as asterisks).
While you can manually enter a private column (either by adding the column to your
CSV within a spreadsheet program or by filling it in through the Configuration Wizard),
it still will not appear in any exported files. This is a precautionary measure.
Importing data from a .csv file (using the Import button) causes all existing data in
the table to be removed and replaced by the incoming data.
If needed, use the Export button to export your parameter table data into an external .csv
file to save for later use.
1 Using a spreadsheet program (such as Microsoft Excel), enter the parameter data into
a table and save it as a .csv file.
2 During SmartConnector installation, click the Import button to locate the .csv file you
created. The window provides a preview of the CSV’s contents.
3 Click the Import button on the Import window. This populates the SmartConnector
parameters fields, as shown below.
4 If you wish, you can add more rows manually (using the Add button) and then export
the resulting table (using the Export button) to an external .csv file for later use.
When the installation has successfully completed, manually run the configuration program
by executing runagentsetup.
To use this feature, first install and configure one SmartConnector using the graphical-user
interface or the command line. While configuring the first SmartConnector, record its
configuration parameters in a Properties file. To install all other SmartConnectors in silent
mode, use the Properties file you created to provide configuration information.
3 On the window displayed, enter the Silent Properties File Name to select an
existing file. Enter the name of the Installation Target Folder to select a location.
Perform the remaining steps on the system on which you want to install the
SmartConnector in silent mode:
5 Copy the Properties file from the other system to your current system, preferably to
the same directory where you downloaded the installation file.
ARCSIGHT_AGENTSETUP_PROPERTIES=C\:\\Program
Files\\ArcSightSmartSmartConnectors\\silent_properties
The equal (=) and backslash (\) characters must be preceded by a backslash
(\).
#======================================================
# Panel 'AgentDetailsPanel'
#======================================================
# SmartConnector Name
SmartConnectorDetailsPanel.smartConnectorname=SF_SmartConnector1
# Agent Location
AgentDetailsPanel.agentlocation=San Francisco
# Device Location
AgentDetailsPanel.devicelocation=Site_2.2.223
# Comment
AgentDetailsPanel.comment=
#===============================================
AgentDetailsPanel.agentlocation
AgentDetailsPanel.devicelocation
AgentDetailsPanel.comment
You can edit any property (Manager Information, user credentials) in the properties file to
suit your needs.
12 Run the following command to install the new SmartConnector in silent mode:
The command launches the InstallShield program and installs the SmartConnector silently.
Example: To install a SmartConnector on Windows platform with the property file name
silent_properties, enter:
On UNIX systems, file permissions typically are set by adding the umask
command to your shell profile. An umask setting of 077, for example, would
deny read or write file access to any but the current user. An umask setting of
000 creates an unnecessary security hole.
ArcSight ESM now provides the ability to not only centrally manage and configure
SmartConnectors, but also to update them remotely. You can use the Upgrade command
on the ArcSight ESM Console to upgrade to newer versions of ArcSight SmartConnector
software for managed devices. (You also can use the Rollback command to revert to a
previous version of an upgraded SmartConnector.)
The Upgrade command lets you launch, manage, and review the status of upgrades for all
SmartConnectors. A failover mechanism launches SmartConnectors with previous versions
if upgrades fail. All communication and upgrade processes between components (Console,
Manager, and SmartConnectors) take place over secure connections.
The ArcSight ESM Console reflects current version information for all of your ArcSight
SmartConnectors.
2 Download the latest releases to the ArcSight ESM Manager available for
SmartConnector upgrades. Upgrade version files are delivered as .aup files (a
compressed file set).
If the upgrade is successful, the new SmartConnector starts and reports successful
upgrade status.
If the upgraded SmartConnector fails to start, the original SmartConnector restarts
automatically as a failover measure.
For details about how to upgrade SmartConnectors from the Console, refer to the ArcSight
Console Help.
The option for SmartConnector rollback is available only in ArcSight Console v4.0 and only
on previously upgraded SmartConnector versions 4.0.2.xxxx.0 or newer.
Rollback automatically reinstates the most recent version prior to the currently installed
version. You cannot do a remote rollback on a SmartConnector other than the previously
installed version.
Troubleshooting
If an upgrade or rollback fails, you can review the related logs. Choose Send Command
-> Tech Support -> Get Upgrade Logs from the ArcSight Console menus.
You can also use the Send Logs Wizard to collect and send logs, including upgrade logs, to
ArcSight for support help.
Uninstalling a SmartConnector
Before uninstalling a SmartConnector that is running as a service or daemon, first stop the
service or daemon.
To uninstall on Windows platforms, open the Start menu. Run the Uninstall
SmartConnectors program found under All Programs -> ArcSight
SmartConnectors. If SmartConnectors were not installed on the Start menu, locate the
ARCSIGHT_HOME\current\UninstallerData folder and run:
Uninstall_ArcSight_Agents.exe
./Uninstall_ArcSight_Agents
Stop the ArcSight SmartConnector and execute the following command from the
$ARCSIGHT_HOME\current\bin directory:
./runagentsetup.sh
runagentsetup
Running SmartConnectors
SmartConnectors can be installed and run in standalone mode, as a Windows service, or
as a UNIX daemon. If installed standalone, the SmartConnector must be started manually,
and is not automatically active when a host is re-started. If installed as a Windows service
or UNIX daemon, the SmartConnector runs automatically when the host is re-started.
Standalone
To run all installed SmartConnectors on a particular host, open a command window, go to
ARCSIGHT_HOME\current\bin and run:
arcsight connectors
ARCSIGHT_HOME\current\logs\agent.log
As a Windows Service
SmartConnectors installed as a service can be started and stopped manually using
platform-specific procedures.
3 Right-click on the ArcSight SmartConnector service name and select Start to begin
running the SmartConnector or Stop to stop running the service.
ARCSIGHT_HOME\logs\agent.out.wrapper.log
runagentsetup
As a UNIX Daemon
SmartConnectors installed as a daemon can be started and stopped manually using
platform-specific procedures.
For example:
/etc/init.d/arc_serviceName {start|stop}
ARCSIGHT_HOME/logs/agent.out.wrapper.log
runagentsetup
Figure 5-1 ArcSight Connector Appliance includes on-board SmartConnectors that connect
event sources to destinations such as ArcSight Logger and ArcSight ESM.
SmartConnectors that forward events to ArcSight ESM can be managed using the ESM
Console, so the Connector Appliance is not required if all SmartConnectors have ESM as
their only destination. However, the Connector Appliance is very useful when connectors
target multiple heterogeneous destinations (for example, when ArcSight Logger is
deployed along with ESM), in a Logger-only environment, or when a large number of
SmartConnectors are involved, such as in a MSSP deployment.
Connector Appliance SmartConnectors operate within Containers. Each Container runs its
own Java Virtual Machine (JVM). Containers contain one or more SmartConnectors.
Software-Based SmartConnectors
The Connector Appliance can remotely manage SmartConnectors running on any network-
accessible host. These SmartConnectors must be configured for remote management.
Supported SmartConnectors
For a complete list of all SmartConnectors supported by the Connector Appliance, see the
Connector Appliance Release Notes or visit the ArcSight Customer Support website. New
SmartConnectors are added on a regular basis.
Manager
When SmartConnectors send events to an ArcSight ESM Manager, the Manager stores the
events in a relational database, processes them using its correlation engine, and makes
them visible to the ArcSight Console or ArcSight Web interfaces.
Logger
SmartConnectors can send CEF events to ArcSight Logger using an encrypted, optionally
compressed, channel called SmartMessage. Logger can also receive CEF Syslog events
from SmartConnectors.
For more detailed information about Logger, see Chapter 6‚ Using SmartConnectors with
ArcSight Logger‚ on page 45
CEF Syslog
SmartConnectors can forward events as syslog messages. In this case, the normalized
event is sent using Common Event Format (CEF) which uses name/value pairs. The
Connector Appliance can send syslog over UDP or TCP.
Failover Destination
Each SmartConnector destination can have a failover destination. When communication
with the primary destination fails, the SmartConnector automatically begins sending events
to the designated failover. Failover only works with communication protocols that can
detect transmission failure, such as TCP.
For steps to create a failover destination, see Chapter 8‚ Failover Destinations‚ on page 93.
Alternate Configurations
You can define alternate configurations for SmartConnectors and specify when the
alternate should be active. For example, aggregation might be specified during peak times
to reduce the number of events moving on the network, and disabled during other times.
ArcSight Logger
ArcSight Logger receives and sends events from and to ArcSight SmartConnectors, but
lacks the depth of SmartConnector management found in ArcSight ESM.
A Logger-only deployment benefits from the Connector Appliance in many capacities, and
provides most of ESM’s management functionality, but not all (it does not contain the filter
designer, for example). The Connector Appliance also offers new features, such as bulk
operations (enabling control of many Smartconnectors at one time), that ESM does not.
For more detailed information about Logger, see Chapter 6‚ Using SmartConnectors with
ArcSight Logger‚ on page 45
ArcSight ESM
Deploying the Connector Appliance in an ArcSight ESM environment centralizes
SmartConnector upgrade, log management, and other configuration issues. For more
information, see Chapter 7‚ Configuring SmartConnectors through the Console‚ on page 65.
are sent to ESM (for further analysis, for example). In another scenario, all events are sent
to both, but Logger implements a longer retention policy.
For more detailed information and instructions for using Connector Appliance, refer to the
Connector Appliance Administrator’s Guide.
ArcSight Logger is a hardware storage solution optimized for extremely high event
throughput. Logger logs (or stores) time-stamped text messages, called events, at high
sustained input rates. Events consist of a receipt time, a source (host name or IP address),
and an un-parsed message portion. Logger compresses raw data, but also can retrieve it in
an unmodified form for forensics-quality litigation reporting. Unlike ArcSight ESM, Logger
does not "normalize" events.
Multiple Loggers can work together to support an extremely high event volume. Logger can
be configured as a peer network with queries distributed across all peer Loggers.
secure channel. At one end is an ArcSight SmartConnector, receiving events from the many
devices it supports; on the other end is SmartMessage Receiver on Logger.
3 Navigate through the panels to the one that states Please select the destination
type: and select ArcSight Logger SmartMessage (encrypted). Click Next.
4 Enter the Logger Host Name/IP, leave the port number at default (443), and enter
the Receiver Name. This setting should match the Receiver name you created in
step 1 so that Logger can listen to events from this SmartConnector. Click Next.
5 Navigate through the subsequent panels until receiving a message that confirms the
configuration was successful. Click Finish to complete the process and exit the wizard.
3 Register the SmartConnector with a running ArcSight ESM Manager and test that the
SmartConnector is up and running.
8 Specify the Host Name/IP, the desired Port, and select either Disabled (the default
value) or Enabled data compression. Click Next.
9 A message confirms that the configuration was successful. Click Finish to complete
the process and exit the wizard.
1 Install the SmartConnector component normally, but click Cancel to exit the
installation when the Configuration Wizard asks whether the target Manager uses a
demo certificate, as shown below.
2 Confirm that you want to exit, then click Done to close the wizard. This installs the
SmartConnector core software.
transport.default.type=cefsyslog
5 Specify the required parameters for CEF output. Enter the desired port for UDP or TCP
output. These settings should match the Receiver you created in Logger to listen for
events from ArcSight ESM.
Parameter Description
ArcSight Source Manager A user account on the source Manager with the
User Name user type set to Super Agent. This user must have
privileges that allow event reading.
ArcSight Source Manager Password for the specified ESM Manager user
Password account
Parameter Description
To configure the ArcSight Forwarding SmartConnector to send CEF output to Logger and
send events to another ArcSight ESM Manager at the same time, see “Sending Events to
Both Logger and an ESM Manager” on page 48.
5 The following window provides a choice of destination settings to modify. For this
example, select Time Correction and click Next.
6 Each choice opens a unique set of windows to configure. Modify the appropriate
settings and click Next.
7 The next window asks whether you want to end the session or select new destination
settings to modify. To make additional modifications, select No; to end the session,
select Yes.
ArcSight NSP is an appliance that consists of these two licensed software components, also
known as managers:
The NCM/TRM solution enables you to automate network configuration changes across
heterogeneous networks, manage and audit configuration changes on the network from a
central console, and obtain quick and easy web-based reports for network device inventory
and configuration settings.
The ArcSight Syslog SmartConnector increases NCM/TRM’s visibility into the network. It
detects network configuration changes in syslog format using SNMP traps, which can then
trigger NCM/TRM to launch an action to poll the network devices for the complete, new
configuration.
Complete visibility into all changes being made to network devices, even if the
changes are made directly to the network devices.
Real-time detection and notification for any non-compliant or unauthorized changes.
Ensured compliance with internal standard operating procedures as well as external
regulations.
Other uses for deploying syslog SmartConnectors in conjunction with NCM/TRM include:
Enabling a hybrid configuration and change control model that permits certain
changes to be made directly to network devices, while still maintaining control,
visibility, auditing, and compliance for all changes in a central repository (NCM/TRM).
Providing a closed-loop solution for capturing network configuration related event
information from all sources from which the change can be made (NCM/TRM directly,
proxied through NCM/TRM, or directly to the device) and forwarding this information
to ESM in an integrated manner.
The SmartConnector installation wizard contains an NSP Device Poll Listener
destination. The Device Poll Listener detects when changes are made to network devices
outside of NCM/TRM. The SmartConnector captures these changes by collecting syslog
output from modified network devices and categorizes the events for ESM.
The SmartConnector then initiates an action through NCM/TRM to poll the specific modified
network devices to determine the precise changes made to the configuration.
At the same time, NCM/TRM can run audits automatically to determine whether the
particular change caused the configuration to fall into a non-compliant state. NCM/TRM
determines this by comparing the current device configuration parameters against the
pre-defined policy or benchmark. If there is a deviation from the policy, the audit fails and
an alert is sent to the appropriate personnel within the organization, notifying them of the
audit failure so they can take immediate action.
You also have the option of forwarding all categorized events to ArcSight ESM or Logger in
a normalized format through ArcSight Common Event Format (CEF) for further analysis or
storage.
By capturing these changes and immediately prompting NCM/TRM to run a device poll or
audit at the precise time of the configuration change, this solution provides an automatic,
real-time, closed-feedback loop for all configuration changes, even if they are made directly
to network devices outside the scope of NCM/TRM.
The following diagram depicts the Syslog SmartConnector solution deployed with
NCM/TRM and ESM.
Figure 6-1 The Syslog SmartConnector solution deployed with ArcSight NSP
Please keep the following in mind when configuring and deploying NCM/TRM:
It is optional to run NCM/TRM as an audit while the device is polled; however, it does
require that audits be currently subscribed to that particular network device or device
group.
Alert options include syslog, SNMP, and e-mail.
Remediation is an optional step, as some administrators may simply want to be alerted
of the change so they can take their own actions; however, remediation requires that
the appropriate remediation links be built in advance.
It is optional to forward events to ESM or Logger. Neither appliance is required for this
solution to be fully functional.
For NCM/TRM to poll a network device, it must be previously known within the
network.
If you are using the syslog daemon connector, simply start the connector, either as a
service or as a standalone application, to start receiving events; no further configuration is
needed.
Messages longer than 1024K are split into multiple messages on syslog
daemon; no such restriction exists on syslog file or pipe.
The Syslog Pipe SmartConnector is designed to work with an existing syslog daemon.
This SmartConnector is especially useful when storage space is a factor. In this case,
syslogd is configured to write to a named pipe, and the Syslog Pipe SmartConnector reads
from it to receive events.
The Syslog File SmartConnector is similar to the Syslog Pipe SmartConnector; however,
this SmartConnector monitors events written to a syslog file (such as messages.log) rather
than to a system pipe.
The standard UNIX implementation of a syslog daemon reads the configuration parameters
from the /etc/syslog.conf file, which contains specific details about which events to
write to files, write to pipes, or send to another host. First, create a pipe or a file; then
modify the /etc/syslog.conf file to send events to it.
mkfifo /var/tmp/syspipe
*.debug /var/tmp/syspipe
*.debug |/var/tmp/syspipe
3 After you have modified the file, restart the syslog daemon either by executing the
scripts /etc/init.d/syslogd stop and /etc/init.d/syslogd start, or by
sending a `configuration restart` signal.
This command forces the syslog daemon to reload the configuration and start writing
to the pipe you just created.
1 Create a file or use the default for the file into which log messages are to be written.
2 After editing the /etc/syslog.conf file, restart the syslog daemon as described
above.
The SmartConnector Installation Wizard, then prompts you for the absolute path to the
syslog file or pipe you created.
Syslog Daemon
Syslog Pipe
Syslog File
The Syslog Daemon SmartConnector is supported on Windows, Linux, Solaris, and AIX
platforms. The Syslog Pipe and File Smartconnectors are supported on Linux, Solaris, AIX,
and HP UNIX.
The syslog daemon listens on port 514 (configurable) for UDP syslog events; the syslog
pipe and syslog file read events from a system pipe or file, respectively. Select the one that
best fits your syslog infrastructure setup.
To install a syslog SmartConnector to send events to the NSP Device Poll Listener:
1 Insert the ArcSight Installation CD into your CD-ROM drive or navigate to the location
of the ArcSight SmartConnector Installer directory.
2 Start the ArcSight SmartConnector Installer by running the executable for your
operating system.
3 Follow the installation wizard through the following folder selection tasks and
installation of the core connector software:
Introduction
Choose Install Folder
Choose Install Set
Choose Shortcut Folder
Pre-Installation Summary
Installing...
4 Select NSP Device Poll Listener from the selections and click Next.
5 Enter the NCM Host name or IP address, the NCM/TRM User, and the NCM/TRM
Password. The NCM/TRM Host is the IP address or hostname of the NCM/TRM
system that will interact with the syslog connector. The NCM/TRM User and
NCM/TRM Password are the user name and password credentials you use to log
into the NCM/TRM system.
6 Click Next.
Syslog Network port The SmartConnector for Syslog Daemon listens for
Daemon syslog events on this port.
Parameters
Syslog Pipe Pipe Absolute Absolute path to the pipe, or accept the default:
Parameters Path Name /var/tmp/syspipe
Syslog File File Absolute Absolute path to the file, or accept the default:
Parameter Path Name /var/adm/messages (Solaris) or
/var/log/messages (Linux)
9 Enter a name for the SmartConnector and provide any other information that identifies
how the connector is used in your environment. Click Next.
10 Read the SmartConnector summary and click Next. If the summary is incorrect, click
Back to make changes.
11 When the SmartConnector completes its configuration, click Next. The Wizard now
prompts you to choose whether you want to run the SmartConnector stand-alone or
as a service. If you choose to run the SmartConnector as a service, the Wizard
prompts you to define service parameters for the SmartConnector.
12 After making your selections, click Next. The Wizard displays a dialog confirming the
SmartConnector's setup and service configuration.
13 Click Finish.
Save any work on your computer or desktop and shut down any other
running applications (including the ArcSight Console, if it is running),
then shut down the system.
Using the ArcSight ESM Console, you can configure and send control commands to
ArcSight SmartConnectors, set conditions that filter out events, and set ArcSight severity
levels. This chapter presents the basic information; for more detailed information about
managing ArcSight SmartConnectors, refer to the ArcSight ESM v4.0 Administrator’s Guide
and the ArcSight ESM Console Help.
“Overview” on page 65
“Obtaining SmartConnector Status” on page 66
“Selecting and Setting SmartConnector Parameters” on page 66
“SmartConnector Time Interval Options” on page 85
“Setting Special Severity Levels” on page 86
“Setting Special Severity Levels” on page 86
“Sending Control Commands to SmartConnectors” on page 87
“Disabling Event Compression” on page 89
Overview
ArcSight SmartConnectors can be configured to optimize their performance and increase
their function. You can configure them to enable aggregation, batching, and time
correction as well as to send control commands from the ArcSight Console to ArcSight
SmartConnectors to manage the flow of events.
Based upon filtering conditions, ArcSight SmartConnectors can filter events sent to the
ArcSight ESM Manager. Filtering conditions are set with a combination of AND or OR
statements and data field values. Extraneous events can be filtered out to minimize the
number of events sent to the ESM Manager and displayed in the Console.
You can configure SmartConnectors to set a specific severity level for events that match
specific criteria. One typical application is to change the default severity mapping. By
default, SmartConnectors map the device severity (which can contain multiple levels) to
the standard ArcSight severity levels: Very High, High, Medium, and Low.
For example, if a device has eight severity levels (0-7), where 0 is the highest severity,
most likely 0 and 1 are mapped to Very High, 2 and 3 to High, 4 and 5 to Medium, and
6 and 7 to Low. You can change this behavior and make the SmartConnector set the
severity based upon different parameters.
down
The SmartConnector is not connected to the ESM Manager; therefore, no events are
received.
running
The SmartConnector is connected to the ESM Manager; therefore, any events sent are
received.
stopped
The SmartConnector is responding to the ESM Manager, but no events are sent from
the SmartConnector to the Console. When the SmartConnector is stopped, events are
lost.
paused
The SmartConnector is responding to the ESM Manager, but events are being cached
in the SmartConnector. When the SmartConnector is paused, events are cached and
eventually sent to the Manager when the SmartConnector is again active.
For current operational status at any time, in the Connectors resource tree, right-click the
SmartConnector and select Send Command -> Status -> Get Status. The
SmartConnector’s current parameters are displayed in the SmartConnector Status
window.
2 In the Connectors resource tree, right-click the ArcSight SmartConnector you want to
manage and select Configure. The Inspect/Edit panel for the Connector Editor is
displayed. On the Connector tab, the Name field is automatically populated with the
name assigned during SmartConnector Installation, as well as the creation date and
other information.
3 On the Default tab, change any additional Batching, Time Correction, or other
parameters as desired, using the configuration field explanations provided in the
following "Connector Editor Option Tabs" and "Configuration Fields" sections.
4 Click Apply to add your changes and to keep the Connector Editor open. To apply
your changes and close the Connector Editor, click OK, or, if applicable, click Add
Alternate to save your changes as an alternate configuration you can select and
apply later.
These parameters are not localized because they come directly from the SmartConnector
and the SmartConnector may contain new resources (it could be a newer version).
There are several controls you can adjust in the Connector Editor. The variety of options
are best summarized by briefly describing what is available at each of the editor's tabs and
subtabs.
Default: Content Includes options for report batching, aggregation, and time
corrections.
Alternate: Content A set of options identical to those under Default, which you
can use to create alternate configurations.
ANotes: Table A text editor for, and tabular list of, configuration notes.
Notes: List A text editor for, and text presentation of, configuration
notes.
Configuration Fields
You can perform basic configuration tasks through the Connector and Default: Content
tabs. Find their names and values in the tables below.
Name The Name text field is automatically populated with the name
assigned during SmartConnector installation.
External ID An identification string suitable for, and which can be referenced by,
systems outside ArcSight. Common applications of External IDs
include appropriate naming for Case and Asset resources that are
tracked in common with defect reporting or
vulnerability-management systems. Your ArcSight administrator can
advise you on the correct values for this field, if applicable.
Owner An ArcSight user (selected from the Users resource tree) who should
be notified about this SmartConnector.
Notification The ArcSight user groups (selected from the Users resource tree)
Groups who should be notified about this SmartConnector.
Time Correction
Use Connector Time as Yes/No, default is no. Override the time the
Device Time device reports and instead use the time at
which the SmartConnector received the
event. This option assumes that the
SmartConnector is more likely to report the
correct time.
Enable Connector Time The SmartConnector can also adjust the time
Correction (in seconds) reported by the Connector Time
SmartConnector itself, using this setting. This
is for informational purposes only and does
not modify the local time on the
SmartConnector. This should be a temporary
setting. The recommended way to
synchronize clocks between Manager and
SmartConnectors is the NTP protocol.
Device Time The values you set for these fields establish
Auto-correction forward and backward time limits that, if
exceeded, cause the SmartConnector to
automatically correct the time reported by the
device.
Network
Clear Host Names Yes/No, default is yes. If set to yes and the
Same as IP Address host name field is set to an IP Address that
matches the corresponding IP Address field,
then the host name field is cleared. This
affects the source, destination, and device
fields.
Source Zone URI When populated, this field shows the URI of
the zone associated with the
SmartConnector's source address. How this
field gets populated is discussed in the Zones
section of the SmartConnectors topic. This
field is present for v3.0 compatibility. It is not
relevant in v3.5 or v4.0 because of integral
zone mapping.
Source Translated Zone When populated, this field shows the URI of
URI the zone associated with the
SmartConnector's translated source address.
The translation is presumed to be NAT
(network address translation). How this field
gets populated is discussed in the Zones
section of the SmartConnectors topic. This
field is present for v3.0 compatibility. It is not
relevant in v3.5 or v4.0 because of integral
zone mapping.
Destination Zone URI When populated, this field shows the URI of
the zone associated with the
SmartConnector's destination address. How
this field gets populated is discussed in the
Zones section of the SmartConnectors topic.
This field is present for v3.0 compatibility. It is
not relevant in v3.5 or v4.0 because of
integral zone mapping.
Connector Zone URI When populated, this field shows the URI of
the zone associated with the
SmartConnector's address. How this field gets
populated is discussed in the Zones section of
the SmartConnectors topic. This field is
present for v3.0 compatibility. It is not
relevant in v3.5 or v4.0 because of integral
zone mapping.
Device Zone URI When populated, this field shows the URI of
the zone associated with the device's address.
How this field gets populated is discussed in
the Zones section of the SmartConnectors
topic. This field is present for v3.0
compatibility. It is not relevant in v3.5 or v4.0
because of integral zone mapping.
Device Translated Zone When populated, this field shows the URI of
URI the zone associated with the device's
translated address. The translation is
presumed to be NAT (network address
translation). How this field gets populated is
discussed in the Zones section of the
SmartConnectors topic. This field is present
for v3.0 compatibility. It is not relevant in
v3.5 or v4.0 because of integral zone
mapping.
Processing
Enable Aggregation (in Note: If you have already used this feature
seconds) for setting up previous SmartConnectors, you
can continue to do so. However, ArcSight
recommends that you use the new Field
Based Aggregation feature as a more
flexible option. (Please see “Field Based
Aggregation” on page 75.)
Here is the description of the legacy “Enable
Aggregation” feature, for those of you who
are still using it:
When enabled, Enable Aggregation (in
seconds) aggregates two or more events on
the basis of the selected time value.
(Disabled, 1, 2, 3, 4, 5, 10, 30, 60)
The aggregation is performed on one or more
matches for a fixed subset of fields:
• Agent ID
• Name
• Device event category
• Agent severity
• Destination address
• Destination user ID
• Destination port
• Request URL
• Source address
• Source user ID
• Source port
• Destination process name
• Transport protocol
• Application protocol
• Device inbound interface
• Device outbound interface
• Additional data (if any)
• Base event IDs (if any)
The aggregated event shows the event count
(how many events were aggregated into the
displayed event) and event type. The rest of
the fields in the aggregated event take the
values of the first event in the set of
aggregated events.
Enable User Name Yes/No, default is no. If this is set to yes and
Splitting the destination user name contains commas
in the event, this parameter duplicates that
event. Each user name in the list is placed in
one of the events.
For example, if the destination user name in
an event is “User 123, User 456”, then that
event is sent twice, with the destination user
name set to “User 123” in the first and “User
456” in the second.
Split File Name into Yes/No, default is no. If this is set to yes and
Path Name an event’s file name field is set but its file
path field is not, this parameter splits the file
name into a path and a name, placing each
part into appropriate fields.
For example, if the file name field is set to
C:\dir\file.ext and the file path is not set, then
the file path is set to C:\dir and the file name
to file.ext. The separator character can be
either \ or / as the system looks to the
SmartConnector to determine its platform.
Syslog connectors Due to the nature of UDP (the transport protocol used by syslog), these
SmartConnectors can potentially lose events if the configurable event
rate is exceeded. This is because the SmartConnector delays processing
to match the event rate configured, and while in this state, the UDP
cache may fill up, causing the operating system to drop UDP messages.
Note that ArcSight does not recommend using the Limit CPU Usage
option with these SmartConnectors because of this possibility of event
loss.
SNMP connectors Similar to Syslog SmartConnectors, when the event rate is limited on
SNMP connectors, they potentially lose events. SNMP is also UDP-based
and has the same issues as syslog.
Database Since SmartConnectors "follow" the database tables, limiting the event
connectors rate for database connectors can slow the operation of other
SmartConnector. The result can be an event backlog sufficient to delay
the reporting of alerts by as much as minutes or hours. On the other
hand, note that no events are lost, unless the database tables are
truncated. After the event burst is over, the SmartConnector may
eventually catch up with the database if the event rate does not exceed
the configured limit.
SmartConnector
Effects of Limited Usage
Tabs
Proprietary API These SmartConnectors' behavior depends on the particular API (e.g.,
connectors OPSEC behaves differently than PostOffice and RDEP). But in most cases,
there is no event loss unless the internal buffers and queues of the API
implementation fill up. Therefore, these SmartConnectors work much like
database or file SmartConnectors.
Once you have a SmartConnector installed (if not, see Chapter 4‚ Installing and Configuring
SmartConnectors‚ on page 19),
1 Proceed through the SmartConnector Configuration Wizard until you reach the
destination setting window, as shown below.
3 Click Next.
4 Within the Filter Out field of the following screen, enter the string that represents
your setting modification.
While it’s not possible to use the graphical modifiers used within the ArcSight ESM
Console, you can write strings such as the following examples:
name EQ “Agent”
(name Contains “Super”) Or (name EQ “Agent”)
attackerAddress Between (“10.0.0.1”, “10.0.0.10”)
See the table below for a list of usable operators. For additional information regarding data
fields, event mappings, and CEF fields, see the “Data Fields”, “Audit Events”, “Cases”, and
“Events” sections in the ESM User’s Reference.
Usable
Description
Operators
EQ equals
NE not equals
LT less than
GT greater than
Like standard CCE operator for simple pattern matching for string type:
_ wildcard for single character
% wildcard for any number of characters
InGroup for asset in the specified asset category or zone in the specified zone
group.
5 In the Common Conditions Editor, select the relevant conditions from the data fields.
Logic
Description
Operator
= equals
!= not equals
Logic
Description
Operator
Like standard CCE operator for simple pattern matching for string type:
_ wildcard for single character
% wildcard for any number of characters
InGroup for asset in the specified asset category or zone in the specified zone
group.
7 Click OK.
6 Click OK.
2 In the Connectors resource tree, right-click the ArcSight SmartConnector and select
Configure.
3 In the Filtering section on the Advanced tab, right-click a condition and select Delete.
3 In the Connector Configuration Editor, click the following tabs: Connector: Name ->
Default -> Filters.
4 Under the Filters tab, select a severity level event definition from the Filter group:
Filter Out (to drop an event), Very-High, High, Medium, Low, and Unknown.
6 Select the conditions of the severity level from the Common Conditions Editor.
2 In the Connectors resource tree, right-click the ArcSight SmartConnector, select Send
Command, and one of the Status, Connector Process, Event Flow, Network, or
Upgrade menu options described below.
3 The Console's status bar shows a confirmation message when the flow control option
takes effect.
Flow-control
Description
Command
Status
Connector
Process
Flow-control
Description
Command
Event Flow
Network
Upgrade
Flow-control
Description
Command
By default, all SmartConnectors have compression enabled. To turn it off, add the following
line to the ARCSIGHT_HOME\current\user\agent\agent.properties file:
http.transport.compressed = false
You should not delete a SmartConnector resource at the ESM Console unless you first stop
its corresponding SmartConnector. If the SmartConnector on the device is running, but you
delete its resource, the SmartConnector can no longer send events to the Manager. This
causes the SmartConnector to start caching events and, eventually, drop them.
For more detailed information about managing ArcSight SmartConnectors in general, refer
to the ArcSight ESM v4.0 Administrator’s Guide and the ArcSight ESM Console Help.
If hidden, you can display the Navigator panel by selecting Navigator Panel
from the Window menu.
2 In the Connectors resource tree, right-click a group and choose New Group. A Name
text field appears under the group you selected.
4 Click Enter.
4 Click Enter.
2 In the Connectors resource tree, right-click a group and select Edit Group.
3 In the Group Editor, edit the Name and Description text field.
4 Click OK.
3 Select Move to move the group or Link to create a copy of the group linked to the
original group.
If you select Link, you create a copy of the group that is linked to the original group.
Therefore, if you edit a linked group, whether it be the original or the copy, all links are
edited as well. When deleting linked groups, you can either delete the selected group or all
linked groups.
2 In the Connectors resource tree, right-click a group and choose Delete Group.
For more detailed information about managing ArcSight SmartConnectors, refer to the
ArcSight ESM v4.0 Administrator’s Guide and the ArcSight ESM Console Help.
Additional Destinations
ArcSight SmartConnectors send a copy of events to each additional destination for which it
is configured. Additional destinations can be useful, for example, when you have a
development ArcSight environment working in parallel with your production environment
and you want to test rules and reports.
In such cases, you can configure the SmartConnector to send alerts to both your
production Manager and your development Manager to be able to view real-time event
flows on both systems. Because the destinations are independent, you do not compromise
the events sent to the production Manager.
Failover Destinations
A failover destination receives security events from the SmartConnector for which it is
configured only when the primary destination (such as the primary ArcSight ESM Manager)
is not available, or when a network problem occurs. Once these events are backed up in
the failover destination, the SmartConnector caches the events and resends them to the
primary destination.
A failover destination is active only when the primary destination is unavailable, so the
reports and replay features within the secondary Manager could contain incomplete
information. This feature performs as a real-time alternative for severe problems with the
primary ArcSight ESM Manager.
$ARCSIGHT_HOME\current\bin\runagentsetup
2 You can either modify the existing destination or you can add a new destination. For
this example, select Add new destination and click Next.
3 Select the destination type. For this example, select ArcSight Manager (encrypted)
and click Next.
4 Click Add new destination to add a new SmartCOnnector destination and click
Next.
5 Fill in the parameters for the destination you want to add and click Next to finish.
For information about the AUP Master Destination and Filter Out All Events
fields, see related information on page 24.
1 Run the ArcSight SmartConnector Configuration Wizard and select the option I want
to add/remove/modify ArcSight Manager destinations.
4 Select a failover destination type. For this example, select ArcSight Manager
(encrypted) to set up an alterative Manager in case the production Manager fails.
5 Enter the settings for the failover destination and click Next to continue to the next
window.
For information about the AUP Master Destination and Filter Out All Events fields,
see related information on page 24.
Re-Registering a SmartConnector
When the ArcSight Manager recognizes a SmartConnector, it generates an ID token the
SmartConnector uses to identify its security events. If the Manager stops accepting events
from a SmartConnector for an unknown reason, or if you have upgraded a SmartConnector
but its resource was removed from the database, you may need to re-register the
SmartConnector.
To re-register a SmartConnector:
1 Run the ArcSight SmartConnector Configuration Wizard and select the option I want
to add/remove/modify ArcSight Manager destinations.
2 Click Next.
3 Run the ArcSight SmartConnector Configuration Wizard and select your current (Host)
destination. Click Next.
5 Log in with a valid User Name on the ArcSight Manager where you are attempting to
re-register the SmartConnector. Click Next.
SmartConnectors are the interface between the ArcSight ESM Manager and the network
devices that generate ESM-relevant data on your network.
SmartConnectors collect event data from network devices, then normalize this data in two
ways. First, they normalize values (such as severity, priority, and time zone) into a common
format. They then normalize the data structure into a common schema. SmartConnectors
can filter and aggregate events to reduce the volume sent to the
ESM Manager, which increases ArcSight's efficiency and reduces event processing time.
For installation information and device-specific configuration and mapping information, see
the SmartConnector Configuration Guide for the specific device.
File Connectors
There are two primary types of log file connector, Real Time and Folder Follower:
Real Time
These connectors can continue to follow a log file that retains its name or changes its
name based upon the current date and other factors. The type of real time file
connector is based upon the number of files monitored by the connector. There are
connectors that monitor a single log file, such as the Snort File connector and
connectors that monitor multiple log files, such as the Cisco Secure ACS and SAP Real
Time Audit connectors.
Real Time log file connectors can read normal log files in which lines are separated by
a new line character as well as fixed length records in which a file consists of only one
line but multiple records of fixed length (such as the SAP Real Time Audit connector).
Folder Follower
Folder follower connectors can follow files deposited into a single folder. There are
connectors that monitor a single log file (such as HP-UX or IBM AIX) and connectors
that monitor log files recursively (such as F-Secure AntiVirus).
.txt and .xml file types are supported by ArcSight SmartConnectors; which type
depends upon the particular device. Text log files are the most common; however,
Tripwire and most of the scanner file connectors, such as Nessus, nCircle, and
NeXpose are in xml format.
The type of log file connector is not usually part of the connector name unless both types
of connector exist for a particular device (such as SAP Audit and SAP Real-Time Audit).
Connectors are normally installed on the device machine, but when the monitored files are
accessible through network shares or NFS mounts, the connectors can be installed on
remote machines.
For some connectors, a trigger file is required to tell the connector when the file is
complete and ready for processing. Typically, this is the same file name with a different
extension.
Generally, the only parameter required at installation is the location of the log file or files
(the absolute path). When default file paths are known, they appear in the installation
wizard.
McAfee VirusScan
Microsoft DHCP
Microsoft Exchange Message Tracking Log
Microsoft IIS, IAS, ISA, and SQL Servers
Symantec NetRecon
Network Appliance NetCache
NFR Central Management and Sentivist Servers
Nmap
Oblix NetPoint
OVAL
Rapid7 NeXpose
SAP Security Audit
Secure Computing SafeWord and Webwasher
Snort
Squid Web Proxy Server
Sun ONE Directory and Web Servers
Symantec AntiVirus Corporate Edition
Symantec Gateway Security/Enterprise Firewall
Symantec Intruder Alert
Tenable Nessus
Tripwire Manager
Database Connectors
Database connectors use SQL queries to periodically poll for events. ArcSight
SmartConnectors support major database types, including MS SQL, MS Access, MySQL,
Oracle, DB2, Postgres, and Sybase.
In addition to the native JDBC driver for each database type, database connectors allow
the use of a JDBC ODBC driver for databases that support them, such as MS SQL, Postgres,
and MS Access. To use a JDBC ODBC driver, a JDBC ODBC data source is required.
During installation, the installation wizard will ask for at a minimum the following
parameters:
Time-Based
Queries use a time field to retrieve events found since the most recent query time until
the current time.
ID-Based
Queries use a numerically increasing ID field to retrieve events from the last checked
ID until the maximum ID.
Job ID-Based
Queries use Job IDs that are not required to increase numerically. Processed Job IDs
are filed in such a way that only new Job IDs are added. Unlike the other two types of
database connector, Job IDs can run both in GUI or Interactive mode as well as in
Automatic mode.
Scanner Connectors
There are two types of scanner connector whose results are retained in a file, making them
log file connectors:
XML files (such as Tenable Nessus, nCircle Audit, Qualys Scanner, and Rapid7
NeXpose)
Text files (such as Tenable Nessus NSR, NetRecon NRD)
Other scanners deposit there events in a database per scan and are treated as database
connectors, requiring the same installation parameters as database parameters.
Scan reports or jobs are converted into base events that can be viewed on the ESM
Console, and aggregated meta events that are not shown on the console. Meta events
create assets, asset categories, open ports, and vulnerabilities on the ESM Console.
Interactive mode
Displays the scan reports or scan jobs that can be individually selected to be sent to
the connector. This mode is not supported for a connector running as a service.
Automatic mode
Checks periodically for any new reports deposited into the folder or any new jobs
inserted into the database, then processes them. This mode is supported for both
stand-alone applications and services.
Other than the operating mode, other parameters required for scanner installation depends
upon whether a file or database connector has been implemented. For file connectors, the
absolute path to and name of the log file is required. For database connectors, see
“Database Connectors” on page 103.
API Connectors
API connectors use a standard or proprietary API to pull events from devices. In most
cases, a certificate must be imported from the device to authenticate connector access to
the device. There are also a number of configuration steps required on the device side. For
example, Check Point devices require connection type configuration and importing a
certificate, Sourcefire eStreamer devices require adding a client, configuring a certificate,
configuring event types to be sent, and so on.
During installation, the installation wizard will ask for the following types of
parameters, although each device's parameters are specific to its API:
Device IP
Service Port
CA eTrust SiteMinder
Check Point Firewall and VPN OPSEC NG
Cisco Secure IDS and IPS devices
HP OpenView Operations MSI
McAfee Entercept
Microsoft Auditing Collection System
QoSient ARGUS
Solaris Basic Security Module (BSM)
Solsoft Policy Server
Sourcefire Defense Center eStreamer
SNMP Connectors
SNMP Traps contain variable bindings, each of which holds a different piece of information
for the event. They are usually sent over UDP to port 162, but the port can be changed.
SNMP connectors listen on port 162 (or any other configured port) and process the
received traps. They can process traps only from one device with a unique Enterprise OID,
but can receive multiple trap types from this device.
As with syslog connectors (because SNMP is based upon UDP), there is a slight chance of
events being lost over the network.
Parsers use the knowledge of the MIB to map the event fields, but, unlike some of the
other SNMP-based applications, the connector itself does not need the MIB to be loaded.
For details about the new Unified connector, see the SmartConnector Configuration Guide
for Microsoft Windows Event Log – Unified. Mappings for this connector are incorporated
into its configuration guide.
The SmartConnector for Microsoft Windows Event Log – Unified supports event collection
from Microsoft Windows XP, Server 2000, Server 2003, and beta support for Microsoft Vista
and Server 2008 platforms, as well as beta support for partial event parsing based upon
the Windows event header for all System and Application events as well as support for a
FlexConnector-like framework that enables users to create and deploy their own parsers for
parsing the event description for all System and Application events.
Some individual Windows Event Log applications are supported by the SmartConnector for
Microsoft Windows Event Log – Domain, for which Windows Event Log sub-connectors
have been developed. These sub-connectors have individual configuration guides that
provide setup information and mappings for the particular application. These sub-
connectors include:
CA eTrust AntiVirus
Microsoft Active Directory Service
Microsoft WINS
Oracle Audit
RSA ACE Server
Symantec Mail Security
Syslog Connectors
Syslog messages are free-form log messages prefixed with a syslog header consisting of a
numerical code (facility + severity), timestamp, and host name. They can be installed as a
syslog daemon, pipe, or file connector. Unlike file connectors, a syslog connector can
receive and process events from multiple devices. There is a unique regular expression that
identifies the device.
Syslog Daemon connectors listen for syslog messages on a configurable port, using
port 514 as a default. It is the only syslog option supported for Windows platforms.
Syslog Pipe connectors require syslog configuration to send messages with a certain
syslog facility and severity. Solaris under-performs when using Syslog Pipe connectors.
The operating system requires that the connector (reader) open the connection to the
pipe file before the syslog daemon (writer) writes the messages to it.
When using Solaris and running the connector as a non-root user, using a Syslog Pipe
connector is not recommended. It does not include permissions to send an HUP signal
to the syslog daemon.
Syslog File connectors require syslog configuration to send messages with a certain
syslog facility and severity. For high throughput connectors, Syslog File connectors
perform better than Syslog Pipe connectors because of operating system buffer
limitations.
UNIX supports all three types of syslog connector. If a syslogd process is already running,
you can "kill" it or run the daemon connector on a different port.
Because UDP is not a reliable protocol, there is a slight chance of missing syslog messages
over the network. TCP is now a supported protocol for syslog connectors.
There is a basic syslog connector, the SmartConnector for UNIX OS Syslog, which provides
the base parser for all syslog sub-connectors.
For syslog connector deployment information, see the configuration guide for this
SmartConnector.
For device-specific configuration information and field mappings, see the
SmartConnector Configuration Guide for the specific device. Each syslog sub-
connector has its own configuration guide.
During connector installation, for all syslog connectors, choose Syslog Daemon, Syslog
Pipe, or Syslog File from the installer selections rather than the name of the syslog sub-
connector.
Syslog connectors include, but are not limited to, the following devices:
AirDefense Enterprise
AirMagnet Enterprise
Alcatel
Apache HTTP Server
Arbor Peakflow
Aruba
Barracuda Spam Firewall
Blue Coat Proxy SG
BroadWeb NetKeeper
Flex Connectors
ArcSight FlexConnectors allow you to create custom SmartConnectors that can read and
parse information from third-party devices and map that information to ArcSight’s event
schema. When creating a custom SmartConnector, you define a set of properties (a
configuration file) that identify the format of the log file or other source that will be
imported into the ArcSight Manager or ArcSight Logger.
Other Connectors
Some connectors use multiple mechanisms. For example, the SmartConnector for Oracle
Audit monitors both the database tables and audit files. Other examples of connectors with
multiple mechanisms include:
NetFlow
Retrieves data over TCP in a Cisco-defined binary format.
Payload support is available with current SmartConnector versions. Payload refers to the
information carried in the body of an event's network packet, as distinct from the packet's
header data.
Introduction
Extra information can be retrieved by using the on-demand payload feature on the ArcSight
ESM Console. Click on any of the vulnerability events sent by the SmartConnector and you
will see in the Event Inspector that Payload data is available; click on the Payload tab and
you can see additional information including Description and Recommendation. For
services events, you will receive Description and Detail.
You can retrieve, preserve, view, or discard payloads using the ArcSight Console. Because
event payloads are relatively large, ArcSight does not store them by default. Instead, you
can request payloads from devices for selected events through the Console. If the payload
is still held on the device, the ArcSight SmartConnector retrieves it and sends it to the
Console.
Payloads are downloaded and stored only on demand; you must configure ArcSight ESM to
log these packets. By default, 256 bytes of payload are retrieved.
Whether an event has a payload to store is visible in event grids. Unless you specifically
request to do so, only the event's "payload ID" (information required to retrieve the
payload from the event source) is stored. Payload retention periods are controlled by the
configuration of each source device.
To retrieve payloads, in a Viewer panel grid view, double-click an event with an associated
payload. In the Event Inspector, click the Payload tab, then click Retrieve Payload.
To preserve payloads, in a grid view, right-click an event with an associated payload, select
Payload, then Preserve. Alternatively, in the Event Inspector, click the Payload tab, then
the Preserve Payload icon.
To discard payloads, in a grid view, right-click an event with an associated payload, select
Payload, then Discard Preserved. You also can use the Event Inspector: In a grid view,
double-click an event with an associated payload. In the Event Inspector, click the Payload
tab, then click the Discard Preserved Payload icon.
To save payloads to files, in a grid view, double-click an event with an associated payload.
In the Event Inspector, click the Payload tab. Click the Save Payload icon. In the Save
dialog box, navigate to a directory and enter a name in the File name text field. Click
Save.
The information in this appendix applies only to SmartConnectors used with ArcSight ESM
v4.0. The following topics are discussed:
Summary
This appendix explains how to capture events a SmartConnector normally would send to
the ArcSight ESM Manager into a file. This is an advanced topic; typical ArcSight
configurations do not require the use of external files to communicate events to the
ArcSight ESM Manager.
#event.eventName,event.attackerAddress,event.targetAddress
Event data is written to files in the specified folder and can be configured to rotate
periodically.
Installation
To create a SmartConnector that logs security events in a CSV file rather than forwarding
them to an ArcSight ESM Manager:
2 When the wizard asks whether the Manager is using a demo certificate, click the
Cancel button.
3 When asked for confirmation that you are exiting early, click Yes.
4 Use a text program to create a new file named agent.properties in the directory
$ARCSIGHT_HOME\current\user\agent\.
transport.default.type=file
6 At the point where the SmartConnector Configuration Wizard ordinarily asks about the
Manager certificate, a new window is displayed that contains parameters for the CSV
file transport.
CSV Path The path to the output folder. If it does not exist, the folder is
created.
File rotation The desired file rotation interval, in seconds. The default is 3,600
interval (one hour).
Write format Select true to send a header row with labels for each column, as
header described above.
After you enter the file trans port parameters and click Continue, the SmartConnector
Configuration Wizard proceeds as usual.
Event files are named using the timestamp of their creation, and all files, with the
exception of the current file, have the text '.done' appended. For example, a typical CSV
file set configured to rotate every hour might consist of files named in this manner:
2007-01-28-10-55-33.csv
2007-01-28-09-55-33.csv.done
2007-01-28-08-55-33.csv.done
Using the properties file, you can customize the configuration of your CSV SmartConnector
to filter and aggregate events as desired.
You also can configure a SmartConnector to send events to a CSV file and an ESM Manager
at the same time.
This appendix details the different ArcSight Update Packs (AUPs) used in updating content
to and from the ArcSight Manager and ArcSight SmartConnectors. AUP files may contain
information that applies to SmartConnectors or ESM related updates.
Defining an AUP
AUP files provide a way to collect a set of files together and update ArcSight resources as
well as distribute parsers to ArcSight SmartConnectors.
For some AUPs, ArcSight provides downloadable packages of new content available to
subscribing customers. You can obtain a content subscription through ArcSight Sales or
Customer Support. Subscribers also have access to related articles in the ArcSight
Customer Support Center's Knowledge Base.
The download files are offered through a special subdirectory on the ArcSight software
server. The directory is visible only to subscribers, who receive a notification e-mail from
ArcSight Customer Support when files are posted.
All existing content is included with major product releases, but it is possible to stay
completely current by receiving up-to-date, regular content updates via Arcsight
announcements and the Customer Support website
(https://software.arcsight.com). Under "Content Subscription Downloads", the
files are located in "RELEASE3.X".
As shown below, the method of uploading an AUP varies depending on the ArcSight
product.
ArcSight ESM
As an ArcSight customer, you will receive an e-mail notification about content updates from
ArcSight support. To update,
1 Download the latest AUP release from the Customer Support website
(https://software.arcsight.com).
ESM/Logger
A SmartConnector can send events to ArcSight ESM and Logger simultaneously. In this
configuration, it’s helpful to use the AUP Master Destination feature. AUP Master
Destination allows ESM to push AUP content to the SmartConnector used for its Logger
destination(s). Logger is not capable of storing or pushing its own AUP content.
1 Using the SmartConnector Configuration Wizard, add the ESM destination and set the
AUP Master Destination parameter to true (the default is false).
2 If you have not already done so, you can also add the Logger destination.
The AUP content is pushed from ESM to the SmartConnector, which then sends an internal
event to confirm. Since the AUP Master Destination flag was set for the ESM destination,
that AUP content is used by the SmartConnector for Logger or any other non-ESM
destinations.
The AUP Master Destination flag should be set to true for only one ESM
destination at a time. If more than one ESM destination is set and the flag is
true for more than one, only the first is treated as master.
Logger
Logger has no facility to store or forward AUPs to SmartConnectors.
Connector Appliance
Connector Appliance does not support automatic deployment of an AUP. This feature will
be included in future releases. Please call customer support for assistance.
3 From the ArcSight Console, select connectors to be upgraded (one at a time) and
launch the upgrade command for each of them.
4 Upon receipt of the upgrade command, the selected connectors upgrade themselves,
restart, and send upgrade results (success or failure) back to the ArcSight Console
through the ArcSight Manager.
a If the upgrade is successful, the new connector starts and reports a successful
upgrade status. (The upgraded connector runs in the same home directory as the
old one.)
Connector Appliance
Uploading an AUP through Connector Appliance is performed through it’s web-based user
interface. From the Advanced Operations tab, the Connector Upgrade Repository
displays upgrades that have been uploaded using the Connector Upgrade command.
1 Download the latest AUP release from the Customer Support website (at
https://software.arcsight.com).
2 From the Advanced Operations tab, click Upgrade, and then click the Upgrade
Repositories sub-tab.
The next step is to push this upgrade to one or more containers. To push the upgrade
.aup to a container(s),
2 Click the check box for container(s) that you wish to upgrade.
5 Click Save.
For more detailed information about Connector Appliance, see the Connector Appliance
Administrator's Guide.
As System Zones are always present, all SmartConnectors connected to ESM routinely
receive them as an AUP.
ArcSight offers an optional feature called the FlexConnector Development Kit (SDK),
which can assist you in creating a custom SmartConnector for your device.
ArcSight can create a custom SmartConnector; contact ArcSight Customer Support for
more information.
My device is on the list of supported products; why doesn't it appear in the
SmartConnector Configuration Wizard?
SmartConnectors are installable based upon the operating system you are using. If your
device is not listed, either it is not supported by the operating system on which you are
attempting to install, or your device is served by a Syslog server and is, therefore, a syslog
sub-connector. To install a Syslog SmartConnector, select Syslog Daemon, Syslog Pipe,
or Syslog File during the installation process.
Check that event filtering and aggregation setup is appropriate for your needs.
Check that the two separate turbo modes for the SmartConnector and the ArcSight ESM
Manager are compatible for the specific SmartConnector resource. If the Manager is set for
a faster turbo mode than the SmartConnector, some event details will be lost. See
"“Understanding ArcSight Turbo Modes” on page 17 for detailed information.
Check the SmartConnector log for errors. Also, if the SmartConnector cannot communicate
with the Manager, it caches events until its cache is full. A full cache can result in the
permanent loss of events.
How can I get my database SmartConnector to start reading events from the
beginning?
agents[0].startatdate=01/01/1970 00:00:00
agents[0].startatid=0
When events are cached and the connection to the Manager is re-established,
which events are sent?
Events are sent with a 70% live and 30% cached events ratio. If live events are not arriving
quickly, the percentage of cached events can be higher. This can reach 100% if there are
no live events.
Also, if the settings dictate that certain event severities are not sent at the time connection
is restored, those events are never sent. This is true even if they were originally generated
(and cached) at a time when they would ordinarily go out.
Why does the status report the size of the cache as smaller than it should be?
For example, I know that a few events have been received by the
SmartConnector since the Manager went down, yet the report marks events as
zero.
Some of the events are in other places in the system, such as the HTTP transport queue.
Shut down the SmartConnector and look at the cache size in the .size.dflt file to confirm
that the events are really still there.
Why does the estimated cache size never change in some SmartConnectors?
Why is the estimated cache size negative in others?
The estimated cache size is derived from a size file that gets read at startup and written at
shutdown. If the SmartConnector could not write the size at shutdown (for example, due to
an ungraceful shutdown, disk problem, or similar problem) the number could be incorrect.
Newer versions will attempt to rebuild this cache size if they find it to be incorrect, but
older builds do not.
The SmartConnector detects that there is no size file and re-builds the cache size by
reading all the cache files.
You can change the folder to contain the SmartConnector cache by adding the following
property in agent.properties:
agentcache.base.folder=<relative-folder-path>
ArcSight Manager performs auto time correction for older events. If the end time is older
than your retention period, it is set automatically to that lower bound. A warning is
displayed and an internal event with the same message is sent to you.
Yes.
Kiwi adds a prefix with the original address. For example, the message:
is converted to
The SmartConnector strips out the prefix and uses myoriginalhost as the Device
Host Name.
status.watermark.stdoutkeys=AgentName,Events
Processed,Events/Sec(SLC),Estimated Cache
Size,status,throughput(SLC),hbstatus,sent
status.watermark.stdoutkeys.alias=N,Evts,Eps,C,ET,T,HT,S
The SLC stands for Since Last Check, which means "in the last minute," assuming
status.watermark.sleeptime=60 has not been overridden.
EVTS is an acronym for Events Processed and EPS is an acronym for Events/Sec(SLC).
Does a file reader SmartConnector reading files over a network share display
errors when the network share is disconnected? How can I recognize which
error message refers to which file in agent.log and agent_out_wrapper.log?
If the network share is a Linux/UNIX NFS mount or a Windows network mapped drive, the
file reader SmartConnector displays errors in the agent log.
If files are being read using a Windows UNC path that does not require network mapping,
the file reader SmartConnector cannot detect a network connection loss.
Error messages related to file access contain the file name, but error messages related to
log line parsing do not.
This depends upon the SmartConnector you are using. Some log file connectors process
files sequentially and others process log files in parallel.
After reading a log file, can a SmartConnector move them using NFS?
Yes. Folder Follower connectors can rename or move the files using NFS, as long as the
folders containing the log files give the correct permissions for the SmartConnector.
To establish a network share to a remote machine, you can use network mapping on
Windows platforms, and NFS or Samba mounting on Linux/UNIX platforms.
If you are running the SmartConnector as a Windows service, access privileges to the
network share are required. To access the user name and password panel:
3 Double-click Services.
5 Click the Log on tab, and enter the user name and password for the user with access
permissions to the file share. Specify the file path using UNC notation, not as a
network mapped drive.
agent.mainevent.component.com.arcsight.agent.loadable._DOSProtecto
r.enabled=false
These rates are subjective and depend upon the system resources, number of devices,
number of events, and so on. ArcSight recommends limiting each SmartConnector to 500
eps to allow for growth.
These limitations are subjective and depend upon system resources, number of devices,
number of events, and so on.
The SmartConnector can access as many log files as it is configured with. The folders are
processed in parallel.
There is no hard and fast maximum. The Manager has a restriction of 64 concurrent
SmartConnector threads by default. The more threads you add, the more it affects
performance, because there is more thread context-switching overhead. The general
recommendation is to definitely stay lower than the triple-digit range.
If enough memory is available (256 MB per SmartConnector by default plus at least 256 MB
for the operating system), SmartConnectors are usually CPU bound. Therefore, the number
of SmartConnectors you can install on a single box depends upon the number of events per
second that all the SmartConnectors are to process.
It also depends upon how many eps' the combined SmartConnectors will be processing.
For example, if you have the Check Point, RDEP, and Syslog SmartConnectors and, when
combined, they process fewer than 500 eps, a dual Pentium IV with 2GB Ram would be
enough (and it would let you process bursts of about 2-times if needed, amounting to 1000
eps).
However, the SmartConnector for Check Point itself, for example, could easily go beyond
1000 eps. If that is the case with one or more of the SmartConnectors, you most likely
need at least two SmartConnector boxes; one for a SmartConnector that goes beyond 1000
eps, and another one for RDEP and syslog. RDEP usually is under 100 eps, but syslog can
go anywhere from 10 eps to more than 1000 eps; you need to know the expected volume
before sizing the hardware.
An easy rule of thumb is to limit each SmartConnector to 500 eps, which should give you
some room to grow.