Running TM1 PerfMon

Run the tm1perfmon.exe file from a command line on either a Microsoft Windows or UNIX system.

Use the following format and parameters:

tm1perfmon -servername Name -loop LoopCount -sleep SleepTime

Where:

  • Name is the name of the TM1® Server to monitor. Use quotes when the server name includes spaces. For example:
    -servername "planning sample"
  • LoopCount is the number of times to repeat, or refresh, the display of counter values. Default value is 1, no loop. This value is optional.

    A value of 0 causes TM1 PerfMon to loop indefinitely.

    To cancel TM1 PerfMon while looping, press the CTRL+Break keys to return to the command prompt.

  • SleepTime is the time, in seconds, between loops. Default value is 5 seconds. This value is optional.

For example, the following command line would run TM1 PerfMon continuously to monitor a TM1 Server named planning sample. The display would continue to refresh every 5 seconds, using the default value for the sleep option, until you exit by pressing the CTRL+Break keys.

tm1perfmon -servername "planning sample" -loop 0

The following command line would run TM1 PerfMon to monitor the salesdata TM1 Server, looping a total of 10 times with a 5 second refresh rate between display updates.

tm1perfmon -servername salesdata -loop 10 -sleep 5

If you do not include values for the loop and sleep options, as shown in the following example, TM1 PerfMon will run and display the TM1 performance counters once only.

tm1perfmon -servername salesdata
Note: You can turn updates to performance counters on or off for a TM1 Server by setting PerfMonIsActive in the tm1s.cfg file. See PerfMonIsActive.

You can exit the TM1 PerfMon while the utility is still looping. Press CTRL+Break at any time.