Startup and Configuration Files

In this appendix, you will find information about the agent startup file and alert script files. The agent startup script file contains information that you enter and modify that reflects the configuration of a specific probe. The alert script files contain information about various thresholds set on certain variables that you set through Trap Manager.

These two types of files are helpful when you need to reconfigure a probe that has been reset. To do so, you can run the startup file, which reinstalls all the domains and other parameters you specified on the probe and in the file. You can also run alert script files to reinstall trap conditions and thresholds that you want the probe to use.

Agent Startup File

When you define an agent by clicking the New button in the TrafficDirector main window, one of the fields is the name of the startup file. This field specifies the name of a script file to be executed when the configuration daemon (dvconfd) receives a configuration request from an agent that has been reset.

A default startup script file named startup ships with TrafficDirector. The default path is $NSHOME/usr. This standard startup file is displayed below:

#
# Default startup script file "startup"
#
# Note: "$1" is a macro replaced by the agent name.
#
# Startup scripts must have execute permission on Motif platforms
#
# dvinst dvint.cfg %1

The agent name is passed as an argument so that you can use the same startup script for multiple agents, if you want. Typically, you use the startup script to configure or reconfigure an agent to a specific domain setup. The default startup does this by running the dvinst utility. The arguments passed to dvinst are the name of a configuration file, dvinst.cfg, and the name of the agent. The default dvinst.cfg (in $NSHOME/usr) is displayed below:

#
# Domain configuration file
#
#	Host	Segment	Short	Long	Packet
#Domain	Mode	Stats	History	History	Host	Conversation	Capture
#---------------- ------ ------- 	-------  -------   ---- -------------- ------------
RMON 	MAC	y 	y        y        y        n 			n

Alert Scripts

When you configure an alert at an agent using Trap Manager, you can specify the name of a script file to be executed when TrafficDirector receives a trap message from the agent. You can specify different scripts for rising and falling thresholds, as well as for different watched variables.

When the trap daemon (dvtrapd) receives a trap message from the agent, if the message specifies a script the daemon executes it. The name of the agent and the user-specified severity level are passed as arguments to the script. An example alert script is displayed below:

#
# Sample alert script "mytrap.sh"
#
	date > mytrap.$$
echo Trap received from agent $1, severity level $2. >> mytrap.$$
$NSHOME/bin/dvsnap $1 ALL HOST 15 10 >> mytrap.$$
mail `whoami` < mytrap.$$

Note that the $$ macro is interpreted as the process ID, and $1 and $2 are the agent name and severity level, respectively. These are shell substitutions. The shell script should be given "execute" permission (for example, % chmod 755 mytrap.sh).

In this example, the script sends you a mail message indicating the time when the trap was received, the agent name and severity level, and a list of the top ten transmitting hosts for the 15-second interval following trap reception. From the script, you can run any of the TrafficDirector command line tools or other standard tools.

Configuration Files

Configuration files contain definitions or parameters of some sort. Usually, you can edit configuration files to update information or further customize information for your needs. Some configuration files are specific to a particular installation, but others can be used at any installation. When a file is specific to a particular installation, it contains definitions that usually apply to hardware connected to segments local to the TrafficDirector installation site. The agent.lst file is an example; unique agent definitions and IP addresses apply only to agents on specific segments.

For example, if you had two TrafficDirector clients installed, one on a workstation in Paris, Texas, and the other in New York City, New York, you would need a different agent.lst file for each TrafficDirector client. On the other hand, the domain.lst file contains domain definitions that you could use wherever TrafficDirector is installed. The following list outlines major configuration files available with TrafficDirector:

agent.lst	Specific to a particular installation, this file contains agent definitions. Each line within the file defines a unique SNMP agent that TrafficDirector can access. Agent names you specify can be up to 15 characters. You create and update this file through TrafficDirector, although you can edit the file directly. You can define up to 1000 agents in this file.
agegroup.lst	Specific to a particular installation, this file contains agent group definitions. Each line within the file defines a unique group of SNMP agents that TrafficDirector can access. To be included in this file, agent definitions must first be defined in the agent.lst file. Agent group names you specify can be up to 15 characters. You create and update this file through TrafficDirector, although you can edit the file directly. You can define up to 100 agent groups in this file; each agent group can contain up to 60 agents.
domain.lst	Available for use at any installation, this file contains domain definitions. Each line within the file defines a unique domain which represents a characterization of traffic. TrafficDirector supports two types of domains. Protocol domains represent MAC, network and application layer protocols. Generic domains are part of the Enterprise RMON specification, are available for use only on SwitchProbe devices, and are represented using a collection of filters. You create and update this file through the TrafficDirector Domain Editor application. Domain names you specify can be up to 8 characters. You can define up to 200 domains in this file.
switch.def	Available for use at any installation, this file contains a list of switch vendors that TrafficDirector supports. Each line in the file defines a vendor-specific switch, as well as information about whether the switch contains any RMON support. Up to 100 switch types may be defined in this file. Do not edit this file, as it contains critical data. As additional switch types are supported in the future, Cisco Systems will provide updated switch.def files.
switch.lst	Specific to a particular installation, this file contains a list of defined switches you can use with TrafficDirector. Each line within the file defines a unique switch. You create and update this file through TrafficDirector applications. Each agent in this file represents a switched SNMP agent that TrafficDirector can access. A switch is represented by all its ports, applicable attached dedicated agents, or roving agents. Switch names you specify can be up to 15 characters. To be included in this file, the switch type (vendor-specific) must first be defined in the switch.def file. You can define up to 1000 switches in this file.
x.swp	Specific to a particular installation, this file contains a list of port names, port numbers, interface numbers, slot numbers, interface types, and interface speeds for a specific switch. This file name is derived from the first 15 characters of the switch name. The number of lines in this file equals the number of discovered ports. Currently, TrafficDirector discovers only Ethernet and Fast-Ethernet ports. TrafficDirector automatically creates this file when you use either the Learn function in TrafficDirector, TrafficDirector (before you launch Traffic Monitor for a defined switch), Domain Manager, or the dvlearn command line tool. To be included in this file, the switch must first be defined in the switch.lst file. Each switch listed in the switch.lst file must also have a corresponding x.swp file.
x.frp	Specific to a particular installation, this file contains a list of DLCI numbers, DLCI names, CIR definitions, and virtual interface numbers for a specific frame relay agent. This file name is derived from the first 15 characters of the frame relay agent name. The number of lines in this file equals the number of discovered DLCI ports. TrafficDirector automatically creates this file if it is not already present when you use either TrafficDirector (before you launch Traffic Monitor for a frame relay agent), Domain Manager, or the dvlearn command line tool. You can also create this file (except for the vifn field that contains the value of the virtual interface number) through either an ASCII text editor, such as vi, or build it incrementally by using the Edit Name feature in the Host List application. Using the Edit Name feature may be especially useful if a frame relay agent does not have the capability to automatically discover DLCIs.
x.fil	Available for use at any installation, this file contains parameters set for a specific filter. This file name is derived from the first 15 characters of the filter name. The number of lines in this file depends upon the parameters you specify for the filter when you create it using the Filter Editor application. To edit an x.fil file, you can use a text editor or do so by editing a filter definition through the Filter Editor application. Each filter defined must also have a corresponding x.fil file. You can specify up to 200 filters in the TrafficDirector database.
macaddr.nam	Specific to a particular installation, this file contains unique MAC-address-to-name-mapping information. Each line within the file contains a MAC address and the corresponding name you have defined for a host. You can create this file through an ASCII text editor, such as vi, or build it incrementally by using the Edit Name feature in the Host List application. You can specify name mappings for up to 10,000 MAC addresses in this file.
ipaddr.nam	Specific to a particular installation, this file contains unique IP-address-to-name mapping information. Each line within the file contains an IP address and the corresponding name you have defined for a host. Although this file is typically a copy of the etc/hosts file, you could choose to build it incrementally by using the Edit Name feature in the Host List application. You can specify name mappings for up to 10,000 IP addresses in this file.
vendorid.nam	Available for use at any installation, this file contains unique vendor-ID-to-name mapping information. Each line within the file contains a vendor code and the corresponding vendor ID. Cisco Systems supplies this file as part of the TrafficDirector software; as such, we strongly recommend that you do not edit this file, although you can choose to do so with any ASCII text editor, such as vi. Vendor IDs can be up to six characters long, and this file can contain up to 500 vendor names and IDs.
vlan.nam	Specific to each application, this file contains unique VLAN to name mapping information. Each line within the file contains a VLAN ID and the corresponding VLAN name you have defined. You can create this file through either an ASCII text editor, such as vi, or build it incrementally by using the Edit Name feature in the Host List application. You can specify up to 500 VLAN IDs and names in this file.
default.dvp	Available for use at any installation, this file contains unique agent/domain configuration parameters. Cisco Systems supplies this file as part of the TrafficDirector software; as such, it is strongly recommended that you do not edit this file, although you can choose to do so with any ASCII text editor, such as vi.
domtree.inf	Available for use at any installation, this file contains parent-child relationship definitions between various domains. Cisco Systems supplies this file as part of the TrafficDirector software. You can enhance and edit this file through any ASCII text editor, such as vi. The Protocol Monitor and Trend Reporter applications primarily use this file.
x.mib	Available for use at any installation, this file contains variable names and corresponding object ID information. Each line within the file contains a variable name and the corresponding object ID (OID). This file name is derived from the first 15 characters of the MIB name. The number of lines in this file equals the number of variables in the MIB. Cisco Systems ships several x.mib files with TrafficDirector. Keep in mind that these files are created when MIB/RFC is compiled with a standard MIB compiler; this means that x.mib files do not contain comment lines or headers. This is a important distinction because other configuration files created by Cisco Systems or that are created automatically when you use a TrafficDirector application do contain comment lines and headers.
pvartrap.inf	Specific to a particular installation, this file contains definitions for MIB variables whose trap characteristics should be modified by Trap Manager. Each line within the file contains a variable name, trap numbers that indicate trap type, rising threshold, and falling threshold, as well as the SYSOID.
x.rtp	Specific to a particular installation, this file contains unique logical router name-to-interface-number mapping. Each line within the file contains an interface number and the corresponding name you have defined for the router. This file name is derived from the first 15 characters of the corresponding agent name. This file is built incrementally by using the Edit Name feature in the Host List application. You can specify interface to name mappings for up to 1000 routers in this file.
applayer1.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for application layer one. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
applayer2.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for application layer two. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
applayer3.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for application layer three. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
applayer4.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for application layer four. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
applyer5.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for application layer five. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
dllayer.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for the physical (data link) layer. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.
nllayer.inf	Available for use at any installation, this file contains protocol name and ID information. Each line within the file contains a protocol name and the associated ID number. This file, used only in the Domain Editor application, specifies the available protocols you can select for the network layer. Cisco Systems ships this file with TrafficDirector. If necessary, you can edit this file using any ASCII text editor, such as vi.

Table of Contents