You can launch all TrafficDirector executable files and utilities directly from the command line. This chapter lists each executable file and utility, with a short description. To list the arguments for an executable file or utility, enter its name at the command prompt, followed by a space, and press Enter. TrafficDirector lists the arguments, if any.
Command line utilities are an alternative way to launch applications, graphs, daemons, and other utilities from outside the TrafficDirector GUI. Most of the command line utilities in this chapter have a direct counterpart you could use in the GUI. The functionality is the same, whether you launch something from the GUI or from a command line utility.
Keep in mind that each utility has separate arguments that you might want to use. For more detail about exact syntax and arguments to use with a command line utility, please see the on-line man pages.
Command line utilities are useful in many different situations. To help you quickly locate the command line utility you need, we've provided a quick reference table.
The table, beginning below, lists all command line utilities in alphabetical order, describes the type of each utility, and points you to the page where you'll find the description. After the table, you'll find a brief description of each utility, categorized by function, starting on page 51-4.
The following utilities are stand-alone programs that perform various functions, as described.
- instlic. Installs a license for TrafficDirector. Use this utility to install your TrafficDirector temporary and permanent licenses. Whenever you use this utility, you're prompted to enter the license information included with your software. License installation scripts.
- nstosnif. Converts TrafficDirector-format packet capture file to Sniffer format.
Non-interactive utilities are tools that you can use "behind the scenes" of the TrafficDirector GUI to administer database tables, event logs, and perform several advanced functions that do not have a GUI. The following listing describes all the remaining non-interactive utilities you can use and provides a brief description of the utility.
- dvadmin. Maintains the trap destination "admin" table in the agent you specify. Use this utility to maintain the trap-target table that the specified agent uses to determine hosts that receive an SNMP trap as the result of a Trap Manager event. Use dvadmin to add or delete entries or to list the contents of this table.
- dvattach. Attaches a port or slot as a monitor port for a switch you specify.
- dvcl. Lists contents of the conversation table for the agent and domain you specify. Use this utility to get a full or partial listing of a conversation table.
- dvclean. Deletes MIB tables from an agent. Use this utility to delete some or all MIB tables from the agent you specify. You can specify certain types of tables to delete, or just use the utility without specifying a type to delete all MIB tables (doing so is the same as a soft reset on the agent).
Note If you use this utility for a multi-interface agent, it deletes MIB tables for all interfaces, not just the interface associated with the specified agent's name!
- dvdcap. In the agent, captures packets associated with a given filter, stops data capture, uploads captured packets from the agent to a file, and also deletes data capture in an agent. Use this utility for the functions listed above, or use as part of a shell script that's executed when a Trap Manager-defined alert is received.
- dvdeinst. Deinstalls domains from an agent. Use this utility to deinstall some or all MIB tables associated with a specific domain from the agent you specify. You can specify certain types of domain tables to delete, or just use the utility without specifying a type to delete all domain tables. Keep in mind, however, that if you deinstall a domain on an RMON2 probe, it frees agent resources without deleting the domain, but if you deinstall a domain on an RMON probe, the domain is deleted.
- dvdetach. Detaches a port or slot as a monitor port for a switch you specify.
- dvdomid. Gets the agent channel number associated with a specific domain. Use this utility to get the channel number (instance) associated with a specific domain and write the result to stdout (if the result is 0, the domain you specified is not installed). Use this utility when you need to launch non-TrafficDirector applications that might require the instance of tables associated with a specific domain.
- dvdump. Dumps agent information or agent MIB tables. Use this utility to troubleshoot, by looking at details of the raw agent MIB tables or by looking at agent information, including IP address, IFN, IFTYPE, and MAC address. If you use this utility to dump agent MIB table information, you can specify that just certain types of MIB tables are dumped or that all MIB table types are dumped.
- dvevlog. Dumps agent event logs associated with a domain. Use this utility to dump internal agent logs of events associated with a specific domain (event logs usually correspond to alarms the agent sends when a threshold set in Trap Manager is reached or exceeded).
- dvftp. Downloads DLCI configuration information into a specified agent.
- dvfdstn. Manages and monitors an FDDI agent's ring station list. Use this utility when you need to create or delete a ring station table that a specific FDDI agent maintains. You can also use this utility to list status for all stations on the ring or get configuration information for an individual station.
- dvget. Gets and displays the SNMP variable you specify. Use this utility when you want to see the value of a specific SNMP variable.
- dvhelp. Provides Help on dv commands. Use this utility any time you need help with syntax and arguments for any dv command.
- dvhist. Lists contents of the agent history table for a specified domain. Use this utility to get segment statistics history the agent maintains for a specified domain. You can get either long- or short-term history, and for Token Ring agents, either the default promiscuous or non-promiscuous, MAC-level history.
- dvhl. Lists contents of the host table for the specified agent and domain. Use this utility to get a full or partial listing of a host table.
- dvinst. Installs domains at the agent you specify. Use this utility to install domains at an agent, if you don't want to or can't use the interactive Domain Manager application on the TrafficDirector main window.
- dvlearn. Autodiscovers complex devices on a network segment, such as ports on a switch and frame relay agent DLCI ports. Results of this command line utility may automatically create files, such as the x.swp files (for learned switch ports) and x.frp files (for learned frame relay DLCI ports).
- dvlist. Lists the domains installed at an agent. Use this utility to display a list, including the host mode the domain uses for host and conversation tables, as well as the yes/no flags that indicate which tables are installed that are associated with the domain. If you redirect the output displayed when you use the dvlist utility to a file, you can use it as the configuration file for the dvinst utility.
- dvnext. Gets and displays the next SNMP variable defined in the MIB table after the one you specify with the dvnext utility.
- dvreport. Generates reports non-interactively. Use this utility at the command line or from a script to generate tabular and CSV reports non-interactively.
- dvset. Sets the value of an SNMP variable you specify to an OID type (-i for integer, -s for string, -h for MAC address, and -o for object identifier) and a corresponding value. Use this utility any time you need to change the type and value of an SNMP variable.
- dvsnap. Provides a snapshot of domain activity for a short-term period. Use this utility to display segment, host, or conversation statistics for an interval you specify.
- dvtime. Converts time intervals to "timestamps" suitable for use with the dvreport utility. Use this utility to help generate daily, weekly, or monthly reports non-interactively. You can pass the output of dvtime as start time and end time "timestamp" command line arguments to the dvreport utility.
- dvtrsr. Manages and monitors a Token Ring agent's source routing table. Use this utility to create or delete the source routing table that a Token Ring agent maintains. You can also use this utility to list the contents of the table.
- dvwalk. Gets and displays all SNMP variables defined in a MIB table, starting from a variable you specify.
The following list describes all the applications featuring graphical displays that you can launch from the command line.
- grconv. Displays a real-time graph of a domain-based conversation between two hosts. Corresponds to the Conversation Stats graph GUI.
- grdommon. Displays simultaneous domain activity graph for multiple agents and domains in bar or pie chart format. Corresponds to the Protocol Monitor GUI.
- grhist. Displays a historical graph of segment statistics for a specified domain; you can display either a short-term or long-term history graph. Corresponds to the Segment History graph GUI.
- grhl. Displays a bar chart of the top 20 hosts that meet sort criteria you define for the specified domain. Corresponds to the Host List graph GUI.
- grhost. Displays a graph of domain-based traffic for a selected host. Corresponds to the Host Stats graph GUI.
- grhz. Displays a bar chart of the top 16 host conversations that meet sort criteria you define. Corresponds to the Host Zoom graph GUI.
- grpktmon. Displays segment activity for multiple agents and domains in bar or pie chart format. Corresponds to the Traffic Monitor GUI.
- grreport. Generates graph-based reports non-interactively. Corresponds to the Trend Reporter GUI.
- grstat. Displays a graph of segment statistics for the agent and domain you specify. Corresponds to the Segment Details graph GUI.
- grsz. Displays graphs for multiple domain statistics you specify. Corresponds to Segment Zoom graph GUI.
The following list describes all the applications featuring textual displays that you can launch from the command line.
- nsaltmon. Displays SNMP traps collected from TrafficDirector probes. Corresponds to the Alert Monitor GUI.
- nscl. Displays cumulative conversation traffic for all hosts in a specified domain. Corresponds to the Conversation List GUI.
- nsdcap. Lets you configure an agent data capture session by specifying filter information, buffer and slice size, among others. Also lets you upload captured data from the agent's buffer to a disk file; you can analyze this later using Protocol Decode. Corresponds to the Data Capture GUI.
- nsdomed. Lets you create, edit, or view a domain definition or get a list of all defined domains. Corresponds to the Domain Editor GUI.
- nsdommgr. Lets you view installed domains for a single agent or a group or agents. Also gives a summary of current domain activity for scoped agents and domains. Corresponds to the Domain Discovery GUI.
- nsfdrsl. Displays a list of stations on the agent FDDI ring you specify, including ring status and configuration information for each station. Corresponds to the FDDI Ring Station List GUI.
- nsfilted. Lets you create, edit, or view a filter definition. Also lets you get a list of all defined filters. Corresponds to the Filter Editor GUI.
- nshl. Displays a list of cumulative inbound and outbound traffic for all hosts in the domain you specify. Corresponds to the Host List GUI.
- nshz. Displays current domain-based traffic activity for the host you specify, including a list of top conversations with other hosts. Corresponds to the Host Zoom GUI.
- nslogin. Gives you remote access to a TrafficDirector probe's configuration menu, without requiring a local serial port connections. Corresponds to the Remote Login GUI.
- nsman. Starts the main TrafficDirector window that you use to configure switches, agents, and agent groups. Also lets you launch other GUI tools.
- nspdec. Decodes packets that are captured and uploaded from an agent, by using the Data Capture application. Corresponds to the Protocol Decode GUI.
- nsproped. Gives you the ability to edit the agent Settings files.
- nsrepted. Launches the report editor.
- nsresmon. Configures an agent you specify to perform proxy IP pings or proxy SNMP polls. Corresponds to the Round Trip Delay GUI.
- nsshell. For model 9450 (Windows platform) only, provides a command line-oriented execution environment for non-GUI applications. Most command line tools are part of the shell and run within the context of the shell. Corresponds to the Command Shell.
- nssz. Displays a tabular-form summary of segment traffic for a domain you specify. Corresponds to the Segment Zoom GUI.
- nstrend. Lets you generate Frontier-defined reports. Corresponds to the Trend Reporter GUI.
- nstrrsl. Displays a list of stations on the agent Token Ring ring you specify, including ring status and configuration information for each station. Corresponds to the Token Ring Station List GUI.
- nstrsr. Displays source routing information for the agent Token Ring you specify. Corresponds to the Source Route Monitor GUI.
The TrafficDirector daemons, which are started automatically when you run the software, are described as follows.
- dbautod. Database autoreporter daemon.
- dbextrad. Database extraction daemon.
- dbrolld. Database rollup daemon.
- dbsnapd. Database snapshot daemon.
- dvconfd. Agent configuration daemon.
- dvtrapd. SNMP Trap daemon.
- dbchckd. Process that checks to make sure all other daemons are running.
