Command Line Utility

In addition to the main GUI application, SysGauge Ultimate provides a command line utility allowing one to perform system monitoring operations, save various types of system monitoring reports, automatically analyze the system status and save system status analysis reports. The SysGauge command line utility is located in the product 'bin' directory.

Command Line Syntax:

sysgauge -monitor [ -profile <Profile Name> ]

This command starts a system monitoring operation using the specified system monitoring profile. If the profile name is not specified, SysGauge will use the default system monitoring profile.

sysgauge -monitor <XML Profile File>

This command starts a system monitoring operation using a previously exported XML profile file. In order to export a system monitoring profile to the XML format, select the 'System Monitor' module, press the 'Profiles' button, select the required system monitoring profile, press the right mouse button and select the 'Export Profile' menu item. In order to monitor using a customized system monitoring profile, create a new system monitoring profile in the 'Profiles' dialog, double click on the profile to activate the profile, customize the profile according to user-specific needs, export the customized profile to the XML format and then use the command line utility to perform custom monitoring operations.

sysgauge -system_monitor [ -extended ]

This command performs a simple system monitoring operation using basic system monitoring counters including the CPU usage, the memory usage, the amount of free memory, the amount of used memory, the total number of processes, the total number of threads, the disk transfer rate and the network transfer rate. When the 'extended' command line option is specified, SysGauge will add to the monitoring operation extended system monitoring counters including the system-level CPU usage, the total number of handles, the size of the memory cache and the disk transfer IOPS.

sysgauge -cpu_monitor [ -extended ]

This command performs a CPU usage monitoring operation using a number of CPU monitoring counters including the total CPU usage, the user-level CPU usage, the system-level CPU usage, the CPU interrupt time, the CPU interrupt rate, the C1, C2 and C3 low-power CPU states and the CPU frequency. By default, the CPU usage monitor reports the total CPU usage statistics for all CPUs in the monitored system. When the 'extended' command line option is specified, SysGauge enables individual CPU usage monitoring counter for each CPU and the CPU usage monitoring results will include individual CPU usage statistics for each CPU or CPU core in the monitored system.

sysgauge -memory_monitor

This command performs a memory usage monitoring operation using a number of memory monitoring counters including the memory usage, the amount of free memory, the amount of used memory, the size of the memory cache, the peak size of the memory cache, the memory cache fault rate, the memory page file usage, the memory page file peak size and the memory page file fault rate.

sysgauge -process_monitor

This command performs a process monitoring operation using a number of counters for each running process including the process CPU usage, the process memory usage, the process thread count, the process handle count, the process data transfer rate, the process read transfer rate, the process write transfer rate, the process memory page fault rate and the process non-paged memory size.

sysgauge -disk_monitor [ -extended ]

This command performs a disk activity monitoring operation using a number of disk monitoring counters including the disk activity, disk transfer rate, disk read transfer rate, disk write transfer rate, disk transfer IOPS, disk read transfer IOPS, disk write transfer IOPS, disk free space and disk space usage. By default, the disk activity monitor reports the total disk activity statistics for all logical disks in the monitored system. When the 'extended' command line option is specified, SysGauge enables individual disk activity monitoring counters for each logical disk and the disk activity monitoring results will include individual disk activity statistics for each logical disk in the monitored system.

sysgauge -nas_monitor [ -extended ]

This command performs a NAS performance monitoring operation using a number of NAS monitoring counters including the NAS data transfer rate, NAS read transfer rate, NAS write transfer rate, NAS data request rate, NAS read request rate, NAS write request rate, NAS pending requests, the current NAS open file count and the total number of open files since the NAS server was started. By default, the NAS performance monitor reports the total NAS performance statistics for all network shares in the monitored NAS server. When the 'extended' command line option is specified, SysGauge enables individual network shares performance monitoring counters for each network share and the NAS performance monitoring results will include individual network shares statistics for each network share in the monitored NAS server.

sysgauge -network_monitor [ -extended ]

This command performs a network monitoring operation using a number of network monitoring counters including the network transfer rate, network transmit rate, network receive rate, network packets rate, network send packets rate, network receive packets rate, network send packets errors, network receive packets errors and the network output queue length. By default, the network monitor reports the total network activity statistics for all network interface cards in the monitored server. When the 'extended' command line option is specified, SysGauge enables individual network cards activity monitoring counters for each network card and the network activity monitoring results will include individual network cards statistics for each network interface card in the monitored server.

sysgauge -analyze

This command performs an automated system analysis operation.

Optional Parameters:

-time <Seconds>

This command line option specifies the maximum monitoring time in seconds.

-silent

This command line option disables the command output, which is useful for silent generation of reports.

-save_html_report [ <Dir Name> or <File Name> ]

This command line option saves an HTML system monitoring report.

-save_excel_report [ <Dir Name> or <File Name> ]

This command line option saves an Excel system monitoring report.

-save_text_report [ <Dir Name> or <File Name> ]

This command line option saves a text system monitoring report.

-save_pdf_report [ <Dir Name> or <File Name> ]

This command line option saves a PDF system monitoring report.

-save_csv_report [ <Dir Name> or <File Name> ]

This command line option saves a CSV system monitoring report.

-save_xml_report [ <Dir Name> or <File Name> ]

This command line option saves an XML system monitoring report.

-save_to_database <Table Name>

This command line option saves monitoring results to the specified SQL database table.

Profile Management Commands:

sysgauge -show_profiles

This command shows the configured system monitoring profiles.

sysgauge -show_profile <Profile Name>

This command shows the specified system monitoring profile.

sysgauge -add_profile <Profile Name> [ -mode <Profile Mode> ]

This command adds a new system monitoring profile.

The profile mode may be set to one of the following values:

  • DEFAULT - adds a default system monitoring profile.
  • CPU - adds a CPU usage monitoring profile.
  • MEMORY - adds a memory usage monitoring profile.
  • DISK - adds a disk activity monitoring profile.
  • NETWORK - adds a network activity monitoring profile.
  • EMPTY - adds an empty system monitoring profile.

sysgauge -copy_profile <Profile Name> -to <Copy Profile Name>

This command copies the specified system monitoring profile.

sysgauge -rename_profile <Profile Name> -to <New Profile Name>

This command renames the specified system monitoring profile.

sysgauge -delete_profile <Profile Name>

This command deletes the specified system monitoring profile.

Counter Management Commands:

sysgauge -show_supported_counters

This command shows all supported system monitoring counters.

sysgauge -show_counter_instances [ -computer <Computer Name> ]

This command shows a list of instances for the specified system monitoring counter.

sysgauge -add_counter <Counter Name> -profile <Profile Name>
[ -instance <Counter Instance> -computer <Computer Name> ]

This command adds a system monitoring counter to the specified profile.

sysgauge -delete_counter <Counter Name> -profile <Profile Name> [ -id <Counter ID> ]

This command deletes a system monitoring counter from the specified profile.