1. Neeraj Jain Cavisson System Inc
NetStorm Keywords
Neeraj Jain Cavisson System Inc

2. Agenda
Keyword Definition
Keyword Format
Top 25 Keywords
Q & A

3. Keyword Definition
Keyword is a set of attributes, which signifies the behavior of NetStorm or Test Scenario.
Syntax and semantics of value(s) depend upon the keyword.
Default values of the keywords are used when a keyword is missing from configuration file.
Scalar or Vector (Tabular)
Most keywords have default values

4. Keyword Format
<Keyword> <value1> <value2> …. <valueN>
For examples:
RUN_TIME 1 H
WAN_ENV 1

5. Top 25 Keywords IP Keywords Scenario Group Keywords Pacing Keywords
SERVER_HOST
USE_SRC_IP
SRC_IP_LIST
USE_SAME_NETID_SRC
Scenario Group Keywords
SG or SGRP
Pacing Keywords
SESSION_PACING
PAGE_THINK_TIME

6. Top 25 Keywords (Continued)
Logging Keywords
REPORTING
TRACING
LOGGING 
Schedule Keywords
RUN_TIME
RAMP_UP_RATE
RAMP_UP_MODE 
Connection Keywords
KA_PCT
NUM_KA

7. Top 25 Keywords (Continued)
Optimization Keywords
NO_VALIDATION
NUM_PROCESSES
OPTIMIZE_ETHER_FLOW
Monitoring Keywords
MONITOR
SERVER_STATS
SERVER_PERF_STATS 
WAN Simulation Keywords
WAN_ENV 
Misc Keywords
TNAME 

8. IP Keywords
SERVER_HOST <recorded-host> <actual-host1> < actual-host-location1> …… [<actual-hostN> < actual-host-locationN> ]
Examples:
SERVER_HOST Chicago
SERVER_HOST MyServer Chicago
SERVER_HOST :8888 -
SERVER_HOST : Chicago
SERVER_HOST :8888 Chicago
SERVER_HOST ALL Chicago

9. IP Keywords (Continued)
USE_SRC_IP <src_ip_mode> [<ip_list_mode>]
src_ip_mode:
0: Use Netstorm's Admin IP (default). ip_list_mode not required.
1: Share a pool of IP's. All Vusers pick the IP from a list of IPs. i.e. if there are 100 users and 100 IPs given then they can take any ip out of these 100. Two Vusers can have same IP as well.
2: Use a unique IP's. In this option all Vusers uses a unique IP. i.e. if there are 100 users and 100 IPs given then they can take any ip out of these 100. But Two Vusers cannot have same IP.
ip-list-mode:
0: Use the IP's specified by SRC_IP_LIST keyword(s).
1-x: Use x IP's from assigned aliased IP's.
: Use all IP's from assigned aliased IP's.
Examples:
USE_SRC_IP 0
USE_SRC_IP 2 100

10. IP Keywords (Continued)
SRC_IP_LIST <start-ip> <num-IPs>
start-ip: Start IP address.
num-ip: Number of IPs to be used.
SRC_IP_LIST can repeat more than 1 time.
SRC_IP_LIST is used only when ip-list-mode field of USR_SRC_IP is 0.
Examples:
SRC_IP_LIST
SRC_IP_LIST

11. IP Keywords (Continued)
USE_SAME_NETID_SRC <value>
Value:
0: This would disable the use of same source net id.
1: This would enable the use of same source net id.

12. Scenario Group Keywords
SGRP <scenario-group-name> <user-profile> <type> <script-name-or-url> <num>
group-name is just a unique name identifier.
user-profile is the name of user profile representing user characteristics.
type is the identification for type of session that it is Script or it is a URL.
0: value is for Script.
1: is for URL.
script-name-or-url is the name of the script executed by the virtual users in this scenario group or the URL
num is the either the number of users or the percentage of users in this scenario group. For Fix Concurrent Users scenario type (default scenario type), num is the number of virtual users in the scenario. For all other scenario types, num is the Percentage of virtual users. In the later case, num for all scenario groups must add to 100.
Examples:
SGRP G1 Internet 0 static1K 100
SGRP G2 Internet

13. Pacing Keywords
SESSION_PACING <session-name> <pacing-mode> <refresh-vu> <pace-first-session> <pacing-timing-mode> <pacing-time>
session_name is the script name. ALL specifies the default setting of session pacing. Default session pacing applies all such session for which no script-specific session pacing configuration is defined. 
pacing-mode when the next session is started after a vuser completes. It can have one of the possible values:
0: Next session is started immediately after completing the last session. This mode is good for controlled tests. (Default mode)
1: Before starting a session pause for session pacing-time.
2: Start sessions at the session-pacing intervals  
refresh-vu defines if the virtual user would start a next session as a new user (by way of cleaning up all current caches & connections) or not. Possible values are:
0: Virtual user Continues from the current state (default)
1: Virtual user would start as a new user for each execution of a test script
First 2 fields are required in all cases. Next 3 fields are required, only if pacing-mode is 1 or 2. 

14. Pacing Keywords (Continued)
pace-first-session defines if a pause would be required before the first session too. This can be a very useful setting for spreading a low frequency activity in a more real life distribution Possible values are
0: Session pause would be done before first session. Pacing time mode for
the first session would be same as for subsequent pacing intervals and is
specified by pacing-time-mode. (Default)
1: No session pause before the first session. Pause would be done before
subsequent iterations of the test script. (It means NO session pause)
2: Session pause would be done before first session. Pacing time mode for
the first session would be Constant while for subsequent pacing intervals it
is specified by pacing-time-mode
3: Session pause would be done before first session. Pacing time mode for
the first session would be Random while for subsequent pacing intervals it
is specified by pacing-time-mode. (It means YES, There would be session pause)

15. Pacing Keywords (Continued)
pacing-time-mode can be:
0: Constant pacing time specified by pacing-time
1: Internet Random pacing time, specified as the average time by pacing-time.
pacing-time is specified in milliseconds

16. Pacing Keywords (Continued)
PAGE_THINK_TIME <script-name> < page-name> < think-mode> <value1> <value2>
script-name & page-name specifies the script and the page name of the session for which page specific think time is being defined. A special value of ALL for both of them together specifies the default setting of page think time.
Possible values of Think-mode and description value1 and value2 are explained in the table below.
Think Mode
Value1
Comments
No Think Time
Not
Applicable
Helps in doing controlled tests and increasing the server load.
Internet Type Random
Median
Time
Most Realistic
Constant
Helps in doing controlled
tests. As one can calculate the number of page requests
expected within certain
duration
Uniform Random
Minimum
Maximum
Realistic

17. Logging Keywords REPORTING <report-level> report-level:
0: Only summary reports
1: Summary and Runtime reports (default)
2: Summary, runtime and detailed reports
3: Summary, runtime, detailed reports and Runtime graphs (Discuss)

18. Logging Keywords (Continued)
TRACING <trace-level> <destination> <tracing-on-failure> <max-trace-message-size>
trace-level : All messages belonging to trace-level and below are enabled.
0: No trace enabled
1: Only URL failure notifications are enabled (Default)
2: URL Failure Notification and parameter substitution are enabled
3: URL Failure Notifications, Parameter substitution and URL responses are enabled
4: URL Failure Notifications, Parameter substitution and URL responses are enabled and response dumps created.
destination specifies where the logs are logged. Possible values are:
0:log only to standard out (screen) (Default)
1:log to file only
2:log to both standard out and logs
LOGGING 

19. Logging Keywords (Continued)
tracing-on-failure specifies the condition when the trace messages are logged. Possible values are
0: Trace all URL interactions
1: Trace only failures (Default)
max-trace-message-size is the maximum size of the trace message that should be logged. 0 means log the complete response without limiting its size. The default value is 4096 bytes.

20. Logging Keywords (Continued)
LOGGING <log-level> <destination>
log_level: All messages belonging to log-level and below are enabled. Possible values of log level are:
0: No logs enabled
1: Only logs logged with Standard Log Level are enabled (Default)
2: Logs with Standard and Extended log level are enabled
3: All logs (standard, extended and debug are enabled).
destination specifies where the logs are logged. Possible values are:
0:log only to standard out (screen) (Default)
1:log to file only
2:log to both standard out and logs

21. Schedule Keywords RAMP_UP_RATE <ramp-rate-value> <unit>
RAMP_UP_MODE <ramp-mode>
Only for Fix Concurrent Users scenario type (default).
Target number of virtual users (the summation of number of users specified by all SG
keywords) is usually achieved by gradually increasing the number of users.
RAMP_UP_RATE defines the average rate at which virtual users are ramped up.
RAMP_UP_MODE defines the ramp up pattern.
ramp-rate-value is the rate at which the users should be ramped.
 unit: S – Second, H – Hour, M - Minute.
ramp-mode can have one of the following possible values
0: Ramp in the steps of 2 seconds 
1: Ramp linearly
2: Ramp randomly with Poisson distribution.  
3: Immediate ramp up

22. Connection Keywords KA_PCT <keep-alive-pct>
NUM_KA <min-ka-requests-on-each-connection> < max-ka-requests-on-each-connection>
keep-alive-pct is the percentage of total connection initiated by NetStorm that it tries to reuse for HTTP Request. Valid values are from 0 to 100.
min-ka-requests-on-each-connection is the minimum value of the requests that would be made on a single connection which is remaining as keep alive.
max-ka-requests-on-each-connection is the maximum value of the requests that would be made on a single connection which is remaining as keep alive.
Average number of keep-alive requests attempted on each Keep-Alive connection by NetStorm will be a random number between min and max.

23. Connection Keywords (Continued)
KA_PCT
NUM_KA
Min
Max
Comment
100
For max throughout, concurrency and Hits/Sec 1
For Max CPS

24. Optimization Keywords
NO_VALIDATION <val-value>
val-value:
0 – Do validation.
1 – Do not do validations
NUM_PROCESSES <num_process> <cpu-or-machine>
num_process defines the number the netstorm child processes to start for a scenario. Default value is 4.
cpu-or-machine:
CPU – Start given number of child processes per CPU
MACHINE - Start given number of child processes per MACHINE

25. Optimization Keywords (Continued)
Client Server
Connection (3 Way Handshake)
SYN
>
SYN + ACK of SYN
<
ACK (Candidate for Merge)
> Data
Client Sending ACK (Candidate for Merge)
the data <
Data
<
ACK (Candidate for Merge) Server Sending
> the data.
FIN
Client Disconnect FIN + ACK of FIN (Candidate for not send if RST is used))
ACK (Candidate for not send if RST is used))
>
 Total of 10 packet are exchanged for one request on one connection is no optimize ether flow is used.

26. Optimization Keywords (Continued)
OPTIMIZE_ETHER_FLOW <HandshakeMergeAck> <DataMergeAck> <Fin/Reset >
HandshakeMergeAck: Used to control merging on ACK during handshake (connection).
0: This is default. In this case, no merging is done to reduce number of packets.
1: This will result in piggybacking of ACK with other packets as and when possible during handshake. If used in client side and client is making connection (which is he case), then ACK of SYN and Data will be merged. This will result in reduction of packets by 1.
Same will happen if used on server side and server is making connection.
DataMergeAck: Used to control merging on ACK during data communication.
1: This will result in piggybacking of ACK with other packets as and when possible during data communication. If used in client side, then ACK and FIN will be merged. This will result in reduction of packets by 1.
If used in server side, then ACK of Data and Data will be merged. This will result in reduction of packets by 1.

27. Optimization Keywords (Continued)
Fin/ Reset:
0: This is default. In this case, connection will be closed gracefully using FIN.
1: This value will close the connection by sending TCP Reset (RST) instead of FIN. No packets will be send back from other side. This will result in reduction of packets by 2 if close is done by the side where this option is used.
Note - Since NetStorm closes connection in most cases; this option may not have any impact if used on Server Side. But in some cases e.g. keep alive timeout on server, can cause server also to close connection.

28. Monitoring Keywords
MONITOR <monitor_name> <host_ip> <args>
monitor_name: Name of the Monitor, which will monitor the performance. Valid values are – linux, tcp, nc_mon.
host_ip: IP or server name where monitor will run.
args: Arguments for the monitor. Currently used for nc_mon only to specify Tunnel Names.
Examples:
MONITOR linux
MONITOR tcp
MONITOR nc_mon tunnel1 tunnel2
CUSTOM_MONITOR – Coming soon in next release.

29. Monitoring Keywords (Continued)
SERVER_STATS <server ip 1> <server ip 2>…………<server ip 10>
SERVER_PERF_STATS <option> <Server address>
Option: unix_rstat or windows_perfmon.
The unix_rstat is used for Unix server which to be monitored.
The windows_perfmon is used for Window server which to be monitored.
Server address is the address of the server (Unix or Window),to be monitored.
Examples:
SERVER_PERF_STATS unix_rstat
SERVER_PERF_STATS unix_rstat

30. WAN Simulation Keywords
WAN_ENV <internet-simulation-flag>
internet-simulation-flag:
0: Disable Internet simulation (Default)
1: Enable Internet simulation

31. Miscellaneous Keywords
TNAME <test-name>
This keyword is used to specify the Test Name which one is going to execute so that it can be identify by name.
test-name: Name of the test.
Example:
TNAME Test for Maximum Throughput

32. Q & A
????