Using the Command Line for Statistics Reports
Wugstat.exe is a WhatsUp Gold utility used to generate reports from WhatsUp Gold Statistics Log (ST-yyyy-mm-dd.tab) data.
You can invoke wugstat from the Command Prompt or MS-DOS prompt. You must invoke wugstat with the -mmapname argument. All other arguments are optional. By default, the report is displayed in the Command Prompt or MS-DOS window.
Basic Command Syntax
wugstat [-mmapname] [-ddevicename] [-syyyymmdd] [-eyyyymmdd] [-llogfile] [-osortmode] [-rreport] [-tmaptitle]
Note: You must use the -m argument to specify the name of the WhatsUp Gold map to use for the report. All other arguments are optional.
| Argument |
Explanation |
| -mmapname |
Required. The name of the map to use as the basis for the report. Can be a regular expression search string such as: local.* |
| -syyyymmdd |
Optional. Start date to use as the basis for the report. Use -s to specify the start date for the report. The default is the oldest date in the log. |
| -ddevicename |
Optional. The name of the device to use as the basis for the report. Can be a regular expression search string such as: router.* |
| -eyyyymmdd |
Optional. end date to use as the basis for the report. Use -e to specify the end date for the report. The default is the most recent date in the log. |
| -llogfile |
Optional. Argument used to specify an alternate log file. Use -l to specify an alternate log file. The default is wugstatdata.tab. |
| -osortmode |
Optional sort order. Valid values for sort mode are: ascend (sort by device name in ascending order), and descend (sort by device name in descending order). Use -o to specify one of the sort modes: Ascend sorts by device name in ascending order (this is the default value); Descend sorts by device name in descending order |
| -rreport |
Optional. Name of report to generate (default detail report). Valid values for report are: detail (generates a detailed summary report by device), dow (generates a Day of the Week detailed report by device), and export (generates a tab delimited output file of raw data). Use -r to specify one of the report types: |
| -tmaptitle |
Optional, the title to use at the top of the report. Use -t to specify the title to use at the top of the report. The default title is the map name. |
| -? |
Use -? to see a summary of argument options. |
Examples
The following examples create statistics reports for the Boston1 map:
wugstat -mBoston1.wup
generates a detailed report for all days in the log (uses defaults).
wugstat -mBoston1.wup -s20010301 -e20010331
generates a detailed report for one month of log data.
Return Codes
Wugstat returns 1 if it performed at least one of the requested operations; it returns 0 if it failed.
