|
|
This chapter provides information about modifying IPM components. IPM components include collectors, source routers, target devices, and operations. Information is provided on viewing, updating, and deleting these components.
This chapter contains the following major sections:
IPM source routers are the routers from which you initiate operations for measuring network performance statistics. Each source router must contain the SA Agent feature and an SNMP agent.
information about working with source routers is provided in the following subsections:
To view a list of configured source routers, select Edit > Configuration from the IPM Main window. The Configuration window (Figure 2-3) is displayed. By default, Sources is selected in the navigation pane and the Source Configuration window is displayed within the Configuration window.
The Source Configuration window displays source routers you already configured. From this window, you can add a new source router, change the configuration of an existing source, or delete an existing source.
The Source Properties window allows you to view the properties of a defined source router.
To view source router properties:
Step 2 Select View > Properties. The Properties Viewer window is displayed. By default, the Collector Properties window is displayed within the Properties Viewer window.
Step 3 Click Source. The Source Properties window (Figure 4-1) is displayed.

For information about these fields, refer to the "Source Properties Window" topic in the online help.
Before you can use a router as a source for a collector, you must define the router as an IPM source router.
To add a new source router:
For information about configuring SNMP on the source router, see the "Configuring Your Routers to Send SA Agent-Related Traps" section in the "Preparing to Install" chapter of the Cisco Internetwork Performance Monitor Installation Guide.
Step 2 From the IPM Main window, select Edit > Configuration. The Configuration window (Figure 2-3) is displayed. By default, the Source Configuration window is displayed within the Configuration window.
Step 3 In the Hostname or IP Address field, enter the IP address or host name of the router on which the source resides. This host name can be from 1 to 64 characters in length.
Step 4 In the Read Community field, enter the SNMP community name for read access to the information maintained by the SNMP agent on the source router. This value can be from 1 to 32 characters in length. Do not include special characters such as \Q @ $ ^ * ' '' & |. The default value is public.
Step 5 In the Write Community field, enter the SNMP community name for write access to the information maintained by the SNMP agent on the source router. Do not include special characters such as \Q @ $ ^ * ' '' & |. This value can be from 1 to 32 characters in length.
Step 6 In the Name field, enter a name to assign to the source router. You can use this field as an alias.
Step 7 (Optional) In the Description field, enter a brief description of the source router.
Step 8 Click Add. IPM attempts to locate the router and determine whether or not it is SNMP-enabled with the correct community string. If the router is successfully located, IPM adds it to the IPM database. If IPM cannot reach the router, IPM displays an error message.
![]() |
Note If you specify an IP address instead of a host name, and that IP address cannot be resolved by standard address resolution techniques, then IPM displays the IP address for the source router instead of a host name. |
Step 9 Click OK to close the Configuration window and return to the IPM Main window.
For information about using a seed file to add source routers to IPM, see the "Adding Components Using Seed Files" section.
You can delete source routers you no longer need. You can delete more than one source router at a time.
![]() |
Note If a source router has been configured as part of one or more collectors, you must delete the collectors before you can delete the source router. |
To delete a source:
Step 2 Click Delete.
Step 3 When the confirmation box appears, click Yes. The selected source routers are deleted from the IPM database.
IPM targets are destination devices for which you want to gather network performance statistics. A target can be any IP-addressable device, a Cisco router running the SA Agent Responder, or an SNA host.
![]() |
Note The SA Agent Responder is supported only in Cisco IOS software release 12.0(5)T or later. We strongly recommend software release 12.1 or later. |
information about working with target devices is provided in the following subsections:
After you have defined a device as an IPM target, it appears in the list of defined targets in the Target Configuration window.
To view a list of defined targets:
Step 2 Click Targets. The Target Configuration window (Figure 2-4) is displayed.
The Target Configuration window displays a list of all devices defined as IPM targets. From this window, you can define a new target, modify an existing target, or delete a target.
The Target Properties window allows you to view the properties of a defined target.
To view target properties:
Step 2 Select View > Properties. The Properties Viewer window (Figure 4-6) is displayed. By default, the Collector Properties window is displayed within the Properties Viewer window.
Step 3 Click Target. The Target Properties window (Figure 4-2) is displayed.

For information about these fields, refer to the "Target Properties Window" topic in the online help.
IPM targets are destination devices for which you want to gather data. A target can be any IP-addressable device, an SA Agent Responder, or an SNA host.
To add a new target:
Step 2 Click Targets. The Target Configuration window (Figure 2-4) is displayed.
Step 3 In the Target Type field, select the protocol type to be used with this target. The possible values are:
Step 4 Based on the Target Type you selected, take one of the following actions:
Step 5 In the Name field, enter a name to assign to the target. By default, this field matches the Hostname, IP Address, or PU Name field, but you can modify the name (for example, to use it as an alias).
Step 6 (Optional) In the Description field, enter a brief description of the target.
Step 7 Click Add. IPM adds the newly defined target to the IPM database.
![]() |
Note If you specify an IP address instead of a host name and that IP address cannot be resolved by standard address resolution techniques, then IPM assumes that the IP address is valid and does not resolve to a host name. |
Step 8 Click OK to close the Configuration window and return to the IPM Main window.
For information about using a seed file to add targets to IPM, see the "Adding Components Using Seed Files" section.
You can delete targets you no longer need. You can delete more than one target at a time.
![]() |
Note Once you have associated a target with a collector, you cannot delete the target without first deleting the collector with which it is associated. |
To delete a target:
Step 2 Click Delete.
Step 3 When the confirmation box appears, click Yes. The selected targets are deleted from the IPM database.
If you try to delete a target and IPM issues an error message such as Could not delete the target, the reason is most likely one of the following:
To resolve the problem, use the following procedure:
Step 2 If you still cannot find the target's name, remember that the Path Echo Historical Statistics window shows only the 10 most used paths. To see the rest of the intermediate paths, you must use the IPM Path Usage report. To do so:
a. On the IPM Server Home Page, select Configuration Reports > Collectors. The Collector Information page is displayed.
b. Select the first Path Echo collector in the list and click Path Usage in the Details column. The Path Usage page is displayed.
c. Click a path to expand it, showing all of its intermediate hops, and look for the target's name. If you find the target's name, you must delete that Path Echo collector before you can delete the target.
d. Repeat this procedure for every path under every Path Echo collector.
An IPM operation is an alias for a set of parameters used in measuring performance. information about working with operations is provided in the following subsections:
To view a list of defined operations:
Step 2 Click Operations. The list of operations expands to show the types of operations that were defined.
Step 3 Click an operation type. The Operation Configuration window (Figure 4-3) shows the default configuration for the selected operation type and the list of operations expands to show all defined operations of that type.
The Operation Configuration window displays a list of all defined operations. From this window, you can define a new operation, modify an existing operation, or delete an existing operation.
![]() |
Note When you install IPM, a group of predefined operations is provided. The predefined operations cannot be modified. However, you can use them as templates for creating your own operations. For a listing and brief description of these operations, refer to the "Defining a Collector" section. |

The Operation Properties window allows you to view the properties of a defined operation.
To view operation properties:
Step 2 Select View > Properties. The Properties Viewer window (Figure 4-6) is displayed. By default, the Collector Properties window is displayed within the Properties Viewer window.
Step 3 Click Operation. The Operation Properties window (Figure 4-4) is displayed.

For information about these fields, refer to the "Operation Properties Window" topic in the online help.
An IPM operation is an alias for a set of parameters used for measuring performance between source router and a target device.
To define an operation:
Step 2 Click Operations. The list of operations expands to show the types of operations that were defined.
Step 3 Click an operation type. The Operation Configuration window (Figure 4-3) shows the default configuration for the selected operation type and the list of operations expands to show all defined operations of that type.
Step 4 Set the options for the operation you want to define. Detailed information about defining operations to measure performance for DHCP, DLSw, DNS, HTTP, IP, SNA, TCP, UDP, and Voice over IP is provided in the "Using IPM to Measure Network Performance" chapter.
Step 5 Click OK to complete the definition of a monitoring operation. IPM redisplays the Operation window and the new operation is added to the list of defined operations.
From the Operation Configuration window, you can configure thresholds and event notifications on the source router.
To set thresholds and generate alerts using an operation:
Step 2 In the Generate Action Event field, select one of the algorithms to be used by IPM to calculate threshold violations. The following values are possible:
Step 3 In the Rising field, enter a rising threshold, in milliseconds. Valid values are between 1 and 99999 milliseconds. The default is 5000 milliseconds. When the latency exceeds the rising threshold, the collector uses the algorithm specified in Generate Action Event to determine if a threshold violation has occurred. If a violation occurs, the action defined in Action Event Type is taken.
Step 4 In the Falling field, enter a falling threshold, in milliseconds. Valid values are between 0 and 99999 milliseconds. The default value is 3000 milliseconds. When the latency falls below the falling threshold, the threshold is reset. Only one event is generated for the time the latency is above the rising threshold.
Step 5 If you specified a Generate Action Event of Consecutive, X of Y, or Average, enter a value in the X field to be used in calculating the threshold. Valid values are 1 to 16. The default is 5.
Step 6 If you specified a Generate Action Event of X of Y, enter a value in the Y field for the Y value to be used in calculating the threshold. Valid values are 1 to 16. The default is 5.
Step 7 In the Timeout Value field, enter the amount of time, in milliseconds, for the collector to wait for a response to its echo operation. When a timeout occurs, the Timeout counter is incremented. The timeout value must be less than the specified sample interval. Valid values are between 0 and 604800. The default value is:
![]() |
Note To ensure interoperability with Cisco IOS, the Timeout Values for TCP Connect and DNS operations are fixed at 60000 and 9000 milliseconds, respectively. If you enter some other value, IPM changes the value you enter to the default value. |
Step 8 Enable the Timeout option to check for latency reporting operation timeouts based on the timeout value configured for the collector. If you enable the Timeout option, the action (specified in Action Event Type) is taken when a timeout occurs, or is cleared on this collector.
Step 9 Enable the Connection Lost option to check for connection loss in connection-oriented protocols (LU0, LU2, and SSCP). If you enable the Connection Lost option, the action specified in Action Event Type is taken when a loss of connection, or a reconnection after a loss, occurs on this collector.
Step 10 In the Action Event Type field, select the action (or combination of actions) for the collector to perform when:
For the action type to occur for threshold events, the threshold type must be defined to any value other than Never. The possible actions are:
Step 11 Click OK to complete the operation definition. IPM adds the new or updated operation to the IPM database.
You can delete operations you no longer need.You can delete more than one operation at a time.
Collectors that use the deleted operation continue to function correctly.
![]() |
Note You cannot delete the default operations provided with IPM. |
To delete an operation:
Step 2 Click Delete.
Step 3 When the confirmation box appears, click Yes. The selected operations are deleted from the IPM database.
A collector is a definition of the source router, the target device, an operation, and the collector schedule. To collect network performance statistics using IPM, you must define a collector.
information about working with collectors is provided in the following subsections:
All of the defined collectors are listed in the IPM Main window (Figure 2-1). Any collectors with start dates and times earlier than the current date and time, and end dates and times later than the current date and time, are considered active collectors.
The following status information is displayed about each collector in the IPM Main window:
![]() |
Tips You can sort the collector information displayed in the IPM Main window by clicking on the column titles. By default, the information is sorted based on collector name. Optionally, you can sort the information based on start time, target, or operation type. |
To view a summary of the number of collectors on the server, broken down by current state (Running, Expired, and so on), select View > Collector State Summary from the IPM Main window. The Collector State Summary(Figure 4-5) window is displayed.
For information about these fields, refer to the "Collector State Summary Window" topic in the online help.

To view detailed information about a defined collectors:
Step 2 Select View > Properties. The Properties Viewer window (Figure 4-6) is displayed. By default, the Collector Properties window is displayed within the Properties Viewer window.

![]() |
Note If the Collector Properties window is not displayed by default, click Collector. |
For information about these fields, refer to the "Collector Properties Window" topic in the online help.
Defining a new collector involves selecting a source router, a target, an operation, and a collector schedule.
To define a new collector:
Step 2 Click Collectors. The Collector Configuration window (Figure 2-5) is displayed within the Configuration window.
Step 3 In the Name field, type a name to assign to the collector
Step 4 (Optional) In the Description field, enter a brief description of the collector.
Step 5 In the Collector Type field, enable the Collect Statistics option to gather data and store it in the IPM database for future analysis. If this option is not enabled, you can view data in real-time only. Network performance data is not stored in the IPM database. By default, Collector Type is set to collect statistics.
Step 6 Do one of the following:
![]() |
Note For DNS, DHCP, and HTTP, a target is not required. |
For a brief description of the predefined operations provided with IPM, see Table 2-1.
![]() |
Note IPM does not provide a predefined HTTP operation. Therefore, before you create an HTTP collector, you must first create an HTTP operation. See the "Adding a New Operation" section for more information. |
Step 10 Click OK. IPM adds the newly defined collector to the IPM database.
For information about using a seed file to add collectors to IPM, see the "Adding Components Using Seed Files" section.
You can delete collectors you no longer need. When you delete a collector, all data related to that collector is removed from the database, and the collector and the SA Agent entry are removed from the source router. If the selected collector is active, IPM first stops the collector, then deletes it. The collector remains in Delete Pending state until the data is completely deleted from the IPM database. It can take several minutes or more to delete a collector that has a large amount of data stored in the IPM database.
You can delete more than one collector at a time.
To delete an IPM collector:
Step 2 Select Edit > Delete.
Step 3 When the confirmation box appears, click Yes. The selected collectors are deleted from the IPM Main window.
In addition to defining source routers, targets, and collectors from their respective Configuration windows, you can define them using seed files. A seed file is a text file containing the information required to define one or more components. This is especially useful if you must add a large number of sources, targets, or collectors quickly.
You must create a separate seed file for each type of component. For example, you cannot mix source router definitions and collector definitions in the same seed file.
The following sections provide detailed information about seed files:
To create a source router, target, or collector seed file:
Step 2 Save the source router seed file as a text file. The following table lists the default IPM seed file names and directories.
| Platform | Default Seed File Name | Default Seed File Directory |
|---|---|---|
Solaris | srcfile.txt | /opt/CSCOipm/etc/source |
trgtfile.txt | /opt/CSCOipm/etc/target | |
collfile.txt | /opt/CSCOipm/etc/collector | |
Windows NT | srcfile.txt | C:\Program Files\Internetwork Performance Monitor\Server\etc\source |
trgtfile.txt | C:\Program Files\Internetwork Performance Monitor\Server\etc\target | |
collfile.txt | C:\Program Files\Internetwork Performance Monitor\Server\etc\collector |
![]() |
Note If you installed IPM in a directory other than the default directory, you must specify that directory instead of /opt (for Solaris) or C:\Program Files\Internetwork Performance Monitor\ (for Windows NT). |
The top of the seed file contains a comments section for any information you want to note about the file, followed by each component's definition on a separate line.
You must separate each part of a component's definition with a delimiter. Valid delimiters are spaces, commas (,), semicolons (;), and tabs (\t). Use the same delimiter throughout a given seed file.
Do not begin a component with a comma, semicolon, or tab.
The following example is a valid source router definition, using spaces as delimiters:
#a router1 public private
If any part of a component's definition contains a space, you must use either a comma or a semicolon as the delimiter between all the parts of that definition. If the host name in the preceding example included a space (for example, router 1), you would use commas or semicolons as delimiters, instead of spaces:
#a,router 1,public,private
Table 4-1 describes each of the parts of a component's definition.
| Part | Description |
|---|---|
Command | Defines whether the source router, target, or collector is added to the IPM database, removed from the IPM database, or whether an existing component entry in the IPM database is updated from the seed file. The following values are possible: A or a---Adds the component to the IPM database. D or d---Removes the component from the IPM database. U or u---Updates an existing component entry in the IPM database from the information provided in the seed file. |
Host Name | (Source router and target only) IP address or host name of the router on which the source resides, or of the target device. The host name can be from 1 to 64 characters in length. As an option, you can include an alias for the router by adding a vertical bar (|) and the alias after the host name. |
Read Community | (Source router and target only) SNMP community name for read access to the information maintained by the SNMP agent on the source router. This value can be from 1 to 32 characters in length. Do not include special characters such as \Q @ $ ^ * ' '' & |. This value is usually set to public. |
Write Community | (Source router only) SNMP community name for write access to the information maintained by the SNMP agent on the source router. This value can be from 1 to 32 characters in length. Do not include special characters such as \Q @ $ ^ * ' '' & |. This value is usually set to private. |
Target Type | (Target only) The protocol type to be used with this target. Specify one of the following values: 1---IP. Requires an IP address or host name. 2---Cisco SAA Responder. Requires an IP address or host name and read community string. 3---SNA LU0, SNA LU2, or SNA SSCP-LU. Requires a host name. |
Collector Name | Name of the collector. |
Source | (Collector only) Name of the defined source router to use for this collector. The source router must be defined already in IPM or in a source router seed file. |
Target | (Collector only) Name of the defined target device to use for this collector. The target device must be defined already in IPM or in a target seed file. |
Operation | (Collector only) Name of the defined operation to use for this collector. The operation must be defined already in IPM. |
A sample source router seed file is shown below:
###############################################################################
#
# This file has example definitions for source routers.
#
# Comments starts with the "#" character
#
# The format of the file is as follows:
#
# <command><delim><hostname[|aliasname]><delim><read community><delim><write community>
#
# <delim> characters are " ;,\t" "space,semicolon,comma,tab"
#
# <hostname[|aliasname]> : Host name followed by optional aliasName
# separated with a `|' ("vertical bar")
#
# The valid commands are 'a|A' for add; 'd|D' for delete; 'u|U' for update;
#
# WARNING: Please assure the permissions on these files
# do not allow read access to all users due to
# the inclusions of SNMP community names.
#
###############################################################################
#a router1 public private
#a router2 santa claus
#a router3.foobar.com open secret
A sample target seed file is shown below:
###############################################################################
#
# This file has example definitions for target devices
#
# Comments starts with the "#" character
#
# The format of the file is as follows:
#
# <command><delim><target type><delim><hostname [<aliasname]><delim><read community>
#
# <delim> characters are " ;,\t" "space,semicolon,comma,tab"
#
# <hostname[|aliasname]> : Host name followed by optional aliasName
# separated with a `|' ("vertical bar")
#
# The valid commands are 'a|A' for add; 'd|D' for delete; 'u|U' for update;
#
# The <target type> is 1 for IP; 2 for CISCO_SAA_RESPONDER; 3 for SNA
#
# For CISCO_SAA_RESPONDER target type, read community string is required.
# and the IOS RTR (SA Agent) Responder must be enabled
#
# WARNING: Please assure the permissions on these files
# do not allow read access to all users due to
# the inclusions of SNMP community names.
#
###############################################################################
#a 1 www.foobar.com
#a 2 ios_router.foobar.com public
#a 3 sna_target.foobar.com
#a 1 server1
#a 2 router1 public
A sample collector seed file is shown below:
############################################################################### # # This file has example definitions for collectors # # Comments starts with the "#" character # # The format of the file is as follows: # # <command><delim><collName><delim><source><delim><target><delim> # <operation><delim><startTime><delim><duration><delim><collType> # # <delim> characters are " ;,\t" "space,semicolon,comma,tab" # # The valid commands are 'a|A' for add, 'd|D' for delete, 'u|U' for update; # # <collType> is M for Monitored, S for Statistical # # <startTime> is in the format MM:DD:YYYY:hh:mm:ss # # <startTime> = 1 -> start time will be now # # <duration> is in number of hours # # <duration> = 0 -> Forever # # <startTime> = zero and <duration> = zero -> ON_DEMAND collector # # For DHCP, HTTP, and DNS Operation types, the target field must be Unused or unused. # MyHTTP should be replaced with the name of an HTTP operation you created. # # DefaultJitter should be replaced by Default60ByteVoice, Default160ByteVoice, # DefaultVideo, or DefaultVPN. # ############################################################################### #a coll1 router1.cisco.com target1 DefaultIpEcho 1 12 M #a coll2 router1.cisco.com target2 DefaultUDPEcho 1 0 S #a coll3 router1.cisco.com target3 DefaultJitter 1 24 M #a coll4 router1.cisco.com target4 DefaultDLSw 0 36 S #a coll5 router2.cisco.com target1 DefaultSnaLu0Echo 1 6 M #a coll6 router2.cisco.com target2 DefaultSnaLu2Echo 1 12 M #a coll7 router2.cisco.com target3 DefaultSnaRuEcho 1 24 S #a coll8 router2.cisco.com target2 DefaultIpPathEcho 10:20:1999:01:00:00 36 M #a coll9 router.cisco.com Unused DefaultHTTPConn 1 0 S #a coll10 router.cisco.com Unused MyHTTP 1 0 S #a coll11 router.cisco.com Unused DefaultDNS 1 0 S #a coll12 router.cisco.com Unused DefaultDHCP 1 0 S ###############################################################################
To load components from a seed file into IPM:

Step 2 In the Seed File Type field, select Source, Target, or Collector as the type of seed file to load.
Step 3 In the Seed File Name field, type the name of the source router, target, or collector seed file.
Step 4 Click OK. The source routers, targets, or collectors you defined in the router file are added to the IPM database. When you access the Source Configuration, target Configuration, or Collector Configuration window, the changes you made to the components in the seed file are displayed.
![]() |
Tips If you do not remember the name of the seed file you want to load, you can view a list of available seed files from the Seed File window. Select Source, Target, or Collector as the Seed File Type and click View. |
For information about listing, viewing, editing, or loading seed files from the command line, see the "IPM Command Reference" section.
When you add a source router, target, or collector using a seed file, you create an output file that indicates whether the addition of the resource was successful. The output file has the same path and name as the seed file, with the addition of the .out suffix. For example, a seed file named labsrcfile.txt generates an output file named labsrcfile.txt.out.
An output file contains the same information as its seed file, with the addition of messages that indicate whether the addition of the resource was successful. For example, if labsrcfile.txt contains the following information:
a cwb-ipm-1600a public private a cwb-ipm-1600b public private a cwb-ipm-1700a public private
Then, if the addition of the resources is successful, the output file labsrcfile.txt.out would contain the following information:
a cwb-ipm-1600a public private - OK a cwb-ipm-1600b public private - OK a cwb-ipm-1700a public private - OK
If the resources cannot be added for some reason, OK is replaced with an appropriate error message. Possible error messages include:
ERROR: BAD VALUE PASSED ERROR: COLLECTOR LIMIT EXCEEDED ERROR: COLLECTOR NOT FOUND ERROR: DATABASE ERROR ERROR: DUPLICATE ENTRY ERROR: DUPLICATE NAME ERROR: INTERNAL ERROR ERROR: INVALID COMMAND ERROR: INVALID ENTRY ERROR: INVALID IOS VERSION FOR TARGET ERROR: INVALID PROTOCOL TYPE ERROR: INVALID RTT TYPE ERROR: INVALID TARGET FOR THE SELECTED OPERATION ERROR: LOST CONNECTION TO SNMP SERVER ERROR: OPERATION NOT FOUND ERROR: SOURCE NOT FOUND ERROR: TARGET NOT FOUND
When you physically move routers, servers, or other devices, you might need to change their IP addresses. You might also need to change IP addresses as your network grows. If you have a DNS server, IPM enables you to change an old IP address to a new IP address throughout the IPM database.
![]() |
Caution Changing an IP address changes every occurrence of that address in the IPM database, including historical statistics and source and target IP addresses, even if the target is an intermediate hop. Therefore, make sure you want to change every occurrence of the IP address in the IPM database before using this procedure. |
To change the IP address:

Step 2 In the Old IP Address field, enter the old address you want to change. This must be an IP address; it cannot be a host name.
Step 3 In the New IP Address field, enter the new IP address. Do not enter an IP address that already exists in the IPM database. If you do, IPM issues an error message and does not change the old IP address.
Step 4 Click OK. The IP address is changed throughout the IPM database.
The IPM client can seem unresponsive while the IP address is being changed. This is due to the high volume of messages being received by the client during this time.
If you change an IP address, you must wait until the change is complete in the IPM database before making another IP address change.
For more detailed information about the Change IP Address window, see the "Change IP Address Window" topic in the online help.
For collectors that are using a statistical operation, IPM gathers network performance and error statistics from the source router once every hour and stores the data in the IPM database. The collected hourly data is used to calculate daily, weekly, and monthly data.
By default, IPM stores the collected data for the following periods:
The IPM database preferences file allows you to control these parameters and also define the business hours and days. Defined business hours are used in determining the daily, weekly, and monthly averages, whereas business days are used in determining the weekly and monthly averages. The database preferences file also allows you to set the length of time that daily data is retained in the database.
Information about viewing and changing the database preferences is provided in the following sections:
To display the preferences in the currently running IPM database in Solaris, enter the following commands:
# cd /opt/CSCOipm/bin # ./ipm dbprefs view
In Windows NT, enter the following commands:
cd c:\Program Files\Internetwork Performance Monitor\Server\bin ipm dbprefs view
To display the preferences in the configuration file (which might differ from the preferences in the currently running IPM database), in Solaris, enter the following commands:
# cd /opt/CSCOipm/bin # ./ipm dbprefs viewfile
In Windows NT, enter the following commands:
cd c:\Program Files\Internetwork Performance Monitor\Server\bin ipm dbprefs viewfile The output from the view and viewfile versions of this command is formatted differently because ipm dbprefs view displays the contents of a database, but ipm dbprefs viewfile displays the contents of a file.
To change the IPM database preferences:
Step 2 To change the number of days that daily network performance statistics are stored, modify the following line:
ipm_daily_stats_life=180
Step 3 To set the business hours to be used in calculating averages, you must turn on or off the appropriate hourly interval. The day is divided into increments of one hour, starting at 0:00 a.m. (ipm_business_hour_0) and ending at 11:59 p.m. (ipm_business_hour_23=0). For the hours you want to include in averages, set the hour interval value to 1.
For example, to store collected statistics over a business day that runs from 8:00 a.m. to 5:00 p.m., you would use the following setting:
ipm_business_hour_0=0 ipm_business_hour_1=0 ipm_business_hour_2=0 ipm_business_hour_3=0 ipm_business_hour_4=0 ipm_business_hour_5=0 ipm_business_hour_6=0 ipm_business_hour_7=0 ipm_business_hour_8=1 ipm_business_hour_9=1 ipm_business_hour_10=1 ipm_business_hour_11=1 ipm_business_hour_12=1 ipm_business_hour_13=1 ipm_business_hour_14=1 ipm_business_hour_15=1 ipm_business_hour_16=1 ipm_business_hour_17=0 ipm_business_hour_18=0 ipm_business_hour_19=0 ipm_business_hour_20=0 ipm_business_hour_21=0 ipm_business_hour_22=0 ipm_business_hour_23=0
By default, the business day is defined as 24 hours, 0:00 a.m. to 11:59 p.m.
Step 4 To set the business days used for calculating weekly and monthly averages, you must turn on or off the appropriate day. Each day of the week is represented by a number as follows:
ipm_business_day_0ipm_business_day_1ipm_business_day_2ipm_business_day_3ipm_business_day_4ipm_business_day_5ipm_business_day_6For the days you want to set as business days, set the day to a value of 1. Days with a value of 0 are not counted as business days.
For example, to set the business days to Monday through Friday, you would use the following setting (the default setting):
ipm_business_day_0=0 ipm_business_day_1=1 ipm_business_day_2=1 ipm_business_day_3=1 ipm_business_day_4=1 ipm_business_day_5=1 ipm_business_day_6=0
By default, the business week is defined as 7 days, Sunday morning to Saturday evening.
Step 5 Save your changes to the IPM database preferences file.
Step 6 Run the database utility program to load your preferences.
In Solaris, use the following commands:
# cd /opt/CSCOipm/bin # ./ipm dbprefs reload
In Windows NT, use the following commands:
cd c:\Program Files\Internetwork Performance Monitor\Server\bin ipm dbprefs reload
![]() |
Note You might want to make a backup copy of the database preferences file (ipmDbPref.conf) before modifying it. |
The contents of the default IPM database preferences file (ipmDbPref.conf) are shown in the following example. This file is stored in the /opt/CSCOipm/etc directory in Solaris and in the c:\Program Files\Internetwork Performance Monitor\server\etc directory in Windows NT.
# # (C) Copyright 1998 Cisco Systems, Inc. # All Rights Reserved # # IPM Database Preferences # # This file contains the IPM Database Preferences used for # data aging and reduction. # # To change these values, update the values below and run the command: # ipmDbPref.sh -s # # To display the values currently set in the database, run the command: # ipmDbPref.sh # # NOTE: Changing these parameters has no effect on daily, weekly and # monthly data that has already been calculated. Only new daily, weekly # and monthly data will use these new settings. # # The hourly data within IPM is always kept for 32 days. # The weekly and monthly data is always kept forever. # # The ipm_response_life setting determines the number of days that IPM stores # daily latency data. You can change this to any number of days. ipm_response_life=180 # # # The ipm_error_life setting determines the number of days that IPM stores # daily error data. You can change this to any number of days. ipm_error_life=180 # # # The ipm_business_hour_x settings describe which hours of the day IPM will use # when generating daily, weekly and monthly reports. Each hour of the day, # starting with 0 (midnight) and going through 23 (11 PM) might be included in # the reports. However, you will probably want to restrict the hours included # in the reports to normal business hours. # # The hours are defined as starting at 0 minutes past the hour, and going through # 59 minutes and 59 seconds past the hour. # # Set the value of each ipm_business_hour_x parameter to either 0 or 1. # A value of 1 indicates that IPM will use this hour of the day when generating # daily, weekly and monthly reports. A value of 0 indicates that IPM will ignore # this hour of the day when generating daily, weekly and monthly reports. # For example, setting 'ipm_business_hour_9=1' will cause all data collected between # 9:00AM and 9:59AM on business days to be included in reports. # ipm_business_hour_0=0 ipm_business_hour_1=0 ipm_business_hour_2=0 ipm_business_hour_3=0 ipm_business_hour_4=0 ipm_business_hour_5=0 ipm_business_hour_6=0 ipm_business_hour_7=0 ipm_business_hour_8=1 ipm_business_hour_9=1 ipm_business_hour_10=1 ipm_business_hour_11=1 ipm_business_hour_12=1 ipm_business_hour_13=1 ipm_business_hour_14=1 ipm_business_hour_15=1 ipm_business_hour_16=1 ipm_business_hour_17=1 ipm_business_hour_18=1 ipm_business_hour_19=1 ipm_business_hour_20=0 ipm_business_hour_21=0 ipm_business_hour_22=0 ipm_business_hour_23=0 # # # The ipm_business_day settings describe which days of the week IPM will use # when generating weekly and monthly reports. Each day of the week is represented # by a number: # # Sunday is 0 # Monday is 1 # Tuesday is 2 # Wednesday is 3 # Thursday is 4 # Friday is 5 # Saturday is 6 # # Set the value of each ipm_business_day_x parameter to either 0 or 1. # A value of 1 indicates that IPM will use this day of the week when generating # weekly and monthly reports. A value of 0 indicates that IPM will ignore this # day of the week when generating weekly and monthly reports. # For example, setting 'ipm_business_day_2=1' will cause all data collected on # Tuesday during business hours to be included in reports. # ipm_business_day_0=0 ipm_business_day_1=1 ipm_business_day_2=1 ipm_business_day_3=1 ipm_business_day_4=1 ipm_business_day_5=1 ipm_business_day_6=0
An IPM server and source router need not be physically near each other. In fact, they can be thousands of miles apart. However, as the distance increases, so does the time it takes the source router to respond to SNMP requests. If the response time exceeds a predefined timeout value, IPM interprets the delay as an SNMP timeout, which could impact the operation of your collectors.
For example, if you have an IPM server in New York and a source router in Tokyo, SNMP timeouts might prevent you from configuring collectors on the source router. Or you might be able to configure the collectors, but timeouts might result in periods when no statistical data can be collected from the source router.
If you experience this problem, the best solution is to define an additional IPM server that is physically nearer the source router. However, if that is not an option, you can set new values for the SNMP timeout and retry environment variables.
![]() |
Note SNMP environment variables are engineered for all but the most extreme operating conditions. Modifying these variables can adversely affect IPM's performance, resulting in unacceptably long delays in responding to user requests. Unless you are certain that you must, you should not modify these variables. |
The following environment variables control SNMP timeouts and retries:
| Variable | Description |
|---|---|
IPM_SNMP_TIMEOUT | Time in seconds for the IPM server to wait for a response. The valid range is 1 to 60 seconds. The default is 5 seconds. |
IPM_SNMP_RETRIES | Number of times the IPM server tries again to send a request that has timed out while waiting for a response. The valid range is 1 to 5 retries. The default is 3 retries. |
IPM_SNMP_TIMEOUT_INCREMENT | Time in seconds to add to the current time-out value for subsequent retries. The valid range is 1 to 60 seconds. The default is 5 seconds. |
Using the default values, IPM waits 50 seconds before determining that an SNMP request cannot be completed---5 seconds for the initial timeout, followed by 3 retries of 10, 15, and 20 seconds each.
If excessive SNMP timeouts are a problem in your network, try slightly increasing the timeout and timeout increment values until the problem is eliminated.
To set new values for these variables, use one of the following procedures:
To set SNMP environment variables in Solaris, use the following procedure:
# cd /opt/CSCOipm/bin # ./ipm stop
Step 2 On your IPM server, use a text editor to open the ipm.env file. In Solaris, the default directory for the ipm.env file is /opt/CSCOipm/etc.
![]() |
Note The default directory for installing IPM is /opt. If you installed IPM in a different directory, specify that directory instead of /opt. |
By default, the variable definitions are commented out in the file:
# Max value is 60, default is 5, min is 1 #IPM_SNMP_TIMEOUT=5 #export IPM_SNMP_TIMEOUT # Max value is 5, default is 3, min is 1 #IPM_SNMP_RETRIES=3 #export IPM_SNMP_RETRIES # Max value is 60, default is 5, min is 1 #IPM_SNMP_TIMEOUT_INCREMENT=5 #export IPM_SNMP_TIMEOUT_INCREMENT
Step 3 To change a variable definition, remove the comment markers (#) from the definition and change the settings. For example, to change the timeout value to 10 seconds, change the following lines in the file:
# Max value is 60, default is 5, min is 1 IPM_SNMP_TIMEOUT=10 export IPM_SNMP_TIMEOUT
Step 4 Save your changes and close the file.
Step 5 Log in as the root user.
Step 6 Restart the IPM servers by entering the following commands:
# cd /opt/CSCOipm/bin # ./ipm restart
When the IPM servers start up, they discover the variables and use the new timeout and retry values.
To set SNMP environment variables in Windows NT, use the following procedure:
cd c:\Program Files\Internetwork Performance Monitor\Server\bin ipm stop
Step 2 On your IPM server, use a text editor to open the ipm.env file. In Windows NT, the default directory for the ipm.env file is c:\Program Files\Internetwork Performance Monitor\server\etc.
![]() |
Note The default directory for installing IPM is c:\Program Files\Internetwork Performance Monitor. If you installed IPM in a different directory, specify that directory instead of c:\Program Files\Internetwork Performance Monitor. |
By default, the variable definitions are commented out in the file:
# Max value is 60, default is 5, min is 1 #set IPM_SNMP_TIMEOUT=5 # Max value is 5, default is 3, min is 1 #set IPM_SNMP_RETRIES=3 # Max value is 60, default is 5, min is 1 #set IPM_SNMP_TIMEOUT_INCREMENT=5
Step 3 To change a variable definition, remove the comment markers (#) from the definition and change the settings. For example, to change the timeout value to 10 seconds, change the following lines in the file:
# Max value is 60, default is 5, min is 1 set IPM_SNMP_TIMEOUT=10
Step 4 Save your changes and close the file.
Step 5 Log in as the administrator.
Step 6 Restart the IPM servers by entering the following commands:
cd c:\Program Files\Internetwork Performance Monitor\server\bin ipm restart
When the IPM servers start up, they discover the variables and use the new timeout and retry values.
The default timeout value for data collection servers and configuration servers is 120 seconds. This value accommodates the longer startup times encountered when you have a large number of collectors. However, if you have configured more than 1000 collectors on a single IPM server, you might need to increase this timeout value. These timeout values control internal IPM timing; they do not affect communication with source routers.
For each 500 collectors above 1000, add 30 seconds to the default timeout value of 120 seconds for both the data collection server and configuration server. For example, for 1500 collectors change the timeout value to 150 seconds for both servers. If you do not make this change, the Process Manager might timeout while waiting for the data collection server to start up, thus preventing initialization of the configuration server.
To increase the timeout value, allowing sufficient time for the data collection server process to start, use one of the following procedures:
To set server timeout values in Solaris, use the following procedure:
![]() |
Note The default directory for installing IPM is /opt. If you installed IPM in a different directory, specify that directory instead of /opt. |
The data collection server's timeout value is defined in the following line in the file:
DataCollectionServer R MessageLogServer,SNMPServer /opt/CSCOipm/bin/CWB_ipmData_colld -ORBagentPort,44342,-PMCserverName,IPMProcessMgr,-PMCname,DataCollectionServer,-MLCserverName,IPMMsgLogServer,-MLCname,DataCollectionServer,-N,IPMDataCollectionServer,-R,/opt/CSCOipm 120
The configuration server's timeout value is defined in the following line in the file:
ConfigServer R MessageLogServer,SNMPServer,DataCollectionServer /opt/CSCOipm/bin/CWB_ipmConfigServerd -ORBagentPort,44342,-PMCserverName,IPMProcessMgr,-PMCname,ConfigServer,-MLCserverName,IPMMsgLogServer,-MLCname,ConfigServer 120
Step 2 To change the timeout definition for one or both servers, change the number 120 at the end of the appropriate line. For example, to change the timeout value for configuration servers to 240 seconds:
ConfigServer R MessageLogServer,SNMPServer,DataCollectionServer /opt/CSCOipm/bin/CWB_ipmConfigServerd -ORBagentPort,44342,-PMCserverName,IPMProcessMgr,-PMCname,ConfigServer,-MLCserverName,IPMMsgLogServer,-MLCname,ConfigServer 240
Step 3 Save your changes and close the file.
Step 4 Log in as the root user.
Step 5 Restart the IPM servers by entering the following commands:
# cd /opt/CSCOipm/bin # ./ipm restart
When the IPM servers start up, they use the new timeout values.
To set server timeout values in Windows NT, use the following procedure:
![]() |
Note The default directory for installing IPM is c:\Program Files\Internetwork Performance Monitor. If you installed IPM in a different directory, specify that directory instead of c:\Program Files\Internetwork Performance Monitor. |
The data collection server's timeout value is defined in the following line in the file:
DataCollectionServer R MessageLogServer,SNMPServer C:\PROGRA~1\INTERN~1\Server\bin\CWB_ipmData_colld -ORBagentPort,44342,-OAconnectionMaxIdle,8640000,-PMCserverName,IPMProcessMgr,-PMCname,DataCollectionServer,-MLCserverName,IPMMsgLogServer,-MLCname,DataCollectionServer,-N,IPMDataCollectionServer,-R,C:\PROGRA~1\INTERN~1\Server,-MLCfilterFileName,C:\PROGRA~1\INTERN~1\Server\logs\DataCollectionServer.flt 120
The configuration server's timeout value is defined in the following line in the file:
ConfigServer R MessageLogServer,SNMPServer,DataCollectionServer C:\PROGRA~1\INTERN~1\Server\bin\CWB_ipmConfigServerd -ORBagentPort,44342,-OAconnectionMaxIdle,8640000,-PMCserverName,IPMProcessMgr,-PMCname,ConfigServer,-MLCserverName,IPMMsgLogServer,-MLCname,ConfigServer,-MLCfilterFileName,C:\PROGRA~1\INTERN~1\Server\logs\ConfigServer.flt 120
Step 2 To change the timeout definition for one or both servers, change the number 120 at the end of the appropriate line. For example, to change the timeout value for configuration servers to 240 seconds:
ConfigServer R MessageLogServer,SNMPServer,DataCollectionServer C:\PROGRA~1\INTERN~1\Server\bin\CWB_ipmConfigServerd -ORBagentPort,44342,-OAconnectionMaxIdle,8640000,-PMCserverName,IPMProcessMgr,-PMCname,ConfigServer,-MLCserverName,IPMMsgLogServer,-MLCname,ConfigServer,-MLCfilterFileName,C:\PROGRA~1\INTERN~1\Server\logs\ConfigServer.flt 240
Step 3 Save your changes and close the file.
Step 4 Log in as the administrator.
Step 5 Restart the IPM servers by entering the following commands:
cd c:\Program Files\Internetwork Performance Monitor\server\bin ipm restart
When the IPM servers start up, they use the new timeout value.
The DISPLAY variable is set as part of your login environment on Solaris. However, if you Telnet into a remote workstation, you must set the DISPLAY variable to local display. To do so, issue the following command:
setenv DISPLAY local_ws:0.0where local_ws is your local workstation.
If your shell does not support the setenv command, use the following command:
export DISPLAY=local_ws:0.0If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use the following commands:
The IPM database is backed up automatically every day at 1:00 a.m. If your database file is corrupted, you can restore the data in the IPM database from the previous day's backed-up data.
To restore the IPM database from a previous back up:
# cd /opt/CSCOipm/bin # ./ipm dbrestore
cd c:\Program Files\Internetwork Performance Monitor\server\bin ipm dbrestore
![]() |
Note This command can take several hours to complete. |
![]() |
Warning Do not interrupt this command. Doing so can corrupt your IPM database. |
![]()
![]()
![]()
![]()
![]()
![]()
![]()
Posted: Fri Jul 28 12:19:32 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.