This chapter contains information for installing and setting up the Analyzer and its associated modules. The following topics are covered in this chapter:
Analyzer Version 3.5 is designed to operate with FlowCollector Version 3.5. Table 2-1 shows the currently supported combinations of releases for the FlowCollector and the Analyzer.
Note that the Analyzer can display traffic data that was collected by the latest or any previous version of the FlowCollector.
|Version of Analyzer||Version 1.0 FlowCollector||Version 2.0 FlowCollector||Version 3.0 FlowCollector||Version 3.5 FlowCollector|
This section outlines the requirements for the NetFlow-enabled devices configured into your network and for each instance of the Analyzer that you intend to run in the network. It also presents the setup procedures for bringing the Analyzer to its initial operating state.
The NetFlow-enabled devices in your network must be running Cisco IOS Release 12.0(3)T or higher, or Release 12.0(6)S to process Version 8 export data for the new on-router aggregation schemes (see the "New in This Release" section).
The TMS-enabled devices in your network must be running Cisco IOS Release 12.0(5)S, or higher.
The software requirements for using the Analyzer are listed below:
Alternatively, you can set these utility programs to be accessible to the Analyzer by means of appropriate entries in the $PATH environment variable for each host Analyzer platform.
If you elect to run the Display module separately on a PC (apart from the host Analyzer workstation), the PC must be an Intel Pentium class machine with at least a 166 MHz CPU and must contain 64 MB or more of RAM.
The workstation on which you run the Analyzer must meet the following requirements:
|Note During the installation process on a Solaris system, an additional 50 MB of disk space is temporarily required on the /var directory.|
|Caution To eliminate potential data loss and prevent performance degradation during NetFlow data collection and processing, it is recommended (but not mandatory) that you install the FlowCollector and the Analyzer on different workstations.|
This section presents the setup procedures for bringing the Analyzer to its initial operating state.
To install Analyzer Version 3.5 from the distribution CD-ROM, perform the following steps:
$ su root password: password
Step 2 Depending on your installation platform, do one of the following:
For Solaris, copy the tar file from the distribution CD-ROM to the temporary directory and untar the file, as shown below:
# cp NDA3_5.SOL.tar
# tar -xvf NDA3_5.SOL.tar
For HP-UX, copy the Tar file from the distribution CD-ROM to the temporary directory and untar the file, as shown below:
# cp NDA3_5.HP_11.tar
# tar -xvf NDA3_5.HP_11.tar
Step 3 Run the Analyzer installation script, as shown below, and answer all questions in the script.
$ chmod +x NDA3_5.setup.sh $ ./NDA3_5.setup.sh ./NDA3_5. platform.Z
where platform is SOL or HP_11.
You have completed all of the required initial installation and setup procedures for using the Analyzer. If you want to skip the procedures in the "Optional Setup Procedures" section below, and the "Setting Time Zones for the FlowCollector" section, you can go directly to the "Starting the Analyzer" section.
After completing the initial installation and setup procedures presented above, you can
This section describes how to customize the Display module, which provides the user interface for the Analyzer.
You can install the Display module on any workstation or PC in the network, or on several platforms, provided that each such platform meets the Display module installation requirements.
To install the Display module on your PC, perform the following steps on the workstation:
$ su root
Step 2 Change the protections for Display module files and subdirectories:
# chmod 777 -R /opt/CSCOnfa/NFADisplay
Step 3 Copy all the Display module files and subdirectories (i.e., /opt/CSConfa/NFADisplay) to the PC. If desired, you can use the tar command and WINZIP for this process.
|Note Do not use FTP for the copy because recursiveness of the copy and all subdirectories is not guaranteed.|
You can configure the Display module to run independently on a workstation or a PC apart from the other Analyzer modules.
After completing the installation script (as described earlier in the "Installing and Running the Analyzer" section), you can customize the Display module to run in your particular networking environment by editing one of the following files:
The start.Display and startPC_Display.bat files are located in the directory /opt/CSCOnfa/NFADisplay/bin/.
The switches and arguments that you can specify in the start.Display file for the Display module are described in Table 2-2. You can modify certain switch arguments to customize the Display module to suit your particular operating needs. However, you should be aware of the effects of changing any of the default values listed for the switches in Table 2-2.
|Switch Name||Description of Editable Argument|
The argument to this switch is the name of the browser executable that you intend to use to view the Analyzer's Help system. If the name of the browser is not referenced in your $PATH environment variable, this switch argument must reference the full path name of the browser executable.
This switch refers to the default directory, /opt/CSCOnfa/NFADisplay/bin, in the host workstation or PC where the Display module's Java classes are stored. Do not change the name of this directory.
Use the argument to this switch to identify a user-created file that contains a working tree structure appropriate to your Analyzer operating domain. After you create this file and reference it as an argument to the defaultreefile switch, the working tree structure in this file is loaded by default into the Netflow Data area of the Display module window during startup. This working tree structure can refer to a single network device or a defined group of devices (routers or switches). The latter case enables you to enter Display module commands that act on group members as a whole for data retrieval and analysis. By defining a default tree file that is automatically loaded during Display module startup, you avoid the repetitive tasks associated with manually adding data set paths to the Netflow Data area of the Display module window. The procedure for loading a default tree file is in the "Loading a Tree File" section.
IP address or name of the workstation on which the DisplayServer will be running. You must change the placeholder value DISPLAYSERVERHOST to the host name or IP address where the DisplayServer will be running.
Port on which the DisplayServer listens for network commands. The default port number is 7544.
Height (in pixels) of the Display window. The default is 600 pixels.
The argument to this switch is the name of the directory containing the Analyzer's Help files. On the Solaris platform, this parameter defaults to /opt/CSCOnfa/NFADisplay/help.
This switch does not require any arguments. This switch disables the automatic pop-up of the Tips help boxes in the Search, ASDrillDown, and Main windows.
IP address or name of the workstation on which the UtilityServer will be running. You must change the placeholder value UTILITYSERVERHOST to the host name or IP address where the UtilityServer will be running.
Port on which the UtilityServer listens for network commands. The default port number is 7545.
Width (in pixels) of the Display window. The default is 800 pixels.
After you install the Analyzer (see the "Installing and Running the Analyzer" section), you can perform the following steps to customize the UtilityServer module:
$ su root password: password
Step 2 Use the TCP default port number (7545) for running the UtilityServer module.
If you want to use a different port number for the UtilityServer, you must edit the /opt/CSCOnfa/NFAUtility/bin/NFAUS.resources file to add the following line:
where portnum is the number of the port you want to use instead of the default value 7545.
Step 3 Create the configuration files described in the "Managing UtilityServer Configuration Files" section below.
|Note The UtilityServer module writes data to several output subdirectories under the /opt/CSCOnfa/NFAUtility directory. The logs directories must be periodically checked for errors and purged. For more information about these tasks, refer to the "Maintaining UtilityServer Output Directories" section.|
Use the directory /opt/CSCOnfa/NFAUtility/config to store the following user-defined configuration files:
You create these files and enter appropriate configuration information, as described below.
Use this file to map Internet host IP addresses to aliases (that is, the names of individual, manageable network devices).
When the Analyzer needs to convert IP addresses to the aliases of host devices, it checks the contents of the HostPreferences.txt file first. Aliases for hosts not listed in this file are determined by means of Domain Name System (DNS) lookup.
Use the following format in creating each line of the HostPreferences.txt file:
18.104.22.168 ksharko-sun.cisco.com 22.214.171.124 dummy 126.96.36.199 dummy2.cisco.com
Create this file only if you used the RouterAliases.txt file in Version 2.0 of the Analyzer. You can copy the Version 2.0 RouterAliases.txt file into the /opt/CSCOnfa/NFAUtility/config directory.
The UtilityServer module reads the contents of the RouterAliases.txt file to configure router aliases.
This file contains a list of routers (arranged by IP addresses) and their associated SNMP read community.
The UtilityServer module uses the information in this file to communicate with routers in the network when NetFlow data is being collected.
Use the following format in creating each line of the RouterConfig.txt file:
router_IP_address SNMP_community netflow
188.8.131.52 public netflow 184.108.40.206 public netflow 220.127.116.11 public netflow
In all cases, enter "netflow" following the SNMP_community parameter of each line in the RouterConfig.txt file.
This section describes how you can alter the behavior of the DisplayServer module to suit your NetFlow data analysis needs by changing some of the parameters in the NFADS.resources file. For example, you can customize the DisplayServer module to
|Note See the "Calculating Available Memory and Adjusting the MaxMB Value" section to determine how much logical memory is available on your Analyzer workstation or PC and how to fine-tune the platform for efficient memory use.|
The NFADS.resources file of the DisplayServer module contains configuration parameters that you can customize according to your NetFlow data processing requirements (see Table 2-3).
When you change the configuration parameters in the NFADS.resources file from their default values, observe the following rules:
1. You must redefine one parameter per line.
2. Parsing stops at the first blank line encountered in the file.
3. Any line that does not start with a valid parameter key word (see Table 2-3) is treated as a comment and ignored.
4. If a parameter is defined more than one time, the last such parameter definition encountered in the NFADS.resources file takes precedence.
Table 2-3 describes the parameters in the NFADS.resources file that you can modify to customize the DisplayServer module to meet your particular NetFlow data processing needs.
|Parameter Keyword||Default Value||Range of Values||Description|
Port number on which the DisplayServer listens for network commands.
Defines the maximum number of commands that the DisplayServer accepts.
Defines the size of the dynamic memory pool in megabytes (MB) for the DisplayServer.
Defines the maximum amount of memory in megabytes (MB) that will be used in executing a single network command.
Defines the maximum aggregate amount of storage, in megabytes, that can be consumed by background NoWait command response files being stored in the DisplayServer /opt/CSCOnfa/NFAServer/Cache directory. The system always tries to store one file, even if it is larger than the value of this parameter. The practical maximum value of this parameter is any value that the DisplayServer workstation or PC can handle.2 The default value is 384 MB.
Defines the maximum "well-known" protocol port number for the DisplayServer. A well-known protocol port retains its identity for defining traffic flows, even if no text description exists (in the Proto.txt file or the Port.txt file in the AliasDefn directory) to define the port number. The default value of this parameter is 1023.
Defines the maximum "registered" protocol port number. A protocol port number greater than the value of the "well-known" protocol port, but less than the value of the "registered" protocol port, retains its identity for defining flows only if a text description exists for it in the Proto.txt file or the Port.txt file in the AliasDefn directory. The default value of this parameter is 1023.
Displays the protocol ports in the "Protocol" field (column) of the DisplayServer command response according to their IANA-STD-2 registered keyword identification. The default value of this parameter is false.
This section describes how to prevent time zone problems that can affect the operation and use of the Analyzer. This step should be taken during the configuration of the NetFlow FlowCollector application. For more information about this application, refer to the NetFlow FlowCollector Installation and User Guide.
The FlowCollector database may contain anomalies if you collect data from different time zones for the same DataSetPath. The FlowCollector database may also contain anomalies if you are not using Greenwich Mean Time (GMT) at the time daylight saving time causes the local clock to be shifted backward in the fall. A convenient way to address these problems is to run the FlowCollector using GMT.
To run the FlowCollector using GMT, you must edit the nf.resources file of the FlowCollector to uncomment the line containing the GMT_FLAG parameter. By default, the GMT_FLAG parameter in the nf.resources file is set to the on (yes) state.
To uncomment the GMT_FLAG parameter in the nf.resources file, ensure that this parameter appears in the file as follows:
The DisplayServer module can accommodate the shift forward to daylight savings time in the spring and will support the locally named file for a single time zone used for each DataSetPath. The DataSetPath for each thread is defined in the nfconfig.file of the FlowCollector.
To start the Analyzer modules on a UNIX platform, perform the following steps:
$ su root password: password
Step 2 Change to the following directory:
# cd /opt/CSCOnfa
Step 3 Execute the start.All script to start all the modules of the Analyzer.
|Note This does not start the Display module.|
To start only the Display module, use the following command:
# cd NFADisplay/bin # start.Display
To start the Display module on a PC platform, perform the following steps:
C:\> cd NFADisplay\bin C:\NFADisplay\bin>
Step 2 Use the following command to start the Display module:
When you finish using the Display module, exit from it and restart it later, as needed.
During normal operations, it is recommended that you leave the UtilityServer module and the DisplayServer module running at all times. If a problem occurs, such as after a power loss or a system crash, you must restart these modules.
For instructions on stopping any one of the Analyzer modules, checking its status, or starting it individually, see the "Controlling Analyzer Modules" section.
If the UtilityServer and the DisplayServer are already running on your host Analyzer workstation, see the "Starting the Display Module" section for instructions on starting the Display module by itself.
Posted: Thu May 31 07:40:46 PDT 2001
All contents are Copyright © 1992--2001 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.