Usage of IOMeterCLI

IOMeter Command Line Interface

Version 1.00
Author: Jarvis Wang jarvis@iomark.co.cc
Update: 2011-10-26

USAGE:
IOMeterCLI [iometer_ip]

ALL COMMANDS:
config: generate IOMeter config file
config -f [file_str] -t [time_str] -c [cases]
-m [manager_str] -m [manager_str] -m ...
[file_str] -- file to save the config to
[time_str] -- [run_time],[rampup_time],[update_interval]
[run_time] -- hh:mm:ss
[rampup_time] -- ss
[update_interval] -- ss
[cases] -- [case_str]|[case_str]|...
[case_str] -- [case_name]$[access_str]$[access_str]$...
[access_str] -- [block_size(B)],[%access],[%read],
[%random],[delay],[burst],[align],[reply]
[manager_str] -- [manager_name],[manager_ip]$[worker_str]$[worker_str]$...
[worker_str] -- [worker_name],[outstanding],[max_sector],[start_sector],
[case_name]|[case_name]|...,[target]|[target]|...
load: load IOMeter configuration file
load [icf_file_path]
sample: sample results
sample [sample_type] [file_to_save] [interval(s)] [times]
[sample_type] -- all / noManagers / noWorkers / noTargets
start: start all tests
start [result_file_path]
stop: stop current test
stopall: stop all tests
state: view the iometer running state (idle/preparing/opening/rampingUp/recording/rampingDown)
quit/exit: quit IOMeter cli and gui
help/?: print this help

1. Start IOMeterCLI

   If IOMeterCLI.exe and IOMeter.exe are running on the same host, click IOMeterCLI.exe directory

   If IOMeterCLI.exe is running on a different host with IOMeter.exe, start IOMeterCLI.exe with a
   parameter of the Host IP Adress on witch IOMeter.exe is running, for example:

   IOMeterCLI.exe 129.22.240.31

2. Create a test configration

   Use "config" command to create a IOMeter configuration file. There're four parameters for "config"
   command:

   -f xxx.icf

   Set configuration file to create, it is recommended to set the suffix to .icf
   

   -t HH:MM:SS,SS,SS

   Set run time, rampup time and update interval, which are separated by ','
   
   HH - hour
   MM - minute
   SS - second
   

   -c CN$BS,AC,RD,RND,DLY,BST,ALN,RPL$ANOTHER_SPECIFICATION$...|ANOTHER_CASE|...

   Set test cases
   
   Test cases are separated by '|'
   The name and specifications of the case are separated by '$'
   The attributes of the specification are separated by ','
   
   CN  - test case name, can be any string with out '|', '$' or ','
   BS  - block size
   AC  - access percent
   RD  - read percent
   RND - random percent
   DLY - delay, time between issuing I/O
   BST - burst, number of I/O each time issuing
   ALN - align, I/O alignment
   RPL - reply size
   

   -m MN,MA$WN,OS,MS,SS,CN|CN|...,TG|TG|...$ANOTHER_WORKER$...

   Set manager, you can set up more managers by giving more '-m' parameters
   
   The manager's attributes and the workers' attributes are separated by '$'
   The attributes if the worker are separated by ','
   The test cases' name (CN) are separated by '|'
   The targets (TG) ares separated by '|'
   
   MN - manager name
   MA - manager ip address
   WN - worker name
   OS - outstanding
   MS - max sector
   SS - start sector
   CN - case name
   TG - target
   

   For example:

   two managers, each with two workers, run two case: Sequential 1MB 100% Write and Random 4KB 100% Read (aligned 4KB):
   
   config -f iometer.icf 
          -t 00:10:00,300,1 
          -c SW1M$1048576,100,0,0,0,1,0,0|RR4K$4096,100,100,100,0,1,4096,0
          -m MN1,192.168.0.1$WK1,32,0,0,SW1M|RR4K,sdb|sdc$WK1,32,0,0,SW1M|RR4K,sdd|sde
          -m MN2,192.168.0.2$WK1,32,0,0,SW1M|RR4K,sdb|sdc$WK1,32,0,0,SW1M|RR4K,sdd|sde
   

3. load a test configuration file

   Use "load" command to load a test configuration file, for example:

   load xxx.icf

4. sample updating performance data

   Use "sample" command to sample the runtime performance data.

   There're four parameters for sample command:
   sample level, file to save, sample interval, sample count

   There're four sample levels: all, noManagers, noWorkers, noTargets

   The sample interval must be equal to the performance counter update interval, if your configuration is configured in GUI,
   please set the update interval correctly.

   For exmaple:

   sample all perf.csv 1 1000

5. start test

   Issue "start" directly if you want save the result file to the default path.
   Issue "start filepath" if you want set the path of the result file.

6. stop a case

   Issue "stop" to stop the current case

7. stop all cases

   Issue "stop all" to stop all the cases

8. check the IOMeter running state

   Issue "state" to check the running status of IOMeter

9. quit from IOMeterCLI and IOMeter GUI

   Issue "quit" will quit from CLI and also GUI