cc/td/doc/product/rtrmgmt/ipmcw2k/ipm22
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

IPM Command Reference

IPM Command Reference

This appendix provides a list of the IPM commands. Table B-1 shows the format of the commands and a description of the actions they perform.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.


Table B-1: IPM Commands
Command Description

ipm

Starts all IPM servers and one IPM client on the local host.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.

ipm addsrc

Adds a source router to the IPM database using command line prompts.

ipm addtarg

Adds a target device to the IPM database using command line prompts.

ipm baseline percentage

Modifies the baseline, increasing the latency threshold for all Running statistical collectors on the local host by percentage. The valid range for percentage is 1 to 999. See "Setting the Baseline" section for more details.

ipm browserpath

(Solaris only) Sets a user-defined IPM Web browser path, and verifies that the browser specified by the user exists.

(Windows NT only) Resets the IPM Web browser path to the Netscape Navigator path. If Netscape Navigator is not found, resets to the Internet Explorer path. If neither is found, clears the IPM Web browser path.

ipm clientaddr

If the workstation on which an IPM client is running has multiple IP addresses, forces the IPM client to bind to a specific IP address.

ipm console

Displays the contents of the ipmConsoleLog.log file.

ipm control [servername] [options]

Starts and stops a collector, where servername is the name of the IPM server and options include the following:

  • -rt collName srcName---Starts a real time chart for the collector named collName on the source router named srcName.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.

  • -start collName srcName duration---Starts the On Demand collector named collName on the source router named srcName, for a number of hours specified by duration.

  • -start collName srcName duration -rt---Starts the On Demand collector named collName on the source router named srcName, for a number of hours specified by duration, and starts a real time chart for the collector.

  • -stop collName srcName---Cancels the running collector named collName on the source router named srcName.

ipm cw2ksetup

Checks to see which files are installed, and installs additional files as necessary. Use this command to integrate IPM and CiscoWorks2000 in the following instances:

  • You installed CiscoWorks2000 after you installed IPM.

  • IPM and CiscoWorks2000 are no longer integrated for some reason.

ipm cw2ksetup install

Identical to ipm cw2ksetup. Checks to see which files are installed, and installs additional files as necessary. Use this command to integrate IPM and CiscoWorks2000 in the following instances:

  • You installed CiscoWorks2000 after you installed IPM.

  • IPM and CiscoWorks2000 are no longer integrated for some reason.

ipm cw2ksetup uninstall

Removes IPM files in the CMF path. In Windows NT, also modifies the http.conf file so that it does not use the pool from CiscoWorks2000.

Always run ipm cw2ksetup uninstall before uninstalling CiscoWorks2000 from your system.

ipm dbbackup

Backs up the IPM database.

ipm dbprefs reload

Reloads the IPM database preferences file.

ipm dbprefs view

View the preferences in the currently running IPM database.

ipm dbprefs viewfile

View the IPM database preferences in the configuration file, which might differ from the preferences in the currently running IPM database.

The output from this command is formatted differently from the output from the ipm dbprefs view command, because this command displays the contents of a file, whereas the ipm dbprefs view command displays the contents of a database.

ipm dbrestore

Restores the IPM database from a previous backup.

ipm debug [hostname]

Starts the message log display and displays the Message Log window which provides a log of status messages generated by IPM. Connects to IPM servers on the local host or on hostname.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.

ipm delsrc

Removes a source router from the IPM database using command line prompts.

ipm deltarg

Removes a target device from the IPM database using command line prompts.

If you try to delete a target and IPM issues an error message such as Could not delete the target, the cause might be one of the following:

  • The target is being used as a final target by one or more collectors.

  • The target is being used as an intermediate hop by one or more Path Echo collectors.

See the "Deleting Targets" section for details about how to resolve this problem.

ipm editcoll filename

Allows you to edit the contents of the specified collector seed file.

ipm editsrc filename

Allows you to edit the contents of the specified source seed file.

ipm edittarg filename

Allows you to edit the contents of the specified target seed file.

ipm export

Starts the ipm export utility. For more information about this command, use the ipm export help command. For sample output, see the "Output of ipm export help Command" section.

ipm forcestop

(Solaris only) Forcefully stops all IPM servers running on the local host.

ipm help

Displays the command syntax for the ipm command and all of its options. For a sample output for this command, see the "Output of ipm help Command" section.

ipm hostname

(Solaris only) Reconfigures IPM after you change a device's host name, so that you do not need to reinstall IPM. If you do not issue this command after changing a device's host name, the IPM servers no longer start up or work correctly, and the client cannot connect to the servers.

You can also use this command to force IPM to use a specific IP address or host name, on a system that has multiple IP addresses or host names.

ipm iosinfo

Displays the contents of the IPM-IOS-Info file.

ipm ipm.conf

Displays the contents of the ipm.conf file.

ipm listcoll

Displays a directory listing of the collector seed files on the local host.

ipm listsrc

Displays a directory listing of the source seed files on the local host.

ipm listtarg

Displays a directory listing of the target seed files on the local host.

ipm loadcoll filename

Loads the specified collector seed file into the IPM database.

ipm loadsrc filename

Loads the specified source seed file into the IPM database.

ipm loadtarg filename

Loads the specified target seed file into the IPM database.

ipm logger

Displays the ipmLoggerLog.x file with tail -f.

ipm mirror
[source | target | collector]

Exports IPM device data in seed file format.

ipm mirror all

(Solaris only) Exports IPM device data for sources, targets, and collectors in seed file format and creates a tar file of all components in a file named /tmp/ipm.mirror.host_name.tar.

(Windows NT only) Exports IPM device data for sources, targets, and collectors in seed file format and creates three files named Source.txt, Target.txt and Collector.txt, stored in a temporary directory. To find the temporary directory, IPM first looks at the TMP environment variable. If TMP is not defined, IPM looks at the TEMP variable. If TEMP is also not defined, IPM places the three files in the current directory.

ipm password

Enables and disables IPM passwords. See the "Implementing Client Security" section for more information.

ipm pmstatus [hostname]

Displays the Process Management Information window and connects to the IPM servers on the local host or on hostname. The Process Management Information window displays status information about the IPM processes and provides options for starting or stopping a process, or for viewing more detailed information about a process.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.

ipm readme

Displays the contents of the README file for IPM.

ipm regen

Regenerates all Web reports.

ipm restart

Restarts all IPM servers on the local host.

ipm restart db

Restarts the IPM database on the local host.

ipm restart name

Restarts the IPM Naming Server on the local host.

ipm restart pm

Restarts all IPM server processes on the local host except the IPM database, Naming Server, and Web Server.

ipm restart web

Restarts the IPM Web Server on the local host.

ipm seed
[[hostname] filename type]

Connects to IPM servers on the local host and starts a seed file configuration process.

  • If you are not connecting locally, hostname is the name of the remote host, such as IPM-Host-1.

  • filename is the seed file name, such as srcfile.src. You can specify just the file name, or you can specify an absolute address (the full path and file name). If you specify only the file name, IPM looks for the file in the default seed file directory.

filename cannot be a relative address (a partial path name and file name).

  • type is the type of seed file: 1 for source, 2 for target, 3 for collector.

The following are valid ipm seed commands:

File Name Only---Solaris

# ./ipm seed IPM-Host-1 srcfile.src 1

Absolute Address---Solaris

# ./ipm seed IPM-Host-1 /opt/CSCOipm/etc/source/srcfile.src 1

File Name Only---Windows NT

ipm seed IPM-Host-1 srcfile.src 1

Absolute Address---Windows NT

ipm seed IPM-Host-1 c:\Program Files\Internetwork Performance Monitor\Server\etc\source\srcfile.src 1

For more information about seed files, see the "Adding Components Using Seed Files" section.

ipm servername

Resets the default server to which to connect.

ipm services.conf

Displays the contents of the services.conf file.

ipm start [server]

Starts all IPM servers on the local host.

ipm start aging

(Windows NT only) Starts the IPM Aging Server on the local host.

ipm start client [hostname]

Starts an IPM client on the specified host. If no host name is specified, then an IPM client is started on the local host.

If you Telnet into a remote workstation and you do not set the DISPLAY variable to local display, you cannot use this command. See the "Setting the DISPLAY Variable in Solaris" section for details.

ipm start db

Starts the IPM Database Server on the local host.

ipm start name

Starts the IPM Naming Server on the local host.

ipm start pm

Starts the IPM Process Manager on the local host.

ipm start web

Starts the IPM Web Server on the local host.

ipm status

Displays the status of all IPM servers on the local host. For a sample output for this command, see the "Output of ipm status Command" section.

ipm stop [server]

Stops all IPM servers on the local host.

ipm stop aging

(Windows NT only) Stops the IPM Aging Server on the local host.

ipm stop clients

Stops all IPM clients running on the local host.

ipm stop db

Stops the IPM Database Server on the local host.

ipm stop name

Stops the IPM Naming Server on the local host.

ipm stop pm

Stops the IPM Process Manager on the local host.

ipm stop web

Stops the IPM Web Server on the local host.

ipm tshoot

Displays information useful for troubleshooting problems with assistance from the Cisco Technical Assistance Center.

ipm version

Displays version information for all IPM servers on the local host.

ipm viewcoll filename

Displays the contents of the specified collector seed file.

ipm viewlog

Displays the ipmLoggerLog.x file with PAGER.

ipm viewsrc filename

Displays the contents of the specified source seed file.

ipm viewtarg filename

Displays the contents of the specified target seed file.

Output of ipm status Command

The following example shows the status information displayed when you use the ipm status command:

IPM Database Server Already Running.
 
IPM Web Server Already Running.
 
IPM Process Manager Already Running.
 
IPM Naming Server Already Running.
 
Process Manager running with processes:
ConfigServer     Ready
SNMPServer       Ready
MessageLogServer Ready
DataRetriever    Ready
DisplayServer    Ready
 

Output of ipm help Command

The following example shows the command syntax and help that is displayed when you use the ipm help command:

# ipm help
ipm                - Starts all IPM Servers and one Client on the local host.
 
ipm start    - Starts   all IPM Servers on the local host. 
ipm stop     - Stops    all IPM Servers on the local host.
ipm restart  - Restarts all IPM Servers on the local host.
 
ipm status   - Displays status  of all IPM Servers on the local host.
ipm version  - Displays version of all IPM Servers on the local host.
 
ipm start client [<hostname>] - Starts an IPM Client. 
                 Connects to IPM servers on default host or <hostname>
 
ipm start db   - Starts IPM Database Server on the local host. 
ipm stop  db   - Stops  IPM Database Server on the local host.
 
ipm start web  - Starts IPM Web      Server on the local host. 
ipm stop  web  - Stops  IPM Web      Server on the local host.
 
ipm start name - Starts IPM Naming   Server on the local host. 
ipm stop  name - Stops  IPM Naming   Server on the local host.
 
ipm start pm   - Starts IPM Process Manager on the local host. 
ipm stop  pm   - Stops  IPM Process Manager on the local host.
 
ipm debug    [<hostname>] - Starts a Message Log     Display Client.
                 Connects to IPM servers on local host or <hostname>
 
ipm pmstatus [<hostname>] - Starts a Process Manager Display Client.
                 Connects to IPM servers on local host or <hostname>
 
ipm dbbackup    - Backs up IPM Database.
ipm dbrestore   - Restores IPM Database from previous backup.
ipm dbbackup {enable|disable}- Controls automatic IPM Database backup.
ipm dbclean     - Replace the IPM Database with a clean version.
 
ipm forcestop   - Forcefully stops all IPM Servers on the local host.
ipm stopclients - Stops all running IPM clients on the local host.
 
ipm readme        - Display the README            file.
ipm iosinfo       - Display the IPM-IOS-Info      file.
ipm ipm.conf      - Display the ipm.conf          file.
ipm services.conf - Display the services.conf     file.
 
ipm console       - Display the ipmConsoleLog.log file.
ipm viewlog       - Display the ipmLoggerLog.x    file with PAGER
ipm logger        - Display the ipmLoggerLog.x    file with tail -f.
 
ipm browserpath   - Reset the path to the system Web Browser.
ipm servername    - Reset the default server to connect to.
 
ipm export        - Call the ipm export utility. 
                    ipm export help for more info.
 
ipm mirror [source|target|collector] - Export in IPM seed file format.
 
ipm mirror all - Export in IPM seed file format and create a tar file.
                 of all components in /tmp/ipm.mirror.jkinder-ultra.tar
 
ipm listsrc    - Display a directory listing of the source    seed files.
ipm listtarg   - Display a directory listing of the target    seed files.
ipm listcoll   - Display a directory listing of the collector seed files.
 
ipm viewsrc  <filename> - View the source    file specified by <filename>
ipm viewtarg <filename> - View the target    file specified by <filename>
ipm viewcoll <filename> - View the collector file specified by <filename>
 
ipm editsrc  <filename> - Edit the source    file specified by <filename>
ipm edittarg <filename> - Edit the target    file specified by <filename>
ipm editcoll <filename> - Edit the collector file specified by <filename>
 
ipm loadsrc  <filename> - Load the source    file specified by <filename>
ipm loadtarg <filename> - Load the target    file specified by <filename>
ipm loadcoll <filename> - Load the collector file specified by <filename>
 
ipm addsrc  - Add    a source via command line prompts.
ipm addtarg - Add    a target via command line prompts.
ipm delsrc  - Delete a source via command line prompts.
ipm deltarg - Delete a target via command line prompts.
 
ipm seed    [<hostname> [<filename> <type>] ] 
            Starts a Seed File Configuration Process.
            Connects to IPM servers on local host or <hostname>
            <filename> is the seed file name.
            <type> is 1 for source; 2 for target; 3 for collector.

ipm tshoot     - Display information for Cisco TAC.
ipm regen      - Regenerate all Web reports.
ipm clientaddr - Force Client to bind to specific IP address.
ipm password   - Establish passwords on client launching and Web clients.
ipm hostname   - Change the hostname used by the IPM Server and Client.
 

Output of ipm export help Command

The following example shows the command syntax and help that is displayed when you use the ipm export help command:


Note You must be logged in as the root user (Solaris) or administrator (Windows NT) to use export IPM data using the ipm export command.

ipm export help
 
Usage:
 
/opt/CSCOipm/bin/ipmExport.pl [ipmRoot]
           [-q] [[-k <letter>] | -w] [-h]
           [ ( -c | -s | -t | -o ) [<Name>] ]
         | [ (-dh | -dd | -dw | -dm)  <StartTime> <EndTime> [ <CollectorName> ]]
 
General options:
 
  [ipmRoot] - Root location of IPM, such as /opt/CSCOipm
 
  -q  Quiet output- display no column headings. Only applicable in plain
      text output format
 
  -k  Delimiter- set the field delimiter to <letter>.  By default, this
      is set to a comma ','. Only applicable in plain text output format.
 
  -w  HTML output - A web page will be generated from the output of
      this command.
 
  -h  Help - output this usage help
 
Format:
 
  Time  - <StartTime> and <EndTime> need to be input as:
              MM/DD/YYYY-hh:mm:ss Day
          <WhichDay> needs to be input as
              MM/DD/YYYY
 
Output options:
 
  -c   Display collector configuration.  If <name> is omitted, display
       a list of all collectors.  If <name> is specified, display
       information about the specified collector.
 
  -s   Display source router configuration.  If <name> is omitted,
       display a list of all source routers.  If <name> is specified,
       display information about the specified source router.
 
  -t   Display target configuration.  If <name> is omitted, display a
       list of all targets.  If <name> is specified, display information
       about the specified target.
 
  -o   Display operation configuration.  If <name> is omitted, display
       a list of all operations.  If <name> is specified, display
       information about the specified operation.
 
  -dh  Display hourly non-jitter statistical data.  If <name> is omitted,
       display data for all non-jitter collectors.  If <name> is
       specified, display information about the specified collector.
 
  -dd  Display daily non-jitter statistical data.  If <name> is omitted,
       display data for all non-jitter collectors.  If <name> is
       specified, display information about the specified collector.
 
  -dw  Display weekly non-jitter statistical data.  If <name> is omitted,
       display data for all non-jitter collectors.  If <name> is
       specified, display information about the specified collector.
 
  -dm  Display monthly non-jitter statistical data.  If <name> is
       omitted, display data for all collectors.  If <name> is specified,
       display information about the specified collector.
 
  -jh  Display hourly jitter statistical data.  If <name> is omitted,
       display data for all jitter collectors.  If <name> is specified,
       display information about the specified collector.
 
  -jd  Display daily jitter statistical data.  If <name> is omitted,
       display data for all jitter collectors.  If <name> is specified,
       display information about the specified collector.
 
  -jw  Display weekly jitter statistical data.  If <name> is omitted,
       display data for all jitter collectors.  If <name> is specified,
       display information about the specified collector.
 
  -jm  Display monthly jitter statistical data.  If <name> is omitted,
       display data for all jitter collectors.  If <name> is specified,
       display information about the specified collector.
 
  -r   Generate summary web reports, which can be retrieved and browsed
       from ipm home page. If <WhichDay> is specified, generate all
       applicable web reports for that day; otherwise, will generate
       all applicable web reports for yesterday.
 


hometocprevnextglossaryfeedbacksearchhelp
Posted: Fri Jul 28 12:14:17 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.