Chapter 17. Reference

Table of Contents

17.1. Menu reference
17.2. Database fields reference
17.2.1. Flows table fields
17.2.2. Counters table fields
17.2.3. Host counters table fields
17.2.4. Time fields
17.3. Filter functions reference
17.4. Database functions
17.4.1. Labels in database functions
17.4.2. Key functions
17.4.2.1. countryCode
17.4.2.2. countryName
17.4.2.3. hostname
17.4.2.4. ifAlias
17.4.2.5. ifName
17.4.2.6. locate
17.4.2.7. locateSwitch
17.4.2.8. mac
17.4.2.9. parent
17.4.2.10. resolve
17.4.2.11. subnet
17.4.2.12. uuid
17.4.2.13. vendor
17.4.2.14. wifiCipherSuiteFormatted
17.4.2.15. wifiCipherSuiteName
17.4.2.16. wifiVersionName
17.4.3. Value functions
17.4.3.1. count
17.4.3.2. max
17.4.3.3. min
17.4.3.4. rate
17.4.3.5. scale
17.4.4. Time functions
17.4.4.1. format
17.4.4.2. timestamp
17.5. Classes and objects defined within scripted reports
17.5.1. Objects defined
17.5.1.1. report
17.5.1.2. reportVars
17.5.2. Classes defined
17.5.2.1. Chart
17.5.2.2. Query
17.5.2.3. Report
17.5.2.4. Table

17.1. Menu reference

This section contains a reference for each of the menu selections in sFlowTrend-Pro.

FileStart/stop playback

sFlowTrend-Pro has the ability to read saved sFlow data from a file, as well as live from an sFlow switch. Start/stop playback allows you to select the file and start playback, or stop a previously started playback. The main purpose for this feature is to allow demonstrations of the capability of sFlow. The file used for playback should contain sFlow datagrams in PCAP format (eg captured by wireshark™ or tcpdump). When the file is played back, the sFlow samples will be consumed by sFlowTrend-Pro in real time, not at the time the file was saved.

If you are running sFlowTrend-Pro remote client, sFlow data is sent to the remote server that you are connected to.

FileImport report
Brings up a file chooser dialog which allows you to select a previously saved report definition and import it into sFlowTrend-Pro The report definition will be imported into the Imported reports folder in the Reports tab.
FileExport selected report
This menu item will be active whenever a report is selected in the Reports tab. Export selected report brings up a dialog which allows you to select a directory and file in which to save the currently selected report. The exported report definition can then be transferred to another sFlowTrend-Pro installation or shared with other users.
FileExit
Terminates sFlowTrend-Pro. If you are running sFlowTrend-Pro as an application , as well as closing the sFlowTrend-Pro window, this also stops collection of sFlow data; this includes attempting to disable the sending of sFlow from any switches that were configured via SNMP.
ToolsConfigure agents
Brings up the Configure agents dialog, to allow switches to be added and removed from sFlowTrend-Pro, SNMP settings changed, etc. See Section 14.2, “Configuring agents in sFlowTrend-Pro .
ToolsConfigure subnets
Brings up the Configure subnets dialog, to allow end host IP addresses to be grouped together in subnets using CIDRs. Grouping IP addresses into subnets allows you to view traffic between groups of addresses easily. Section 14.3, “Configuring subnets in sFlowTrend-Pro .
ToolsConfigure events
Brings up the Configure action on events dialog, to allow action on events to be configured, example sending email notification of events. Section 14.4, “Configuring action on events in sFlowTrend-Pro .
ToolsChange password
If you have logged in to sFlowTrend-Pro this menu item allows you to change your password.
ToolsManage Users
Brings up the Manage users dialog which allows you to configure user authentication to control who can access sFlowTrend-Pro. Section 14.6, “Configuring user authentication .
ToolsOptions
Brings up the Options dialog, to allow sFlowTrend-Pro options to be changed. See Section 14.5, “Options”.
ToolsLookup host
Brings up the Lookup host dialog, which allows you to look up address, network location, and geographical location for end hosts. See Section 14.5, “Options”.
NavigateBack
Allows you to navigate back through the history of previously viewed tabs in a similar way to the back button in a web browser. See Section 1.4, “Navigating around sFlowTrend-Pro using the history navigator”
NavigateForward
Allows you to navigate forward through the history of recently viewed tabs in a similar way to the forward button in a web browser. See Section 1.4, “Navigating around sFlowTrend-Pro using the history navigator”
NavigateAdd bookmark
Allows you to save a bookmark for the currently viewed tab and its settings, so that you can return to the same tab with these settings later. See also Section 1.4.1, “Bookmarking a tab and its settings”
NavigateShow all bookmarks
Brings up a dialog which shows the currently saved bookmarks and allows you to view the settings saved in each bookmark, rename and rearrange bookmarks, and select a bookmarked tab and its settings that you now want to view. See also Section 1.4.2, “Organising bookmarks”
NavigateGo to bookmark
Displays the currently saved bookmarks in a hierarchical menu. Select a bookmark from the menu to go to the bookmarked tab configured with the settings saved in the bookmark. See also Section 1.4.3, “Going to a previously bookmarked tab”
HelpContents
Shows the contents of the on-line help in a new window.
Help Help on current view
Shows help for the current tab being viewed in sFlowTrend-Pro.
Help Point and click help
Changes the mouse cursor to a help pointer , and then allows you to click anywhere within the sFlowTrend-Pro window. Instead of the mouse click having its usual effect, context sensitive help will be displayed for the part of the window that was clicked.
HelpAbout sFlowTrend-Pro
Shows information about sFlowTrend-Pro, including the version number.
HelpHelp on the web
Opens a web browser and views the sFlowTrend-Pro on-line help from the web.
HelpsFlowTrend-Pro home page
Opens a web browser and views the sFlowTrend-Pro home page.