3
sipp remote_host[:remote_port] [options]
7
-v : Display version and copyright information.
9
-aa : Enable automatic 200 OK answer for INFO, UPDATE and
12
-auth_uri : Force the value of the URI for authentication.
13
By default, the URI is composed of
14
remote_ip:remote_port.
16
-base_cseq : Start value of [cseq] for each call.
18
-bg : Launch SIPp in background mode.
20
-bind_local : Bind socket to local IP address, i.e. the local IP
21
address is used as the source IP address. If SIPp runs
22
in server mode it will only listen on the local IP
23
address instead of all IP addresses.
25
-buff_size : Set the send and receive buffer size.
27
-calldebug_file : Set the name of the call debug file.
29
-calldebug_overwrite: Overwrite the call debug file (default true).
31
-cid_str : Call ID string (default %u-%p@%s). %u=call_number,
32
%s=ip_address, %p=process_number, %%=% (in any order).
34
-ci : Set the local control IP address
36
-cp : Set the local control port number. Default is 8888.
38
-d : Controls the length of calls. More precisely, this
39
controls the duration of 'pause' instructions in the
40
scenario, if they do not have a 'milliseconds' section.
41
Default value is 0 and default unit is milliseconds.
43
-deadcall_wait : How long the Call-ID and final status of calls should be
44
kept to improve message and error logs (default unit is
47
-default_behaviors: Set the default behaviors that SIPp will use. Possbile
49
- all Use all default behaviors
50
- none Use no default behaviors
51
- bye Send byes for aborted calls
52
- abortunexp Abort calls on unexpected messages
53
- pingreply Reply to ping requests
54
If a behavior is prefaced with a -, then it is turned
55
off. Example: all,-bye
58
-error_file : Set the name of the error log file.
60
-error_overwrite : Overwrite the error log file (default true).
62
-f : Set the statistics report frequency on screen. Default is
63
1 and default unit is seconds.
65
-fd : Set the statistics dump log report frequency. Default is
66
60 and default unit is seconds.
68
-i : Set the local IP address for 'Contact:','Via:', and
69
'From:' headers. Default is primary host IP address.
72
-inf : Inject values from an external CSV file during calls into
74
First line of this file say whether the data is to be
75
read in sequence (SEQUENTIAL), random (RANDOM), or user
77
Each line corresponds to one call and has one or more
78
';' delimited data fields. Those fields can be referred
79
as [field0], [field1], ... in the xml scenario file.
80
Several CSV files can be used simultaneously (syntax:
81
-inf f1.csv -inf f2.csv ...)
83
-infindex : file field
84
Create an index of file using field. For example -inf
85
users.csv -infindex users.csv 0 creates an index on the
88
-ip_field : Set which field from the injection file contains the IP
89
address from which the client will send its messages.
90
If this option is omitted and the '-t ui' option is
91
present, then field 0 is assumed.
92
Use this option together with '-t ui'
94
-l : Set the maximum number of simultaneous calls. Once this
95
limit is reached, traffic is decreased until the number
96
of open calls goes down. Default:
97
(3 * call_duration (s) * rate).
99
-log_file : Set the name of the log actions log file.
101
-log_overwrite : Overwrite the log actions log file (default true).
103
-lost : Set the number of packets to lose by default (scenario
104
specifications override this value).
106
-rtcheck : Select the retransmisison detection method: full
109
-m : Stop the test and exit when 'calls' calls are processed
111
-mi : Set the local media IP address (default: local primary
114
-master : 3pcc extended mode: indicates the master number
116
-max_recv_loops : Set the maximum number of messages received read per
117
cycle. Increase this value for high traffic level. The
118
default value is 1000.
120
-max_sched_loops : Set the maximum number of calsl run per event loop.
121
Increase this value for high traffic level. The default
124
-max_reconnect : Set the the maximum number of reconnection.
126
-max_retrans : Maximum number of UDP retransmissions before call ends on
127
timeout. Default is 5 for INVITE transactions and 7 for
130
-max_invite_retrans: Maximum number of UDP retransmissions for invite
131
transactions before call ends on timeout.
133
-max_non_invite_retrans: Maximum number of UDP retransmissions for non-invite
134
transactions before call ends on timeout.
136
-max_log_size : What is the limit for error and message log file sizes.
138
-max_socket : Set the max number of sockets to open simultaneously.
139
This option is significant if you use one socket per
140
call. Once this limit is reached, traffic is distributed
141
over the sockets already opened. Default value is 50000
143
-mb : Set the RTP echo buffer size (default: 2048).
145
-message_file : Set the name of the message log file.
147
-message_overwrite: Overwrite the message log file (default true).
149
-mp : Set the local RTP echo port number. Default is 6000.
151
-nd : No Default. Disable all default behavior of SIPp which
153
- On UDP retransmission timeout, abort the call by
154
sending a BYE or a CANCEL
155
- On receive timeout with no ontimeout attribute, abort
156
the call by sending a BYE or a CANCEL
157
- On unexpected BYE send a 200 OK and close the call
158
- On unexpected CANCEL send a 200 OK and close the call
159
- On unexpected PING send a 200 OK and continue the call
160
- On any other unexpected message, abort the call by
161
sending a BYE or a CANCEL
164
-nr : Disable retransmission in UDP mode.
166
-nostdin : Disable stdin.
169
-p : Set the local port number. Default is a random free port
170
chosen by the system.
172
-pause_msg_ign : Ignore the messages received during a pause defined in
175
-periodic_rtd : Reset response time partition counters each logging
178
-plugin : Load a plugin.
180
-r : Set the call rate (in calls per seconds). This value can
181
bechanged during test by pressing '+','_','*' or '/'.
183
pressing '+' key to increase call rate by 1 *
185
pressing '-' key to decrease call rate by 1 *
187
pressing '*' key to increase call rate by 10 *
189
pressing '/' key to decrease call rate by 10 *
191
If the -rp option is used, the call rate is calculated
192
with the period in ms given by the user.
194
-rp : Specify the rate period for the call rate. Default is 1
195
second and default unit is milliseconds. This allows
196
you to have n calls every m milliseconds (by using -r n
198
Example: -r 7 -rp 2000 ==> 7 calls every 2 seconds.
199
-r 10 -rp 5s => 10 calls every 5 seconds.
201
-rate_scale : Control the units for the '+', '-', '*', and '/' keys.
203
-rate_increase : Specify the rate increase every -fd units (default is
204
seconds). This allows you to increase the load for each
205
independent logging period.
206
Example: -rate_increase 10 -fd 10s
207
==> increase calls by 10 every 10 seconds.
209
-rate_max : If -rate_increase is set, then quit after the rate
211
Example: -rate_increase 10 -rate_max 100
212
==> increase calls by 10 until 100 cps is hit.
214
-no_rate_quit : If -rate_increase is set, do not quit after the rate
217
-recv_timeout : Global receive timeout. Default unit is milliseconds. If
218
the expected message is not received, the call times out
221
-send_timeout : Global send timeout. Default unit is milliseconds. If a
222
message is not sent (due to congestion), the call times
225
-sleep : How long to sleep for at startup. Default unit is
228
-reconnect_close : Should calls be closed on reconnect?
230
-reconnect_sleep : How long (in milliseconds) to sleep between the close and
233
-ringbuffer_files: How many error/message files should be kept after
236
-ringbuffer_size : How large should error/message files be before they get
239
-rsa : Set the remote sending address to host:port for sending
242
-rtp_echo : Enable RTP echo. RTP/UDP packets received on port defined
243
by -mp are echoed to their sender.
244
RTP/UDP packets coming on this port + 2 are also echoed
245
to their sender (used for sound and video echo).
247
-rtt_freq : freq is mandatory. Dump response times every freq calls
248
in the log file defined by -trace_rtt. Default value is
251
-s : Set the username part of the resquest URI. Default is
254
-sd : Dumps a default scenario (embeded in the sipp executable)
256
-sf : Loads an alternate xml scenario file. To learn more
257
about XML scenario syntax, use the -sd option to dump
258
embedded scenarios. They contain all the necessary help.
260
-shortmessage_file: Set the name of the short message log file.
262
-shortmessage_overwrite: Overwrite the short message log file (default true).
264
-oocsf : Load out-of-call scenario.
266
-oocsn : Load out-of-call scenario.
268
-skip_rlimit : Do not perform rlimit tuning of file descriptor limits.
271
-slave : 3pcc extended mode: indicates the slave number
273
-slave_cfg : 3pcc extended mode: indicates the file where the master
274
and slave addresses are stored
276
-sn : Use a default scenario (embedded in the sipp executable).
277
If this option is omitted, the Standard SipStone UAC
279
Available values in this version:
281
- 'uac' : Standard SipStone UAC (default).
282
- 'uas' : Simple UAS responder.
283
- 'regexp' : Standard SipStone UAC - with regexp and
285
- 'branchc' : Branching and conditional branching in
287
- 'branchs' : Branching and conditional branching in
290
Default 3pcc scenarios (see -3pcc option):
292
- '3pcc-C-A' : Controller A side (must be started after
293
all other 3pcc scenarios)
294
- '3pcc-C-B' : Controller B side.
299
-stat_delimiter : Set the delimiter for the statistics file
301
-stf : Set the file name to use to dump statistics
303
-t : Set the transport mode:
304
- u1: UDP with one socket (default),
305
- un: UDP with one socket per call,
306
- ui: UDP with one socket per IP address The IP
307
addresses must be defined in the injection file.
308
- t1: TCP with one socket,
309
- tn: TCP with one socket per call,
310
- l1: TLS with one socket,
311
- ln: TLS with one socket per call,
312
- c1: u1 + compression (only if compression plugin
314
- cn: un + compression (only if compression plugin
315
loaded). This plugin is not provided with sipp.
318
-timeout : Global timeout. Default unit is seconds. If this option
319
is set, SIPp quits after nb units (-timeout 20s quits
322
-timeout_error : SIPp fails if the global timeout is reached is set
323
(-timeout option required).
325
-timer_resol : Set the timer resolution. Default unit is milliseconds.
326
This option has an impact on timers precision.Small
327
values allow more precise scheduling but impacts CPU
328
usage.If the compression is on, the value is set to
329
50ms. The default value is 10ms.
331
-sendbuffer_warn : Produce warnings instead of errors on SendBuffer
334
-trace_msg : Displays sent and received SIP messages in <scenario file
335
name>_<pid>_messages.log
337
-trace_shortmsg : Displays sent and received SIP messages as CSV in
338
<scenario file name>_<pid>_shortmessages.log
340
-trace_screen : Dump statistic screens in the
341
<scenario_name>_<pid>_ s.log file when quitting
342
SIPp. Useful to get a final status report in background
345
-trace_err : Trace all unexpected messages in <scenario file
346
name>_<pid>_errors.log.
348
-trace_calldebug : Dumps debugging information about aborted calls to
349
<scenario_name>_<pid>_calldebug.log file.
351
-trace_stat : Dumps all statistics in <scenario_name>_<pid>.csv file.
352
Use the '-h stat' option for a detailed description of
353
the statistics file content.
355
-trace_counts : Dumps individual message counts in a CSV file.
357
-trace_rtt : Allow tracing of all response times in <scenario file
360
-trace_logs : Allow tracing of <log> actions in <scenario file
361
name>_<pid>_logs.log.
363
-users : Instead of starting calls at a fixed rate, begin 'users'
364
calls at startup, and keep the number of calls constant.
366
-watchdog_interval: Set gap between watchdog timer firings. Default is 400.
368
-watchdog_reset : If the watchdog timer has not fired in more than this
369
time period, then reset the max triggers counters.
370
Default is 10 minutes.
372
-watchdog_minor_threshold: If it has been longer than this period between watchdog
373
executions count a minor trip. Default is 500.
375
-watchdog_major_threshold: If it has been longer than this period between watchdog
376
executions count a major trip. Default is 3000.
378
-watchdog_major_maxtriggers: How many times the major watchdog timer can be tripped
379
before the test is terminated. Default is 10.
381
-watchdog_minor_maxtriggers: How many times the minor watchdog timer can be tripped
382
before the test is terminated. Default is 120.
384
-ap : Set the password for authentication challenges. Default
387
-tls_cert : Set the name for TLS Certificate file. Default is
390
-tls_key : Set the name for TLS Private Key file. Default is
393
-tls_crl : Set the name for Certificate Revocation List file. If not
394
specified, X509 CRL is not activated.
396
-3pcc : Launch the tool in 3pcc mode ("Third Party call
397
control"). The passed ip address is depending on the
399
- When the first twin command is 'sendCmd' then this is
400
the address of the remote twin socket. SIPp will try to
401
connect to this address:port to send the twin command
402
(This instance must be started after all other 3PCC
404
Example: 3PCC-C-A scenario.
405
- When the first twin command is 'recvCmd' then this is
406
the address of the local twin socket. SIPp will open
407
this address:port to listen for twin command.
408
Example: 3PCC-C-B scenario.
410
-tdmmap : Generate and handle a table of TDM circuits.
411
A circuit must be available for the call to be placed.
412
Format: -tdmmap {0-3}{99}{5-8}{1-31}
415
Set the generic parameter named "keyword" to "value".
417
-set : variable value
418
Set the global variable parameter named "variable" to
421
-dynamicStart : variable value
422
Set the start offset of dynamic_id varaiable
424
-dynamicMax : variable value
425
Set the maximum of dynamic_id variable
427
-dynamicStep : variable value
428
Set the increment of dynamic_id variable
432
SIPp can be controlled using posix signals. The following signals
434
USR1: Similar to press 'q' keyboard key. It triggers a soft exit
435
of SIPp. No more new calls are placed and all ongoing calls
436
are finished before SIPp exits.
437
Example: kill -SIGUSR1 732
438
USR2: Triggers a dump of all statistics screens in
439
<scenario_name>_<pid>_screens.log file. Especially useful
440
in background mode to know what the current status is.
441
Example: kill -SIGUSR2 732
445
Upon exit (on fatal error or when the number of asked calls (-m
446
option) is reached, sipp exits with one of the following exit
448
0: All calls were successful
449
1: At least one call failed
450
97: exit on internal command. Calls may have been processed
451
99: Normal exit without calls processed
457
Run sipp with embedded server (uas) scenario:
459
On the same host, run sipp with embedded client (uac) scenario
460
./sipp -sn uac 127.0.0.1
added
removed
tools/sippxml/sippusage.txt
