cc/td/doc/product/rtrmgmt/sw_ntman/td_main/td
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Logging and Reporting Using Trend Reporter

Logging and Reporting Using Trend Reporter

The TrafficDirector Trend Reporter is a new application that you can use to log and report various statistics related to your network. Trend Reporter is based on a relational database, which means that you can make ad hoc queries to information contained in any of the database tables, set up automatic report generation, choose reports based on detail or summary data, and define how long detail or summary information stays in the database.

To use Trend Reporter on Windows platforms, you must provide the following:

To fully use all the Trend Reporter features, you must have these items configured correctly, and you must also have installed Trend Reporter as required for your organization. For more about installation requirements, see the "Installing TrafficDirector" chapter.

Trend Reporter lets you structure reports that are meaningful for your needs. The information in this chapter explains how Trend Reporter works and helps you quickly get up to speed on creating what you need. Depending on your needs and interests, you might need to read this entire chapter, or you might need to read only certain sections that apply to the task at hand.

How Trend Reporter Works

Trend Reporter is built upon a relational database instead of flat files. Within the database are numerous tables containing different information. To access information in the database tables, you use SQL queries, whether interactively (entered on a command line) or submitted through the Trend Reporter graphical user interface (GUI). In this chapter, you will learn how to use the Trend Reporter GUI.

If you opt to use the Trend Reporter ad hoc query capability, you will need to be familiar with SQL. SQL queries are easy to use and understand; an example SQL query to an employee database table might look something like this:

SELECT LastName, FirstName, Extension FROM employee_table WHERE FirstName = 'David' ORDER by LastName

Note If you are not familiar with SQL, it is an ANSI/ISO standard that lets you use English language queries to extract or show information contained in the database. If you want to submit ad hoc queries for customized reports, you need a basic knowledge of how to structure SQL queries. For more about using ad hoc queries and for sample queries, see the "Customizing Trend Reporter" chapter.

Using the Trend Reporter SQL Server

To run Trend Reporter on the Windows platform, you need a Microsoft SQL Server running on a Windows NT server--Cisco Systems does not provide a bundled server for Windows platforms. The SQL Server (and 16-bit SQL client) must be configured and installed before you install TrafficDirector. During the TrafficDirector installation, you are prompted to provide required SQL Server information.

If you purchase, install, and configure the SQL Server and client later, you will then need to reinstall Trend Reporter and provide the required settings. For more about the SQL Server and 16-bit SQL client information that must be set up during the TrafficDirector installation, see the chapter "Installing TrafficDirector."

The database that is located in the SQL Server is a collection of tables that you access using SQL queries. Report tables are available to you and display information that you request through the GUI or ad hoc queries.

More About the Trend Reporter Database Tables

The Trend Reporter tables contain statistics for all agent/domain pairs. This means that SQL queries you submit can span multiple agents and domains. Trend Reporter uses the following seven types of report tables:

Each report table type can be classified as one or more of the following categories:

Protocol Contains media-independent domain (protocol) statistics common to all LAN and WAN types. Tables include packets and bytes only.
Segment Contains media-specific segment statistics for Ethernet and Fast Ethernet, Token Ring, FDDI, and WAN. If you are using RMON2 probes, this table is useful for the RMON domain.
Host Contains basic host statistics.
Conversations Contains basic conversations statistics.

Viewing Tables

When you want to look at any of the seven table types, you can choose the specific type of content that you want. This means that you can look at any of these tables for the following types of content:

Detail Shows a high level (usually hourly) of detail for the table you request as a report.
Summary Shows a less detailed daily level for the table you request as a report.
Snapshot Shows temporary information, but report applications do not reference it; only daemons see and work with information in this table.

Trend Reporter uses Detail and Summary tables to extract the information required to prepare various reports you might request.

Other Trend Reporter Features

Trend Reporter gives you the flexibility to choose predefined reports through the GUI or to make ad hoc queries to the tables in the database by using the following features:

Detail and summary data formats You can choose to view any of the Trend Reporter seven table types as either detail or summary. This means for any of the seven table types, you can choose the type of content that reflects your current needs, whether it is highly detailed or summary-level information.
Automatic data aging This feature lets you specify what type of data you want to save in the database for a defined period of time. For example, you might want hourly detail information to stay in the database for seven days, while you would need daily summary information to stay in the database for a month. Once you specify the amount of time you want to save information, Trend Reporter automatically deletes the aged information, as defined.
Automatic report generation Using the Trend Reporter GUI, you can specify that a certain report must be generated on any combination of daily, weekly, and monthly intervals. Once you do so, Trend Reporter schedules the report to be run at all the intervals you specified. Trend Reporter does this automatic report generation by using an "autoreporter daemon" that you will read more about later in this chapter.
Minimum threshold specification This feature lets you specify a minimum utilization percentage for either a host or a source-to-destination that a host segment must meet before it is included in the host details or summary tables (host utilization) or conversation details or summary tables (source-to-destination). This means that the extraction daemon compares a host segment's utilization percentage or source-to-destination utilization percentage to the minimum numbers you specify and creates a row in the host details table only if the utilization percentage meets or exceeds this value.

Comparing V4.1 and V3.3 Trend Reporting Features

If you have used the TrafficDirector V3.3 Logging and Reporting feature, you are probably wondering just what is different in Trend Reporter V4.1. Besides all the new features listed in this chapter, the following list outlines the major differences:

To run reports in V4.1 You launch the application from the TrafficDirector main window and select as many agent/domain combinations as you need, without needing to relaunch the application.
To run reports in V3.3 You had to launch the Report Generator from Domain Manager for a specific agent/domain combination. You also had to relaunch the Report Generator for each new agent/domain combination you wanted a report on.
To create config files in 4.1 Configuration files are created automatically as you use the GUI. You can easily create these files manually, if you prefer.
To create config files in V3.3 You had to manually create config files.

Choosing Report Formats and Reports

Several original Report Generator reports are still available. Trend Reporter features several new reports that you can choose from, depending on your needs. Table 13-1 shows all the reports you can run, as well as types of formats you can choose for each.


Table  13-1: Trend Reporter V4.1 Reports
Report Available in V4.1 Available in V3.3 Formats
Protocol Distribution Yes Yes Tabular
CSV
TSV
Segment Summary Yes Yes Tabular
Graphical
CSV
TSV
Segment Details Yes Yes Graphical
CSV
TSV
Host Summary Yes Yes Tabular
Graphical
CSV
TSV
Host Verbose Yes Yes Tabular
CSV
TSV
Host Outbound Yes Yes Tabular
CSV
TSV
Conversation Summary Yes Yes Tabular
Graphical
CSV
TSV
Billing Yes Yes Tabular
CSV
TSV
Multisegment Summary Yes No Tabular
Graphical
CSV
TSV
Protocol Usage Yes No Tabular
Graphical
CSV
TSV
Host Details Yes No Tabular
Graphical
CSV
TSV
Conversation Details Yes No Tabular
Graphical
CSV
TSV
WAN Usage Yes No Tabular
Graphical
CSV
TSV
VLAN Usage Yes No Tabular
Graphical
CSV
TSV
DLCI Usage Yes No Tabular
Graphical
CSV
TSV
Router Backbone Usage Yes No Tabular
Graphical
CSV
TSV

About Predefined Reports

Each predefined report gives you specific information. Table 13-2 lists the reports you might want to generate.


Table  13-2: Predefined Reports
Predefined Report Information Provided
Segment Summary Traffic segment summary.
Segment Details Traffic segment details.
Multisegment Summary Information about segments for a specified agent group or switch.
WAN Usage Information about DLCIs (when frame relay agents are specified) and traffic on specific WAN segments.
VLAN Usage Information about traffic on all VLANs associated with the monitored Fast Ethernet segment.
DLCI Usage Information about traffic on all DLCIs associated with the monitored frame relay WAN segment.
Router Backbone Usage Information about traffic on all nodes connected to the specified router backbone.
Protocol Usage A breakdown of the percentage of traffic using specific protocols.
Protocol Distribution Comparative segment statistics for a hierarchy of domains for a specified agent, based on a tree of domains that you define.
Host Summary A summary of host traffic, sorted as you specify. You can choose to include just one host or the top N hosts.
Host Verbose Details of host traffic, sorted as you specify. You can choose to include just one host or the top N hosts.
Host Outbound Details of all outbound host traffic, sorted as you specify. You can choose to include just one host or the top N hosts.
Host Details Details of host traffic, sorted as you specify. You can choose to include just one host or the top N hosts.
Conversation Summary A summary of traffic between each pair of hosts that has "talked."
Conversation Details A detail of traffic between each pair of hosts that has "talked."
Billing The amount and cost of outgoing traffic for each department /host over a LAN or WAN segment.

About Report Formats

Depending on the report you select, you can usually choose from several different report formats. Here is what to expect from the different report formats:

Tabular Information is displayed as alphanumeric and numeric text in columns and rows. Typically, you would want to select this format when you are using the information as a standalone report.
Graphical Information is displayed in graph format with a corresponding legend. Typically, you would want to select this format when you are using the information as a standalone report.
CSV (comma separated value) Information is displayed as alphanumeric and numeric text in strings, with values separated by commas. Typically, you would want to select this format when you plan to import the information into a spreadsheet type application.
TSV (tab separated value) Information is displayed as alphanumeric and numeric text in strings, with values separated by a tab character. Typically, you would want to select this format when you plan to import the information into a spreadsheet type application.

How the Trend Reporter Database Works

A single database named NSTREND_DB contains all TrafficDirector-related tables. There are many tables in this database that Trend Reporter accesses in response to choices you make on the GUI or to ad hoc SQL queries you enter. Other TrafficDirector applications may also access some of the tables in the database.

Within the database, you will find sets of tables and types of tables. There are seven types of tables (described in the "More About the Trend Reporter Database Tables" section); for each type of table, three storage tables exist. The three storage tables and how they work are explained as follows:

Snapshot Similar to the TrafficDirector V3.3 logfiles, these tables contain raw snapshot data. The snapshot daemon creates each new row in the snapshot table.
Details These tables are created using information from the Snapshot tables and offer high-granularity time resolution, meaning statistics for small, meaningful timeframes. The database extraction daemon gets the raw information from the Snapshot table in pairs of rows, calculates the difference between the two rows, and stores that in the Details table.
Summary These tables are created from the Detail tables and offer 24-hour granularity only, meaning statistics summarized over a 24-hour period. The database rollup daemon is responsible for creating this table by pulling out 24 hours of information from the Detail table and summarizing the statistics to compare with older 24-hour periods. The information in this table, except for the longer timeframe, is identical to the corresponding Detail table.

Database Table Quick Reference

For quick reference, Table 13-3 shows a list of all the tables in the database and gives a brief description of each, as well as maximum row size.


Table  13-3: Database Quick Reference
Table name Description Maximum Row Size
protocol_snap Media-independent protocol statistics snapshots 120
protocol_detail Media-independent protocol statistics details 139
protocol_summary Media-independent protocol statistics summary 139
seg_et_snap Ethernet segment statistics snapshots 240
seg_et_detail Ethernet segment statistics details 259
set_et_summary Ethernet segment statistics summary 259
seg_wan_snap WAN segment statistics snapshots 240
seg_wan_detail WAN segment statistics details 259
seg_wan_summary WAN segment statistics summary 259
seg_fddi_snap FDDI segment statistics snapshots 240
seg_fddi_detail FDDI segment statistics details 259
seg_fddi_summary FDDI segment statistics summary 259
seg_tr_snap Token-Ring segment statistics snapshot 408
seg_tr_detail Token-Ring segment statistics details 427
seg_tr_summary Token-Ring segment statistics summary 427
host_snap Host statistics snapshots 184
host_detail Host statistics details 211
host_summary Host statistics summary 211
conv_snap Conversation statistics snapshots 172
conv_detail Conversation statistics details 191
conv_summary Conversation statistics summary 191

Note You should add 8 to all the numbers in the maximum row size column; this is the amount of overhead necessary for each row. For example, this means that for seg_et_snap, the maximum row size of 240, plus 8 for overhead, equals 248.

Understanding the Trend Reporter Daemons

A daemon is a process that runs in the background and is disconnected from a process group and terminal. As used in Trend Reporter, certain daemons are used to update functions. Daemons work with related configuration files that control how and when they are called to perform their roles. Trend Reporter uses the following daemons:

Snapshot daemon Called dbsnapd, this daemon gets snapshots of raw statistics from agents and stores this information in a snapshot table.
Extraction daemon Called dbextrad, this daemon gets information from the snapshot table, creates new rows in the details table, and deletes the oldest member in each pair of snapshot rows.
Rollup and Aging daemon Called dbrolld, this daemon performs two separate but related actions; it gets information from the details table to create new rows in the summary table and deletes obsolete information from both the detail and summary tables.

Working with the Trend Reporter GUI

When you want to run predefined Trend Reporter reports, you can use the GUI. Reports you can choose to run are defined in the "Choosing Report Formats and Reports" section.

Displaying the Trend Reporter Main Window

Whenever you want to work with Trend Reporter, you need to use the procedure below to display the main window. Once the main window is displayed, you can specify parameters for the aging and logging activities. Use the following procedure to display the Trend Reporter main window.

Step 1 If you have not already done so, log in to the network management station where TrafficDirector is installed, and run the TrafficDirector application. The TrafficDirector main window (Figure 13-1) is displayed.

Step 2 Select an agent, agent group, or switch from those shown in the lists. If the agent you want is not listed, you may need to add it. To do so, see the "Working with Agents, Agent Groups, and Switches" chapter.

Step 3 To launch Trend Reporter, click the Trend Reporter icon. The Trend Reporter main window (Figure 13-2) is displayed.


Figure 13-1: TrafficDirector Main Window


Figure 13-2:
Trend Reporter Main Window

From this main window, you can now use Trend Reporter to do the following:

Configure aging parameters To do so, see the "Configuring Aging Parameters" section.
Configure logging parameters for Poller To do so, see the "Configuring Logging Parameters for Poller" section.
Generate reports To do so, see the "Generating Predefined Reports Through the Trend Reporter GUI" section.
Create a new or modify an existing report configuration file To do so, see the "Creating and Modifying Report Configuration Files" section.
Load an existing report configuration file To do so, see the "Loading Existing Report Configuration Files" section.
Generate reports to run automatically on a scheduled basis To do so, see the "Generating Reports Automatically Using Auto Reporter" section.

Configuring Aging Parameters

To specify how long Trend Reporter waits before aging out (deleting) data from various tables, you need to configure aging parameters. You also use aging parameters to specify the minimum utilization percentage required before information is included in the database. To configure the aging parameters you want, use the following procedure.

Step 1 Run TrafficDirector and click the Trend Reporter icon to display the Trend Reporter main window (Figure 13-2).

Step 2 Select Configure>Aging from the menu bar.

The Configure Aging window (Figure 13-3) is displayed. You will notice that there are three headings on this window: Database, Detail Aging (days), and Summary Aging (days). Under the Database heading are listed Protocol, Segment, Host, and Conversation. To the right of each of these table types are two fields--one where you can specify the amount of time to save information in the detail table and one where you specify the amount of time to save information in the summary table.



Figure 13-3: Configure Aging Window

Step 3 Do the following:

Step 4 Under the Minimum utilization % for inclusion in heading, do the following:

Step 5 To save and apply your choices, click Apply, or click Cancel to close the window without saving your choices.

Configuring Logging Parameters for Poller

To specify what agents, agent groups, or switches that you want to log information for, you need to configure logging parameters for the Trend Reporter Poller. To do so, use the following procedure. You use this procedure anytime you need to add new logging parameters, edit your existing ones, or delete those you do not need any longer.

Step 1 If you have not already done so, run TrafficDirector and click the Trend Reporter icon to display the Trend Reporter main window (Figure 13-2).

Step 2 Select Configure>Poller from the menu bar. The Configure Poller window (Figure 13-4) is displayed.


Figure 13-4: Configure Poller Window

Step 3 Depending on your situation, do one of the following:

If you clicked Delete, a dialog is displayed that requires you to confirm that you want to delete the specified entry. If you clicked New, the Add Configuration Entry window (Figure 13-5) is displayed. If you clicked Edit, the Edit Configuration Entry window is displayed. Both windows contain identical fields.



Figure 13-5: Add Configuration Entry Window

Step 4 Under the Poll for field, click the selection button and choose Agent, Agent Group, Switch, or Frame Relay, depending on the device or devices you are setting up to poll information.

Step 5 Do one of the following, depending on your selection in Step 4.

Step 6 Highlight one or more domains that you want. Depending on how many domains are installed, the list you see may contain a scroll bar; you can use the scroll bar to see the entire list of domains that are available to be selected for polling information.

Step 7 Do the following:

Step 8 To save and apply your choices, click the OK button, or to close the window without saving your choices, click Cancel.

Generating Predefined Reports Through the Trend Reporter GUI

You can generate many predefined reports from the Trend Reporter main window. Reports you can choose are defined in the "Choosing Report Formats and Reports" section. To generate any of these reports, use the following procedure.

Step 1 If you have not already done so, run TrafficDirector, and click the Trend Reporter icon to display the Trend Reporter main window (Figure 13-2).

Step 2 Select the type of report you want to generate by clicking the button to the right of the Report Type field. Report types you can choose from are described in the "About Predefined Reports" section.

Step 3 Under the Report for field, click the selection button, and choose either Agent, Agent Group, Switch, or Frame Relay, depending on the device or devices you have set up to poll information that you want generated as a report.

Step 4 Do one of the following, depending on your selection in Step 3:

Depending on your selection, you will see either the Select Agent Group window, the Select Switch window, or the Select Frame Relay Agent window. Except for the title bars and the available selections, all of the windows are the same.


Step 5 Highlight one or more domains you want from those displayed in the Domains list. Depending on how many domains are installed, the list you see may contain a scroll bar; you can use the scroll bar to see the entire list of domains that are available to be selected for polling information.

To the right of the Database field, select one of the following buttons:

Detail Shows a highly-detailed content for the report you chose.
Summary Shows a daily summary-level content for the report you chose.

Step 7 To select the total amount of time for which you want to see statistics, you need to set beginning and end dates and times. For example, to see statistics for the selected report for seven days, you might select April 22, 01:00, through April 28, 01:00. To set the total amount of time for which you want statistics, do the following:

Step 8 In the Interval field, select the time interval you want reflected in the report you chose. For example, if you want to see information collected every hour, you would select 1 hour as the interval.

Step 9 To print headers and footers on the report, do the following:

Step 10 In the Report Format field, click the button by the format type you want for the selected report. You can choose from Graph, Tabular, CSV, and TSV. Not all types are available for all reports. For more about the types you can choose, see the "Choosing Report Formats and Reports" section.

Step 11 In the Lines Per Page field, enter the total number of text lines you want on each page of a Tabular report. If you selected any other report format (Graph, CSV, or TSV), this option is not available.

To choose the output of your report, choose from one of the following buttons shown to the right of the Output field:

Display Report is shown on the management console screen. From this screen, you can print it to a printer or a file, as explained in the "Printing GUI-Generated Reports" section. Go to Step 14.
File Report is saved as a file. You must specify a new or existing file in the blank field shown to the right of the available output options. When you choose this option, you must also click either Create (to create a new file) or Append (to add the report to an existing file). Go to Step 13.
Printer Report is queued directly to a printer. You must specify the printer name in the blank field shown to the right of the available output options. Go to Step 14.
Mail to Report is sent as an e-mail message. You must specify the e-mail address in the blank field shown to the right of the available output options. Go to Step 14.

Step 13 If you selected a file output, in the Mode field you must also click either Create (to create a new file) or Append (to add the report to an existing file).

Step 14 If you have selected a Host-type report, in the Sort Hosts field click the selection button to the right of the field to select the variable you want; the report is sorted using this variable. If you selected any report type other than Host, this option is not available. You can choose from Address, Packets, Packets-in, Packets-out, Utilization, Utilization-in, or Utilization-out.

Step 15 If you have selected a Conversations-type report, do the following to set up the report:

Step 16 In the Additional Configuration File(s) field, specify any additional configuration files you want Trend Reporter to use when generating the report.

Step 17 To generate the report as specified, click the Generate button, displayed at the top of the Trend Reporter main window (Figure 13-2).

Trend Reporter generates the specified report according to the parameters you have set.


Creating and Modifying Report Configuration Files

When you fill out the Trend Reporter main window to generate a report, you are also configuring the report; you can save the configuration and use it repeatedly.

You might want to save a report configuration in a file if the report meets a specific need but you do not run it often enough to set it up with the AutoReporter. Or, if you are asked to quickly run each type of available report for a specific time period for comparison purposes, you could set up and save one configuration file and modify it as required for each report. Doing so saves you the time it takes to configure all the variables for each report offered in Trend Reporter.

Do not confuse this with configuring logging or aging parameters--those tasks let you specify what statistics are reported and when collected statistics are deleted from the database, respectively.

The report configuration file is just a collection of variables that impact what report you generate, where (and to what) the report is output, what time the report begins and ends, specific headers or footers, and whether the report is in graph, tabular, CSV or TSV format, among other things. Use the procedure below to create or modify report configuration files.

Step 1 If you have not already done so, display the Trend Reporter main window (for steps on doing this, see the "Displaying the Trend Reporter Main Window" section).

Step 2 Fill out or modify the fields on this window as described in the "Generating Predefined Reports Through the Trend Reporter GUI" section.

Step 3 Before clicking the Generate button to run the report, do one of the following:


Figure 13-6: Save Window


Figure 13-7: Save As Window

Step 4 Enter the name you want for the report configuration file and click OK. One of the following occurs:

Loading Existing Report Configuration Files

Whenever you want to use an existing report configuration file to control how a report should look, as well as the report time interval, among other variables, you can load an existing report configuration file. Loading an existing report configuration file saves you the work of filling out all the fields on the Trend Reporter main window. This is especially useful when you need to generate a report fast. Use the following procedure to load an existing file.

Step 1 If you have not already done so, display the Trend Reporter main window (see the "Displaying the Trend Reporter Main Window" section).

Step 2 Select the type of report you want to generate by clicking the button to the right of the Report Type field. Report types you can choose from are described in the "About Predefined Reports" section.

Step 3 Select File>Load from the menu bar. The Load window (Figure 13-8) is displayed.


Figure 13-8: Load Window

Step 4 Locate and highlight the name of the report configuration file you want to load. To do so, use the scroll bars in the Directories and Files list as necessary, then click OK.

The remaining fields on the Trend Reporter main window are filled in with the values specified in the report configuration file you loaded. To generate the report you selected with the parameters loaded from the specified report configuration file, click Generate.


Generating Reports Automatically Using Auto Reporter

To save you time, Trend Reporter offers the Auto Reporter feature. Auto Reporter lets you schedule reports to run on a daily, weekly, or monthly basis. This is particularly useful if you have set up certain reports that you need on a regular basis. Once you define the reports you want to run through Auto Reporter, it provides the reports as you specify. To set up reports to run regularly in Auto Reporter, use the following procedure.

Step 1 If you have not already done so, display the Trend Reporter main window (see the "Displaying the Trend Reporter Main Window" section for procedures).

Step 2 From the menu bar, select Configure>Auto Reporter. The Configure AutoReporter window (Figure 13-9) is displayed.


Figure 13-9: Configure AutoReporter Window

Step 3 Click the New button. The Add Configuration Entry window (Figure 13-10) is displayed.


Figure 13-10: Add Configuration Entry Window

Step 4 In the Generate Report Automatically field, click either the Daily, Weekly, or Monthly button.

Step 5 In the Configuration File field, enter the name of the configuration file containing the parameters and variables you have defined for the report you are scheduling, or click the selection button to the right of the field to browse through available report configuration files.

Step 6 Click Apply to set the report to run as scheduled, or click Cancel to close the window without saving the information.

Editing Reports Scheduled in Auto Reporter

It is easy to reschedule reports in Auto Reporter. To do so, use the following procedure.

Step 1 If you have not already done so, display the Trend Reporter main window (see the "Displaying the Trend Reporter Main Window" section).

Step 2 From the menu bar, select Configure>Auto Reporter. The Configure Auto Reporter window (Figure 13-9) is displayed.

Step 3 Click the Edit button. The Edit Configuration Entry window is displayed. The fields on the window are identical to the Add Configuration Entry window (Figure 13-10).

Step 4 In the Configuration File field, enter the name of the configuration file containing the parameters and variables defined for the report you are rescheduling or click the selection button to the right of the field to browse through available report configuration files.

Step 5 In the Generate Report Automatically field, reschedule the report by clicking either the Daily, Weekly, or Monthly button.

Step 6 Click Apply to set the report to run on the new scheduled basis, or click Cancel to close the window without saving the change.

Printing GUI-Generated Reports

Use the following procedure to print any report you have generated through the Trend Reporter GUI and displayed on the network management console screen. If you want to print a report you generated on an ad hoc basis, see the "Printing Ad Hoc Generated Reports" section in the "Customizing Trend Reporter" chapter.

Step 1 With the report displayed on screen, select File>Print from the menu bar. The Printing Options window is displayed (Figure 13-11).


Figure 13-11: Printing Options Window

Step 2 Do one of the following:

When you print directly to a printer, information is printed on the default printer. If you want to print to a different printer, you must set it as the default before you send information to print.


Step 3 Click OK.

Working with Trend Reporter from the Command Line

When you want to generate reports, you can use the Trend Reporter graphical user interface (GUI) for running predefined reports or you can use a command line utility to generate customized reports. This section describes how to launch the GUI from the command line and how to generate reports from the command line.

Using nstrend

The Trend Reporter nstrend command line utility lets you launch the Trend Reporter GUI. Enter nstrend at the prompt, and press Enter.

For more information about using the Trend Reporter GUI, see the "Working with the Trend Reporter GUI" section in this chapter.

Using nsreport

The Trend Reporter nsreport command line utility replaces the dvreport and grreport utilities and generates reports by using the parameters described in the following sections.

To view a list of the parameters that are available, enter nsreport at the prompt, and press Enter. The following information is displayed:

> nsreport
nsreport [-cfg param-file -cfg param-file ... ]
         [-type report-type]
         [-agent agent-name [agent-name ...] |
         -agent @agent-group-name |
         -switch switch-name |
         -switch switch-name port-name [port-name ...] |
         -framerelay framerelay-agent-name |
         -framerelay framerelay-agent-name dlci-name [dlci-name ...]]
         [-domain domain-name [domain-name...]]
         [-database detail|summary]
         [-period start-time end-time]
         [-interval interval]
         [-print printer-name | -file file-name | mail mail-to-address]
         [-header1 first-header]
         [-header2 second-header]
         [-footer footer]
         [-format tabular|csv|graph]
         [-delimiter comma|tab]
         [-lpp lines-per-page]
         [-sort sort-criteria]
         [-top top]
         [-tree domain-tree-file]
         [-department department-file]
         [-tariff tariff-file]
>

When running nsreport from the command line, you can configure report parameters by entering the parameters and variables at the command line, by entering the parameters and variables in a configuration file to be created by you, or by using the parameters in a Trend Reporter default file.

When you enter a string of parameters at the command line, you can enter any combination of values and use any combination of spaces and tabs (nonprinting characters) as delimiters. For example, to run a report for two agents, you would enter the following string:

nsreport -agent probe1 probe2

Note Trend Reporter processes parameters in the order you specify. If you repeat a parameter, Trend Reporter overwrites the value of the first parameter with the second value. The only exception to this rule is the -cfg parameter, which is used to specify the name of a text file containing strings of parameters. Trend Reporter uses the listed parameters in the order given (see Example 2 and Example 3).

There are different methods of obtaining the same report. The following examples show how you might choose to work with parameters and configuration files to obtain the same report.

Example 1

This example uses parameters only:

nsreport -agent probe1 -domain TCP -type wan-usage -format graph -period 961211 971211 -interval 02:00
Example 2

This example uses a configuration file (my_config_file) that has a separate line for each parameter:

nsreport -cfg my_config_file

The configuration file named my_config_file has the following lines:

-agent probe1
-domain TCP
-type wan-usage
-format graph
-period 961211 971211
-interval 02:00
Example 3

This example uses parameters and a configuration file:

nsreport -agent probe1 -domain TCP -type wan-usage -format graph TCP -cfg my-config-file

The configuration file named my_config_file has the following lines:

-period 950101 960101
-interval 02:00

Required Parameters

This section describes the nsreport parameters that are required to generate a report.

-agent [agent-group | @agent-group-name] Use this parameter only when the -framerelay or -switch parameters are not specified. Use this parameter with the agent-group or @agent-group-name variables to specify the individual agents or the group of agents to be used for the report. For example, to specify two agents, you would enter the following:

-agent agent1 agent2

To specify a group of agents, you would enter the following:

-agent @agentgroup3

You can specify only one agent group with the @agent-group-name option.

-domain domain-name [domain-name] Use this parameter with the domain-name variable to specify one or more domain names for the report you specified with the -type parameter. For example, if you want to specify two domain names for the protocol-usage report, you would enter the -domain parameter as follows:

-domain domain1 domain2

You can specify one or more domain names with the following report types:

· protocol-distribution

· protocol-usage

You can specify only one domain name with the following report types:

· billing

· conversation-details

· conversation-summary

· host-details

· hosts-outbound

· host-summary

· host-verbose

· multi-segment-summary

You can specify only one domain name with the following report types:

· billing

· conversation-details

· conversation-summary

· host-details

· hosts-outbound

· host-summary

· host-verbose

· multi-segment-summary

You can specify only the RMON domain name with the following report types:

· dlci-usage

· router-backbone-usage

· segment-details

· segment-summary

· vlan-usage

· wan-usage

-format {tabular | csv | graph} Use this parameter with the tabular, csv, or graph options to display the report.

If you specify tabular, the report is displayed as shown in Figure 13-12. When specifying tabular, use the -lpp parameter to specify the number of lines per page. If you set -lpp to 0, the report is not paginated.

If you specify csv, use the -delimiter [comma | tab] parameter to display the report in a comma-separated value (CSV) format as shown in Figure 13-13 or in a tab-separated value (TSV) format as shown in Figure 13-14. If you specify csv without using the -delimiter parameter, the report is displayed in the default CSV format.

If you specify graph, the report is displayed as a graph.

Not all reports are available in all formats. See the "Choosing Report Formats and Reports" section in this chapter for a list of the supported formats for each report type.


Figure 13-12: Tabular Format

Segment Summary Report
Agent:  SwProbe100                                 From: Tue Dec  3, 1996 15:00
Domain: RMON                                         To: Tue Dec  3, 1996 15:45
Agent interface: 200 Mbit Ethernet
Traffic this Period
-------------------
Average Utilization: 0.015%
Average Packet Size: 98.27 bytes
Total Packets:             87,758   Average rate:      1.02 per second
Total Bytes:            8,623,680   Average rate:     99.81 per second
Packet Type                 Total    Per Second      % Total Packets
-----------    ------------------    ----------      ---------------
Unicast                         0          0.00             0.00%
Multicast                  87,758          1.02           100.00%
Broadcast                       0          0.00             0.00%

Figure 13-13:
CSV Format

Type,Agent,Domain,From Date,To Date
Segment Summary Report,SwProbe100,RMON,Tue Dec  3  1996 15:00,Tue Dec  3  1996 15:45
Agent interface:,200 Mbit Ethernet
Traffic this Period
% Average Utilization:,0.015
Average Packet Size (bytes):,98.27
Total Packets:,87758,Average rate (per second):,1.02
Total Bytes:,8623680,Average rate (per second):,99.81
Packet Type,Total,Per Second,% Total Packets
Unicast,0,0.00,0.00
Multicast,87758,1.02,100.00
Broadcast,0,0.00,0.00

Figure 13-14:
TSV Format

Type	Agent	Domain	From Date	To Date
Segment Summary Report	SwProbe100	RMON	Tue Dec  3  1996 15:00	Tue Dec  3  1996 15:45
Agent interface:	200 Mbit Ethernet
Traffic this Period
% Average Utilization:	0.015
Average Packet Size (bytes):	98.27
Total Packets:	87758	Average rate (per second):	1.02
Total Bytes:	8623680	Average rate (per second):	99.81
Packet Type	Total	Per Second	% Total Packets
Unicast	0	0.00	0.00
Multicast	87758	1.02	100.00
Broadcast	0	0.00	0.00

-framerelay {framerelay-agent-nameframerelay-agent-name dlci-name} [dlci-name...] Use this parameter only when the -agent or -switch parameters are not specified. You can specify only one frame-relay agent for the report. Multiple frame-relay agents cannot be specified.

The frame-relay report includes information for all data-link connection identifiers (DLCIs) on the frame-relay agent. If you want to run a report for information only on selected frame-relay agent DLCIs, specify the DLCI names after the framerelay-agent-name parameter, as in the following example:

-framerelay framerelayagent1 dlci2

To ensure that you specify the DLCI names correctly, run Domain Manager on the frame-relay agent for which you want the report, and use the DLCI names shown in the list in the Domain Manager GUI.

-interval interval Use this parameter to specify the time interval, in hh:mm format, that you want reflected in the report. For example, if you want data collected every hour, you would enter the following:

-interval 01:00

You can specify the following intervals:

· 1 minute (00:01)

· 5 minutes (00:05)

· 15 minutes (00:15)

· 30 minutes (00:30)

· 1 hour (01:00)

· 2 hours (02:00)

· 4 hours (04:00)

· 8 hours (08:00)

· 24 hours (24:00)

-period start-time end-time Use this parameter to specify the time period for which you want to see statistics. For example, to specify a start time of 8:15 a.m. on January 16, 1997, and an end time of 8:15 p.m. on January 17, 1997, you would enter the following:

-period 9701160815 9701172015

The hhmm portion of the format can be omitted to use the default time of midnight (0000).

-switch {switch-name | switch-name port-name} [port-name...] Use this parameter only when the -agent or -switch parameters are not specified. You can specify one switch or specify one switch and one or more ports on the switch for the report. Multiple switches cannot be specified.

When you specify only the switch name, the report includes information about all ports on the switch. To specify a switch name, enter the parameter as follows:

-switch switch1

To specify a single port on a switch, enter the parameter as follows:

-switch switch1 port5

To specify multiple ports on a switch, enter the parameter as follows:

-switch switch1 port5 port10 port12

-type report-type Use this parameter to specify one of the following report types. (For details about the report types, see the "Choosing Report Formats and Reports" section in this chapter.)

· billing

· conversation-details

· conversation-summary

· dlci-usage

· host-details

· host-outbound

· host-summary

· host-verbose

· multi-segment-summary

· protocol-distribution

· protocol-usage

· router-backbone-usage

· segment-details

· segment-summary

· vlan-usage

· wan-usage

The following parameters must be used with the billing report:

· -department department-file

· -tariff tariff-file

· -rate

The billing report requires the -department department-file parameter. This parameter identifies the configuration file that lists the department for different hosts. The report displays the aggregated billing amount based on the departments listed in the file.

You must create your own configuration file in the c:\traffdir\usr directory. Each line in the file must be written in a 3-column format as follows:

#Host Address Department Name Address Family
204.240.143.100 Engineering IP
204.240.143.25 "Engineering Support" IP
204.240.143.04 Finance IPX
204.240.143.23 "Finance Support" IPX

If you do not specify a configuration file, Trend Reporter sends an error message stating that it cannot find the file.

Use the following protocols to specify the host address:

· AppleTalk

· DECNET

· IP

· IPX

· MAC

· VINES

Use the following protocols to specify the address of the host address family:

· ATALK

· DECNET

· DLC (MAC address)

· IP

· IPX

· VINES

The billing report also requires the -tariff tariff-file parameter, which identifies a configuration file specifying the rate (in U.S. dollars) to send 1 KB of data as follows:

-type billing -tariffrate.cfg

You must create your own configuration file in the c:\traffdir\usr directory to include the -rate parameter, which specifies the billing rate, as shown in the following example:

# Billing rate in US $ to send 1 KB of data
   -rate 0.02

If you do not specify a filename for the trariff-file variable, Trend Reporter uses the default rate of $0.01.

When specifying the protocol-distribution report, you must use the -tree domain-tree-file parameter to specify the configuration file that contains the hierarchy of domains. If you do not specify the name of a configuration file, Trend Reporter uses the default domtree.inf file in the c:\traffdir\usr directory.

If you create your own configuration file, each line must be written in the following format:

parent-domain : child-domain1 child-domain2

Each child domain is a subset of a parent domain; child domains do not overlap. An example of a -tree configuration file follows:

#
# Protocol parent-children relationship (File: #domtree.inf)
#
RMON: IP NOVELL DECNET NETB ATALK VINES SNA
IP: TCP UDP ICMP OSPF
TCP: FTP XWINDOW HTTP
UDP: SNMP TFTP NFS
NOVELL: NCP NOVSAP

Host and Conversation Parameters

This section describes the nsreport parameters that you can use to generate host and conversation reports.

-sort sort-criteria Use this parameter to sort the report output according to the criteria you specify.

You can use the following sort-criteria values to sort host reports:

· packets

· packets-in

· packets-out

· utilization-in

· utilization-out

You can use the following sort-criteria values to sort conversation reports:

· packets

· utilization

-top top Use this parameter to specify the number of top hosts or conversations that you want included in the report. For example, if you want the top 15 conversations (summary-level) shown on a conversation report, enter the following:

-top 15

The maximum number of hosts or conversations that can be displayed for a summary report is 50; for a detail report, the maximum number is 10.

For host reports, you can use the -top top parameter with the -sort sort-criteria parameter to sort the Top N by specific criteria.

If you do not specify the -top top parameter, the report is generated for all applicable hosts or conversations.

Formatting Parameters

This section describes the nsreport parameters that you can use to format a report.

-footer footer Use this parameter to display a footer line at the bottom of each page of a report. If you set a footer for a graph report, the footer is displayed in addition to the standard footer that shows the type of report being generated.
-header1 first-header Use this parameter to display one header line at the top of each page of a report. If you set a header for a graph report, the header is displayed in addition to the standard header that shows the type of report being generated.
-header2 second-header Use this parameter to display a second header at the top of each page of a report. If you set a second header for a graph report, the header is displayed in addition to the standard report header that shows the type of report being generated.

Output Parameters

This section describes the nsreport parameters that you can use to send a report to an e-mail address, a file, or a printer.


Note Only one output parameter should be specified-- -file, -mail, or -print. If you specify more than one output parameter in the string, Trend Reporter sends the report to the last listed parameter. For instance, if you specify -file myfile -print myprinter, Trend Reporter ignores the file name specified in the -file parameter and sends the output to the printer.
-file file-name Use this parameter to send the report to the specified file. If the file does not exist, Trend Reporter creates a new file in the c:\traffdir\reports directory. If the specified file already exists in the c:\traffdir\reports directory, Trend Reporter overwrites the contents of the file.

Use the -append parameter to append a report to a file specified by the -file file-name parameter, as follows:

-file myfile.txt -append

If you send a graph report to a file, the file is created in Postscript format.

-mail mail-to-address Use this parameter to mail the report to the specified e-mail address.
-print printer-name Use this parameter to send the report to the specified printer.

Miscellaneous Parameters

This section describes the nsreport parameters you can use for specifying a configuration file, a database, or a user-defined interval.

-cfg file-name Use this parameter to specify one or more text files that contain nsreport parameters. You can use -cfg file-name in a string as many times as necessary.

The file-name variable represents the name of a text file you create. You can use a text file alone or with other parameters. Example 3 shows how to use a text file with other parameters.

-database [detail | summary] Use this parameter to specify that the report consists of data from the detail or summary database. If you do not specify this parameter, Trend Reporter uses the default detail database.
-user-defined-interval Use this parameter to specify the exact interval for which you want Trend Reporter to display data exactly as it is collected. This includes time periods when data is not collected.

For instance, if you set the -interval parameter to display data from 10:00 a.m. to 10:00 p.m., Trend Reporter displays only the data collected during that interval. If you specify a user-defined interval of 10:00 a.m. to 10:00 p.m., Trend Reporter displays not only the data it collects, but also the "holes" between the periods when data was collected.

If you do not use the -user-defined-interval parameter, Trend Reporter might use built-in logic to stretch the interval you specified to provide an uninterrupted report.

hometocprevnextglossaryfeedbacksearchhelp
Copyright 1989-1997 © Cisco Systems Inc.