b:11171, 10961

[fs/lustre-release.git] / lustre-iokit / obdfilter-survey / README.obdfilter-survey

diff --git a/lustre-iokit/obdfilter-survey/README.obdfilter-survey b/lustre-iokit/obdfilter-survey/README.obdfilter-survey
index 1fc0b40..e483a6a 100644 (file)
--- a/lustre-iokit/obdfilter-survey/README.obdfilter-survey
+++ b/lustre-iokit/obdfilter-survey/README.obdfilter-survey
@@ -31,7 +31,7 @@ components.
    of echo_client running on 1 or more nodes.
 
    You just need to pass parameters case=network and 
-   server_nid="<name/nid_of_server>" to the script. The script will do the 
+   targets="<hostname/ip_of_server>" to the script. The script will do the 
    required setup for network case. 
    
 3. The Stripe F/S over the Network.
@@ -53,8 +53,10 @@ Running
 -------
 
 The script must be customised according to the components under test and
-where it should keep its working files.  Customization variables are
-described clearly at Customization variables Section  in the script.
+where it should keep its working files. Customization variables are
+described clearly at Customization variables Section in the script.
+Please see maximum suported value ranges for customization variables
+in the srcipt.
 
 To run against a local disk:
 ---------------------------
@@ -89,14 +91,13 @@ oss02:   0 UP obdfilter oss02-sdi oss02-sdi_UUID 3
 Here the obdfilter instance names are oss01-sdb, oss01-sdd, oss02-sdi.
 
 Since you are driving obdfilter instances directly, set the shell array
-variable 'ost_names' to the names of the obdfilter instances and leave
-'ECHO_CLIENTS' undefined.
+variable 'targets' to the names of the obdfilter instances. 
+
 Example:
 
-OSTS='oss01:oss01-sdb oss01:oss01-sdd oss02:oss02-sdi' \
+targets='oss01:oss01-sdb oss01:oss01-sdd oss02:oss02-sdi' \
    ./obdfilter-survey
 
-
 To run against a network:
 ------------------------
 For the second case i.e. obdfilter-survey over network, following setup
@@ -107,14 +108,14 @@ is to be done.
   and server machine to avoid typing password. 
 1. Automated run:
    To run obdfilter-surevy against network you just need to pass parameter 
-   case=netdisk and server_nid="<name/nid_of_server>" to the script.
+   case=netdisk and targets="<hostname/ip_of_server>" to the script.
  
-e.g. $ nobjhi=2 thrhi=2 size=1024 server_nid="<name/nid_of_server>" \
+e.g. $ nobjhi=2 thrhi=2 size=1024 targets="<hostname/ip_of_server>" \
        case=network sh obdfilter-survey
 
 On server side you can see the stats at : 
-        /proc/fs/lustre/obdecho/<ost-testfs>/ststs
-where, 'ost_testfs' is the obdecho server created through script.
+        /proc/fs/lustre/obdecho/<echo_srv>/stats
+where, 'echo_srv' is the obdecho server created through script.
 
 NOTE: In network test only automated run is supported.
 
@@ -125,13 +126,13 @@ To run against network-disk:
 1. Automated run:
 Setup the lustre with required OST's. Make sure that obdecho.ko module is
 present. Then invoke the obdfilter-survey script with parameter case=netdisk.
-e.g. : $ nobjhi=2 thrhi=2 size=1024 case=netdisk sh -x obdfilter-survey
+e.g. : $ nobjhi=2 thrhi=2 size=1024 case=netdisk sh obdfilter-survey
 
 2. Manual run:
 While running manually you need to tell the script all the names of the
 echo_client instances, which should already be up and running.
-e.g. $ nobjhi=2 thrhi=2 size=1024 ECHO_CLIENTS="ECHO_<osc_name> ..." \
-       sh -x obdfilter-survey
+e.g. $ nobjhi=2 thrhi=2 size=1024 targets="<osc_name> ..." \
+       sh obdfilter-survey
 
 
 Output files: