
the scenarios.

First line of this file say whether the data is to be

read in sequence (SEQUENTIAL), random (RANDOM), or user

(USER) order.

Each line corresponds to one call and has one or more

';' delimited data fields. Those fields can be referred

as [field0], [field1],

in the xml scenario file.

Several CSV files can be used simultaneously (syntax:

-inf f1.csv -inf f2.csv

)

-infindex : file field

Create an index of file using field. For example -inf

users.csv -infindex users.csv 0 creates an index on the

first key.

-ip_field : Set which field from the injection file contains the IP

address from which the client will send its messages.

If this option is omitted and the '-t ui' option is

present, then field 0 is assumed.

Use this option together with '-t ui'

-l : Set the maximum number of simultaneous calls. Once this

limit is reached, traffic is decreased until the number

of open calls goes down. Default:

(3 * call_duration (s) * rate).

-lost : Set the number of packets to lose by default (scenario

specifications override this value).

-m : Stop the test and exit when 'calls' calls are processed

-mi : Set the local media IP address (default: local primary

host IP address)

-master : 3pcc extended mode: indicates the master number

-max_recv_loops : Set the maximum number of messages received read per

cycle. Increase this value for high traffic level. The

default value is 1000.

-max_sched_loops : Set the maximum number of calsl run per event loop.

Increase this value for high traffic level. The default

value is 1000.

-max_reconnect : Set the the maximum number of reconnection.

-max_retrans : Maximum number of UDP retransmissions before call ends on

timeout. Default is 5 for INVITE transactions and 7 for

others.

-max_invite_retrans: Maximum number of UDP retransmissions for invite

transactions before call ends on timeout.

-max_non_invite_retrans: Maximum number of UDP retransmissions for non-invite

transactions before call ends on timeout.

-max_log_size : What is the limit for error and message log file sizes.

-max_socket : Set the max number of sockets to open simultaneously.

This option is significant if you use one socket per

call. Once this limit is reached, traffic is distributed

over the sockets already opened. Default value is 50000

-mb : Set the RTP echo buffer size (default: 2048).

-mp : Set the local RTP echo port number. Default is 6000.

-nd : No Default. Disable all default behavior of SIPp which

are the following:

- On UDP retransmission timeout, abort the call by

sending a BYE or a CANCEL

- On receive timeout with no ontimeout attribute, abort

the call by sending a BYE or a CANCEL

- On unexpected BYE send a 200 OK and close the call

- On unexpected CANCEL send a 200 OK and close the call

- On unexpected PING send a 200 OK and continue the call

- On any other unexpected message, abort the call by

sending a BYE or a CANCEL

-nr : Disable retransmission in UDP mode.

-nostdin : Disable stdin.

-p : Set the local port number. Default is a random free port

chosen by the system.

-pause_msg_ign : Ignore the messages received during a pause defined in

the scenario

-periodic_rtd : Reset response time partition counters each logging

interval.

-r : Set the call rate (in calls per seconds). This value can

bechanged during test by pressing '+','_','*' or '/'.

Default is 10.

pressing '+' key to increase call rate by 1 *

rate_scale,

pressing '-' key to decrease call rate by 1 *

rate_scale,

pressing '*' key to increase call rate by 10 *

rate_scale,

pressing '/' key to decrease call rate by 10 *

rate_scale.

If the -rp option is used, the call rate is calculated

with the period in ms given by the user.

-rp : Specify the rate period for the call rate. Default is 1

second and default unit is milliseconds. This allows

you to have n calls every m milliseconds (by using -r n

-rp m).

Example: -r 7 -rp 2000 ==> 7 calls every 2 seconds.

-r 10 -rp 5s => 10 calls every 5 seconds.

-rate_scale : Control the units for the '+', '-', '*', and '/' keys.

-rate_increase : Specify the rate increase every -fd units (default is

seconds). This allows you to increase the load for each

independent logging period.

Example: -rate_increase 10 -fd 10s

==> increase calls by 10 every 10 seconds.

-rate_max : If -rate_increase is set, then quit after the rate

reaches this value.

Example: -rate_increase 10 -rate_max 100

==> increase calls by 10 until 100 cps is hit.

-no_rate_quit : If -rate_increase is set, do not quit after the rate

reaches -rate_max.

-recv_timeout : Global receive timeout. Default unit is milliseconds. If

the expected message is not received, the call times out

and is aborted.

-send_timeout : Global send timeout. Default unit is milliseconds. If a

message is not sent (due to congestion), the call times

out and is aborted.

-reconnect_close : Should calls be closed on reconnect?

-reconnect_sleep : How long (in milliseconds) to sleep between the close and

reconnect?

-ringbuffer_files: How many error/message files should be kept after

rotation?

-ringbuffer_size : How large should error/message files be before they get

rotated?

-rsa : Set the remote sending address to host:port for sending

the messages.

-rtp_echo : Enable RTP echo. RTP/UDP packets received on port defined

by -mp are echoed to their sender.

RTP/UDP packets coming on this port + 2 are also echoed

to their sender (used for sound and video echo).

-rtt_freq : freq is mandatory. Dump response times every freq calls

in the log file defined by -trace_rtt. Default value is

200.

-s : Set the username part of the resquest URI. Default is

'service'.

-sd : Dumps a default scenario (embeded in the sipp executable)

-sf : Loads an alternate xml scenario file. To learn more

about XML scenario syntax, use the -sd option to dump

embedded scenarios. They contain all the necessary help.

-oocsf : Load out-of-call scenario.

-oocsn : Load out-of-call scenario.

-skip_rlimit : Do not perform rlimit tuning of file descriptor limits.

Default: false.

-slave : 3pcc extended mode: indicates the slave number

-slave_cfg : 3pcc extended mode: indicates the file where the master

and slave addresses are stored

-sn : Use a default scenario (embedded in the sipp executable).

If this option is omitted, the Standard SipStone UAC

scenario is loaded.

Available values in this version:

- 'uac' : Standard SipStone UAC (default).

- 'uas' : Simple UAS responder.

- 'regexp' : Standard SipStone UAC - with regexp and

variables.

- 'branchc' : Branching and conditional branching in

scenarios - client.

- 'branchs' : Branching and conditional branching in

scenarios - server.

Default 3pcc scenarios (see -3pcc option):

- '3pcc-C-A' : Controller A side (must be started after

all other 3pcc scenarios)

- '3pcc-C-B' : Controller B side.

- '3pcc-A' : A side.

- '3pcc-B' : B side.

-stat_delimiter : Set the delimiter for the statistics file

-stf : Set the file name to use to dump statistics

-t : Set the transport mode:

- u1: UDP with one socket (default),

- un: UDP with one socket per call,

- ui: UDP with one socket per IP address The IP

addresses must be defined in the injection file.

- t1: TCP with one socket,

- tn: TCP with one socket per call,

- l1: TLS with one socket,

- ln: TLS with one socket per call,

- c1: u1 + compression (only if compression plugin

loaded),

- cn: un + compression (only if compression plugin

loaded). This plugin is not provided with sipp.