FlowTraq® 18.12 Documentation

FlowTraq, A Riverbed Company

Copyright © 2009-2018 FlowTraq, A Riverbed Company

1. Introduction

1.1. System Overview

1.2. Support, Training, and Professional Services

1.2.1. Technical Support
1.2.2. Training and Professional Services

1.3. Change Log

1.3.1. Changes in FlowTraq 18.12
1.3.2. Changes in FlowTraq 18.2
1.3.3. Changes in FlowTraq 17.7
1.3.4. Changes in FlowTraq 17.2
1.3.5. Changes in FlowTraq Q3/16
1.3.6. Changes in FlowTraq Q2/16
1.3.7. Changes in FlowTraq Q1u1/16
1.3.8. Changes in FlowTraq Q1/16
1.3.9. Changes in FlowTraq Q4/15
1.3.10. Changes in FlowTraq Q3/15
1.3.11. Changes in FlowTraq Q2/15
1.3.12. Changes in older versions of FlowTraq

2. Installation

2.1. System Requirements

2.1.1. Server Hardware Requirements
2.1.2. Platform Requirements

2.2. Deploying the Virtual Appliance

2.2.1. Memory and Disk
2.2.2. Using a remote FlowTraq server

2.3. FlowTraq Server Daemon Installation

2.3.1. Preparing For Installation
2.3.2. Windows
2.3.3. Unix (including Mac OS X)

2.4. Installing the Web Portal

2.4.1. Software Prerequisites
2.4.2. Installation Overview
2.4.3. Detailed Installation Guides
2.4.4. Troubleshooting
2.4.5. Access

2.5. Upgrading FlowTraq

2.5.1. Upgrading to Q3/15 or Later
2.5.2. FlowTraq Virtual Appliance
2.5.3. Windows (Server only)
2.5.4. Mac OS (Server only)
2.5.5. Linux (Server and FlowTraq Web)

2.6. FlowTraq Desktop Client

2.6.1. Preparing For Installation
2.6.2. Windows
2.6.3. Mac OS X
2.6.4. Unix

2.7. Designing and configuring Archive storage

2.8. Initial Configuration

2.8.1. FlowTraq Login
2.8.2. Entering a License Key
2.8.3. Changing your Password

2.9. Backing up a FlowTraq Install

2.9.1. Full Backup
2.9.2. Compact Backup (Configuration Only)
2.9.3. Restoring from Backup

2.10. Migration

2.11. Automatic Denial of Service (DOS) Mitigation

3. Operation

3.1. Getting Started

3.1.1. Verifying Your Exported Data
3.1.2. Describing Your Network for FlowTraq
3.1.3. Creating an Alert Policy
3.1.4. Next Steps

3.2. FlowTraq User Interface

3.2.1. The Dashboard
3.2.2. The Workspace

3.3. Policies and Alerting

3.3.1. Policy Page Overview
3.3.2. Alerting

3.4. Command Line Interface

3.4.1. Overview
3.4.2. Retrieving Raw Session Data from the Command Line with ftsq
3.4.3. Time Navigation
3.4.4. Filter String Syntax
3.4.5. Retrieving Statistical Queries from the Command Line with ftstat
3.4.6. Assigning Friendlynames from the Command Line with ftname
3.4.7. Generating IPFIX with ftsq
3.4.8. Session Key Reauthentication
3.4.9. Server Health Monitoring With ftum

4. Administration

4.1. Partition Management

4.1.1. Defining Internal Blocks
4.1.2. Assigning Flows to Partitions
4.1.3. Managing Partitions from the Command Line with ftgroup

4.2. User Management

4.2.1. Managing Users in FlowTraq
4.2.2. Managing Users from the Command Line with ftum
4.2.3. Configuring LDAP External Authentication
4.2.4. Configuring TACACS+ External Authentication

4.3. Email Reporting Configuration

4.3.1. Global Configuration

4.4. Traffic Group Management

4.4.1. Traffic Group Creation
4.4.2. Traffic Group Deletion
4.4.3. Traffic Group Statistics

4.5. Flow Deduplication Using Rings

4.6. Advanced Server Administration

4.6.1. Starting and Stopping FlowTraq Server
4.6.2. Backing Up the Session Database
4.6.3. Clearing the FlowTraq Session Database
4.6.4. The FlowTraq Server Configuration File: flowtraq.conf
4.6.5. Host Status

4.7. Cluster Administration

4.7.1. FlowTraq Portal Node Status
4.7.2. Adding Nodes
4.7.3. Removing Nodes
4.7.4. Configuring Syslog Export of System Status
4.7.5. Troubleshooting

4.8. NetFlow Export Configuration

4.8.1. Cisco Device Configuration
4.8.2. VMWare vSphere 5.1 (or later)
4.8.3. Open VSwitch SDN
4.8.4. Using Flow Exporter

5. Appendices

5.1. FlowTraq Web API Reference

5.1.1. Version 3
5.1.2. Version 2
5.1.3. Version 1

5.2. FlowTraq Mitigation Plugins

5.2.1. Overview
5.2.2. Manual Plugin Installation
5.2.3. Alerting Process and Arguments
5.2.4. Alert Annotation
5.2.5. Plugin Files

5.3. Legal Notices

5.3.1. END USER LICENSE AGREEMENT FOR FLOWTRAQ
5.3.2. Third-Party Software Components