-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlteims.html
More file actions
2948 lines (2686 loc) · 105 KB
/
lteims.html
File metadata and controls
2948 lines (2686 loc) · 105 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>LTE IMS Server</title>
<meta name="description" content="LTE IMS Server">
<meta name="keywords" content="LTE IMS Server">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
table {
border-spacing: 0px;
border-collapse: collapse;
}
th {
border: 1px solid black;
background-color: #c0f585;
font-size: 14px;
padding: 5px;
}
td {
border: 1px solid black;
padding: 2px 4px;
}
p>img {
display: initial;
}
-->
</style>
</head>
<body lang="en">
<h1 class="settitle" align="center">LTE IMS Server</h1>
<span id="SEC_Contents"></span>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>
<li><a id="toc-Features" href="#Features">2 Features</a></li>
<li><a id="toc-Requirements" href="#Requirements">3 Requirements</a>
<ul class="no-bullet">
<li><a id="toc-Hardware-requirements" href="#Hardware-requirements">3.1 Hardware requirements</a></li>
<li><a id="toc-Known-compatible-UE" href="#Known-compatible-UE">3.2 Known compatible UE</a></li>
<li><a id="toc-Software-requirements" href="#Software-requirements">3.3 Software requirements</a></li>
</ul></li>
<li><a id="toc-Installation" href="#Installation">4 Installation</a>
<ul class="no-bullet">
<li><a id="toc-Fedora-setup" href="#Fedora-setup">4.1 Fedora setup</a></li>
<li><a id="toc-License-key-installation" href="#License-key-installation">4.2 License key installation</a></li>
<li><a id="toc-Initial-testing" href="#Initial-testing">4.3 Initial testing</a></li>
<li><a id="toc-Samsung-S5-configuration" href="#Samsung-S5-configuration">4.4 Samsung S5 configuration</a></li>
</ul></li>
<li><a id="toc-Configuration-reference" href="#Configuration-reference">5 Configuration reference</a>
<ul class="no-bullet">
<li><a id="toc-Configuration-file-syntax" href="#Configuration-file-syntax">5.1 Configuration file syntax</a>
<ul class="no-bullet">
<li><a id="toc-JSON-merge-rules-1" href="#JSON-merge-rules-1">5.1.1 JSON merge rules</a></li>
</ul></li>
<li><a id="toc-Properties" href="#Properties">5.2 Properties</a>
<ul class="no-bullet">
<li><a id="toc-User-database-options" href="#User-database-options">5.2.1 User database options</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Remote-API-1" href="#Remote-API-1">6 Remote API</a>
<ul class="no-bullet">
<li><a id="toc-Messages" href="#Messages">6.1 Messages</a></li>
<li><a id="toc-Startup" href="#Startup">6.2 Startup</a></li>
<li><a id="toc-Errors" href="#Errors">6.3 Errors</a></li>
<li><a id="toc-Sample-nodejs-program" href="#Sample-nodejs-program">6.4 Sample nodejs program</a></li>
<li><a id="toc-Common-messages" href="#Common-messages">6.5 Common messages</a></li>
<li><a id="toc-LTE-messages-1" href="#LTE-messages-1">6.6 LTE messages</a></li>
<li><a id="toc-LTE-events" href="#LTE-events">6.7 LTE events</a></li>
<li><a id="toc-Examples" href="#Examples">6.8 Examples</a></li>
</ul></li>
<li><a id="toc-Command-line-monitor-reference" href="#Command-line-monitor-reference">7 Command line monitor reference</a></li>
<li><a id="toc-Log-file-format-1" href="#Log-file-format-1">8 Log file format</a>
<ul class="no-bullet">
<li><a id="toc-IMS_002c-SIP" href="#IMS_002c-SIP">8.1 IMS, SIP</a></li>
<li><a id="toc-CX_002c-RX" href="#CX_002c-RX">8.2 CX, RX</a></li>
<li><a id="toc-MEDIA" href="#MEDIA">8.3 MEDIA</a></li>
</ul></li>
<li><a id="toc-Change-history" href="#Change-history">9 Change history</a>
<ul class="no-bullet">
<li><a id="toc-Version-2024_002d12_002d13" href="#Version-2024_002d12_002d13">9.1 Version 2024-12-13</a></li>
<li><a id="toc-Version-2024_002d09_002d13" href="#Version-2024_002d09_002d13">9.2 Version 2024-09-13</a></li>
<li><a id="toc-Version-2024_002d06_002d14" href="#Version-2024_002d06_002d14">9.3 Version 2024-06-14</a></li>
<li><a id="toc-Version-2024_002d03_002d15" href="#Version-2024_002d03_002d15">9.4 Version 2024-03-15</a></li>
<li><a id="toc-Version-2023_002d12_002d15" href="#Version-2023_002d12_002d15">9.5 Version 2023-12-15</a></li>
<li><a id="toc-Version-2023_002d09_002d08" href="#Version-2023_002d09_002d08">9.6 Version 2023-09-08</a></li>
<li><a id="toc-Version-2023_002d06_002d10" href="#Version-2023_002d06_002d10">9.7 Version 2023-06-10</a></li>
<li><a id="toc-Version-2023_002d03_002d17" href="#Version-2023_002d03_002d17">9.8 Version 2023-03-17</a></li>
<li><a id="toc-Version-2022_002d12_002d16" href="#Version-2022_002d12_002d16">9.9 Version 2022-12-16</a></li>
<li><a id="toc-Version-2022_002d09_002d16" href="#Version-2022_002d09_002d16">9.10 Version 2022-09-16</a></li>
<li><a id="toc-Version-2022_002d06_002d17" href="#Version-2022_002d06_002d17">9.11 Version 2022-06-17</a></li>
<li><a id="toc-Version-2022_002d03_002d18" href="#Version-2022_002d03_002d18">9.12 Version 2022-03-18</a></li>
<li><a id="toc-Version-2021_002d12_002d17" href="#Version-2021_002d12_002d17">9.13 Version 2021-12-17</a></li>
<li><a id="toc-Version-2021_002d09_002d17" href="#Version-2021_002d09_002d17">9.14 Version 2021-09-17</a></li>
</ul></li>
<li><a id="toc-License" href="#License">10 License</a></li>
<li><a id="toc-Abbreviations" href="#Abbreviations">Abbreviations</a></li>
</ul>
</div>
<span id="Introduction"></span><h2 class="chapter">1 Introduction</h2>
<p>LTEIMS is an IMS standalone simple server.
It has a built-in P-CSCF, I-CSCF, S-CSCF, HSS.
It also allows SMS handling including SMS over SG by connecting to the Amarisoft MME.
</p>
<span id="Features"></span><h2 class="chapter">2 Features</h2>
<ul>
<li> Implements P-CSCF with built-in I-CSCF, S-CSCF and HSS.
</li><li> Support of SIP protocol.
</li><li> Support of MD5, AKAv1 and AKAv2 authentication.
</li><li> Support of ISIM cards using the XOR, Milenage or TUAK authentication algorithm.
</li><li> Support of IPsec (ESP/transport).
</li><li> Support of voice, video calls: MO and MT.
</li><li> Support of voice echo test.
</li><li> Support of hold.
</li><li> Support of SMS (GSM 3.40) using SIP MESSAGE and SMS over SG.
</li><li> Support of IPv4 and IPv6.
</li><li> Support of precondition and dedicated bearer using Rx interface or N5 interface.
</li><li> Support of emergency call.
</li><li> Configurable user database.
</li><li> External authentication using Cx interface.
</li><li> Command line monitor.
</li><li> Remote API using WebSocket.
</li></ul>
<span id="Requirements"></span><h2 class="chapter">3 Requirements</h2>
<span id="Hardware-requirements"></span><h3 class="section">3.1 Hardware requirements</h3>
<ul>
<li> LTEIMS can run on the same PC as the Amarisoft eNodeB if a simple and
compact solution is needed. Otherwise, any reasonnably recent PC with
at least one Gigabit Ethernet port is acceptable.
</li><li> A VoLTE compatible UE is necessary (See <a href="#VoLTE-Call">VoLTE Call</a>, note that it may depends on UE).
</li><li> A test USIM with ISIM application should be plugged into the UE. IMSI and secret key must be known.
A standard USIM may also work but it depends on the UE implementation.
</li></ul>
<span id="Known-compatible-UE"></span><h3 class="section">3.2 Known compatible UE</h3>
<p>The Amarisoft IMS server has been tested with the following UE models:
</p><ul>
<li> Samsung S5
</li><li> LG MS870
</li></ul>
<span id="Software-requirements"></span><h3 class="section">3.3 Software requirements</h3>
<ul>
<li> A 64 bit Linux distribution. Fedora 39 is the officially supported distribution.<br>
The following distributions are known as compatible:
<ul>
<li> Fedora 22 to 39
</li><li> Cent OS 7
</li><li> Ubuntu 14 to 22
</li></ul>
<p>Your system requires at least GLIBC 2.17.
</p>
</li></ul>
<span id="Installation"></span><h2 class="chapter">4 Installation</h2>
<p>The network access thru the Gigabit Ethernet port must be correctly configured.
</p>
<p>LTEIMS can be run directly from the directory when it was unpacked. No
need for explicit installation.
</p>
<span id="Fedora-setup"></span><h3 class="section">4.1 Fedora setup</h3>
<p>If you want to use SMS over SG with the Amarisoft MME or precondition with QoS, you need support of SCTP protocol for which
the necessary packages are not usually installed. In order to install them, do as root user:
</p>
<ul>
<li> Fedora
<div class="example">
<pre class="example">dnf install lksctp-tools kernel-modules-extra
</pre></div>
</li><li> Ubuntu
<div class="example">
<pre class="example">sudo apt-get install lksctp-tools linux-image-extra-3.13.0-24-generic
</pre></div>
<p>Note that linux-image-extra package name may differ depending on your kernel version.
</p>
</li></ul>
<p>To verify that SCTP kernel module is running, do as root user:
</p><div class="example">
<pre class="example">checksctp
</pre></div>
<p>If it reports that the protocol is not supported,
</p><ul>
<li> check if you have a /etc/modprobe.d/sctp-blacklist.conf file
</li><li> edit it to comment the ’blacklist sctp’ line
</li></ul>
<p>Then reboot the PC in case the Linux kernel was upgraded too.
</p>
<span id="License-key-installation"></span><h3 class="section">4.2 License key installation</h3>
<p>LTEIMS needs a <code>LTEMME</code> license key to run.
Please refer to the <code>ltemme</code> documentation.
</p>
<span id="Initial-testing"></span><h3 class="section">4.3 Initial testing</h3>
<ul>
<li> Edit the file <samp>config/ims.cfg</samp> to set the address of the SIP interface. Normally it is the address
of the Ethernet interface that will receive SIP packets.<br>
You can keep the current config if you use it with the Amarisoft MME and its <samp>config/mme-ims.cfg</samp> config file.
</li><li> Start the program as root with:
<div class="example">
<pre class="example">./lteims config/ims.cfg
</pre></div>
<p>[The root access is only needed if you want IPsec support.]
</p>
</li><li> The command line interface is used to monitor the operation of LTEIMS and to change the logging options.<br>
Use <code>help</code> to get the list of commands and <code>quit</code> to stop the program.
</li><li> Use <code>users</code> to list the user database and registering state.
</li></ul>
<span id="Samsung-S5-configuration"></span><h3 class="section">4.4 Samsung S5 configuration</h3>
<p>Your UE must run at least Android 5.0 (Even if Android 5.0 is installed, try to update software
(several times) as a sub-release is necessary).<br>
If not, please update it.<br>
</p>
<p>To check your UE is configured for VoLTE, please go to
<code>Settings</code>/<code>More networks</code>/<code>Mobile networks</code> of your handset
and check <code>VoLTE Call</code> is checked:
</p>
<span id="VoLTE-Call"></span><img src="img/s5-volte.webp" alt="img/s5-volte">
<p>We assume you are using the system with Amarisoft MME and <samp>config/mme-ims.cfg</samp> config file.<br>
As there are two PDN defined, you must add them to the UE.<br>
</p>
<ul>
<li> Go to Settings/More networks/Mobile networks
</li><li> Turn on Data roaming
</li><li> Check VoLTE Call (If not present, it means your device is not up to date or does not support VoLTE).
</li><li> Go to Network operators, search for networks and select Amarisoft network.
</li><li> Go back to Mobile network.
</li><li> Add the first APN with the following parameters:
<ul>
<li> Name = Internet
</li><li> APN = internet
</li><li> APN type = default
</li></ul>
</li><li> Save it and select it.
</li><li> Add second APN with following parameters:
<ul>
<li> Name = IMS
</li><li> APN = ims
</li><li> APN type = ims
</li></ul>
</li><li> Save it and do not select it (This APN may not be displayed).
</li><li> Reboot your phone
</li></ul>
<span id="Configuration-reference"></span><h2 class="chapter">5 Configuration reference</h2>
<span id="Configuration-file-syntax"></span><h3 class="section">5.1 Configuration file syntax</h3>
<p>The main configuration file uses a syntax very similar to the
Javascript Object Notation (JSON) with few extensions.
</p>
<ol>
<li> Supported types:
<ul class="no-bullet">
<li>- Numbers (64 bit floating point). Notation: <code>13.4</code>
</li><li>- Complex numbers. Notation: <code>1.2+3*I</code>
</li><li>- Strings. Notation: <code> "string" </code>
</li><li>- Booleans. Notation: <code>true</code> or <code>false</code>.
</li><li>- Objects. Notation: <code> { field1: <var>value1</var>, field2: <var>value2</var>, .... } </code>
</li><li>- Arrays. Notation: <code> [ <var>value1</var>, <var>value2</var>, .... ] </code>
</li></ul>
</li><li> The basic operations <code>+</code>, <code>-</code>, <code>*</code> and <code>/</code> are
supported with numbers and complex numbers. <code>+</code> also concatenates
strings. The operators <code>!</code>, <code>||</code>, <code>&&</code>, <code>==</code>,
<code>!=</code>, <code><</code>, <code><=</code>, <code>>=</code>, <code>></code> are supported too.
</li><li> The numbers <code>0</code> and <code>1</code> are accepted as synonyms for the
boolean values <code>false</code> and <code>true</code>.
</li><li> {} at top level are optional.
</li><li> " for property names are optional, unless the name starts with a number.
</li><li> Properties can be duplicated.<br>
If properties are duplicated, they will be merged following <a href="#JSON-merge-rules">JSON merge rules</a> with overriding
occuring in reading direction (last overrides previous).<br>
Ex:
<pre class="verbatim">{
value: "foo",
value: "bar",
sub: {
value: "foo"
},
sub: {
value: "bar"
}
}
</pre><p>Will be equivalent to:
</p><pre class="verbatim">{
value: "bar",
sub: {
value: "bar"
}
}
</pre>
</li><li> Files can be included using <var>include</var> keyword (must not be quoted) followed by a string (without :) representing the file to include (path is relative to current file) and terminating by a comma.<br>
Arrays can’t be included.<br>
Merge will be done as for duplicate properties.<br>
If <var>file1.cfg</var> is:
<pre class="verbatim"> value: "foo",
include "file2.cfg",
foo: "foo"
</pre><p>And <var>file2.cfg</var> is:
</p><pre class="verbatim"> value: "bar",
foo: "bar"
</pre><p>Final config will be:
</p><pre class="verbatim">{
value: "bar",
foo: "foo"
}
</pre>
</li><li> A C like preprocessor is supported. The following preprocessor commands are available:
<dl compact="compact">
<dt><code>#define <var>var</var> <var>expr</var></code></dt>
<dd><p>Define a new variable with value <var>expr</var>. <var>expr</var> must be a
valid JSON expression. Note that unlike the standard C preprocessor,
<var>expr</var> is evaluated by the preprocessor.
</p></dd>
<dt><code>#undef <var>var</var></code></dt>
<dd><p>Undefine the variable <var>var</var>.
</p></dd>
<dt><code>#include <var>expr</var></code></dt>
<dd><p>Include the file whose filename is the evaluation of the string
expression <var>expr</var>.
</p></dd>
<dt><code>#if <var>expr</var></code></dt>
<dd><p>Consider the following text if <var>expr</var> is true.
</p></dd>
<dt><code>#else</code></dt>
<dd><p>Alternative of <code>#if</code> block.
</p></dd>
<dt><code>#elif</code></dt>
<dd><p>Composition of <code>#else</code> and <code>#if</code>.
</p></dd>
<dt><code>#endif</code></dt>
<dd><p>End of <code>#if</code> block.
</p></dd>
<dt><code>#ifdef <var>var</var></code></dt>
<dd><p>Shortcut for <code>#if defined(var)</code>
</p></dd>
<dt><code>#ifndef <var>var</var></code></dt>
<dd><p>Shortcut for <code>#if !defined(var)</code>
</p></dd>
</dl>
<p>In the JSON source, every occurrence of a defined preprocessor
variable is replaced by its value.
</p>
</li><li> Backquote strings: JSON expression can be inserted in backquote delimited strings with the <code>${expr}</code> syntax. Example: <code>`abc${1+2}d`</code> is evaluated as the string <code>"abc3d"</code>. Preprocessor variables can be used inside the expression. Backquote strings may span several lines.
</li></ol>
<span id="JSON-merge-rules"></span><span id="JSON-merge-rules-1"></span><h4 class="subsection">5.1.1 JSON merge rules</h4>
<p>Merge overriding direction depends on context, i.e source may override destination or the opposite.<br>
JSON merge is recursive for Objects and Arrays.<br>
</p>
<p>Example, merging
</p><pre class="verbatim">{
foo: { value: "bar" },
same: "one",
one: 1
}
</pre><p>with
</p><pre class="verbatim">{
foo: { value: "none", second: true },
same: "two",
two: 1
}
</pre>
<p>Will become:
</p><pre class="verbatim">{
foo: { value: "bar", second: true },
same: "one",
one: 1
two: 1
}
</pre><p>assuming first object overrides second one.<br>
</p>
<p>In case of Array merging, the final array length will be the maximum length of all merged arrays.<br>
For each element of the final array, merge will be done considering defined elements only.<br>
Ex:
</p><pre class="verbatim">{
array: [0, 1, 2, { foo: "bar" } ],
array: [3, 4],
array: [5, 6, 7, { bar: "foo" }, 8 ]
}
</pre><p>Will be merged to:
</p><pre class="verbatim">{
array: [5, 6, 7, { foo: "bar", bar: "foo" }, 8 ],
}
</pre>
<span id="Properties"></span><h3 class="section">5.2 Properties</h3>
<!-- prop: -->
<dl compact="compact">
<dt><code>log_filename</code></dt>
<dd>
<p>String. Set the log filename. If no leading <code>/</code>, it is relative to the
configuration file path. See <a href="#Log-file-format">Log file format</a>.
</p>
<span id="log_005foptions"></span></dd>
<dt><code>log_options</code></dt>
<dd>
<p>String. Set the logging options as a comma separated list of assignments.
</p>
<ul>
<li> <var>layer</var>.level=<var>verbosity</var>. For each layer, the log verbosity can be set
to <code>none</code>, <code>error</code>, <code>info</code> or <code>debug</code>. In debug
level, the content of the transmitted data is logged.
</li><li> <var>layer</var>.max_size=<var>n</var>. When dumping data content, at
most <code>n</code> bytes are shown in hexa. For ASN.1, NAS or Diameter content, show the full content of the message if <code>n > 0</code>.
</li><li> <var>layer</var>.payload=[0|1]. Dump ASN.1, NAS, SGsAP or Diameter payload in hexadecimal.
</li><li> <var>layer</var>.key=[0|1]. Dump security keys (NAS and RRC layers).
</li><li> <var>layer</var>.crypto=[0|1]. Dump plain and ciphered data (NAS and PCDP layers).
</li><li> <var>layer</var>.verbose=[0|1]. If <code>layer</code> is <code>ipsec</code>, dump all packets filtering informations.
</li><li> time=[sec|short|full]. Display the time as seconds, time only
or full date and time (default = time only).
</li><li> time.us=[0|1]. Dump time with microseconds precision.
</li><li> file=cut. Close current file log and open a new one.
</li><li> file.rotate=now. Rename current log with timestamp and open new one.
</li><li> file.rotate=<var>size</var>. Rename current log every time it reaches <var>size</var> bytes open new one.
Size is an integer and can be followed by K, M or G.
</li><li> file.path=<var>path</var>. When log rotation is enabled, move current log to this path instead of
initial log path.
</li><li> append=[0|1]. (default=0). If 0, truncate the log file when
opening it. Otherwise, append to it.
</li></ul>
<p>Available layers are: <code>ims</code>, <code>sip</code>, <code>media</code>, <code>rx</code>, <code>cx</code>, <code>n5</code>
</p>
</dd>
<dt><code>log_sync</code></dt>
<dd><p>Optional boolean (default = false). If true, logs will be synchronously dumped to file.<br>
Warning, this may lead to performances decrease.
</p>
</dd>
<dt><code>sip_addr</code></dt>
<dd><p>Array. Each item is an object representing a SIP server socket defined as follow:<br>
</p><dl compact="compact">
<dt><code>addr</code></dt>
<dd><p>String. Set the IP address (and an optional port) on which IMS server will
listen for SIP packets. The default port is 5060.
</p>
</dd>
<dt><code>bind_addr</code></dt>
<dd><p>Optional string. Defines network interface on which IMS will listen.<br>
If not specified, the addr parameter is used.
</p>
</dd>
<dt><code>port_min</code></dt>
<dd><p>Optional integer (Default is 10000). Defines lower bound of UDP media socket.
</p>
</dd>
<dt><code>port_max</code></dt>
<dd><p>Optional integer (Default is 20000). Defines upper bound of UDP media socket.
</p>
</dd>
</dl>
<p>NB:
</p><ul>
<li> SIP socket object can be represented by a simple string. Thus, it will
represent <code>addr</code> parameter and all other parameters will use default value.
</li><li> For legacy, <code>sip_addr</code> can be a single SIP socket (Object or String)
instead of an Array.
</li></ul>
</dd>
<dt><code>sctp_addr</code></dt>
<dd><p>String. Set the IP address (and an optional port) for MME connection.<br>
This is only necessary for SMS over SG feature.
</p>
</dd>
<dt><code>cx_server_addr</code></dt>
<dd><p>String. Set the IP address (and optional port) of Cx SCTP
connection to the HSS. The default port is 3868.
</p>
</dd>
<dt><code>cx_bind_addr</code></dt>
<dd><p>Optional string. IP address and optional port on which the Cx SCTP
connection is bound. If not set, <code>sctp_addr</code> is used.
</p>
</dd>
<dt><code>cx_origin_realm</code></dt>
<dd><p>Optional string. Defines the string sent in the Origin-Realm AVP for
Cx messages. Default is set to <code>amarisoft.com</code>.
</p>
</dd>
<dt><code>cx_origin_host</code></dt>
<dd><p>Optional string. Defines the string sent in the Origin-Host AVP for
Cx messages. Default is set to <code>ims.amarisoft.com</code>.
</p>
</dd>
<dt><code>cx_watchdog_duration</code></dt>
<dd><p>Optional integer (range 0 to 36000000, default = 0). Tw watchdog timer in
milliseconds to send the Diameter Device Watchdog Request message.
The value 0 deactives the watchdog.
</p>
</dd>
<dt><code>rx_server_addr</code></dt>
<dd><p>Optional string. Set the IP address (and optional port) of Rx SCTP
connection to the MME. The default port is 3868. If not set,
<code>cx_server_addr</code> is used.
</p>
</dd>
<dt><code>rx_bind_addr</code></dt>
<dd><p>Optional string. IP address and optional port on which the Rx SCTP
connection is bound. If not set, <code>cx_bind_addr</code> is used.
</p>
</dd>
<dt><code>rx_origin_realm</code></dt>
<dd><p>Optional string. Defines the string sent in the Origin-Realm AVP for
Rx messages. Default is set to <code>amarisoft.com</code>.
</p>
</dd>
<dt><code>rx_origin_host</code></dt>
<dd><p>Optional string. Defines the string sent in the Origin-Host AVP for
Rx messages. Default is set to <code>ims.amarisoft.com</code>.
</p>
</dd>
<dt><code>rx_watchdog_duration</code></dt>
<dd><p>Optional integer (range 0 to 36000000, default = 0). Tw watchdog timer in
milliseconds to send the Diameter Device Watchdog Request message.
The value 0 deactives the watchdog.
</p>
</dd>
<dt><code>use_n5</code></dt>
<dd><p>Optional boolean (default = false). If set, the N5 interface is used instead of the Rx interface.
</p>
</dd>
<dt><code>n5</code></dt>
<dd><p>Optional object used to configure the N5 interface with the PCF.
</p><dl compact="compact">
<dt><code>api_root</code></dt>
<dd><p>String. apiRoot as defined in 3GPP TS 29.501: <scheme>://<host>:<port>, where <scheme> is "http" or "https".
</p></dd>
<dt><code>transaction_timeout</code></dt>
<dd><p>Optional integer (range 1 to 15000, default = 4000). Defines the timeout in
milliseconds for a transaction with the PCF.
</p></dd>
<dt><code>bind_addr</code></dt>
<dd><p>Optional string. IP address and optional port on which the N5 TCP
connection is bound. If not set, <code>cx_bind_addr</code> is used.
</p></dd>
</dl>
</dd>
<dt><code>domain</code></dt>
<dd><p>String. Global SIP domain used for IMPU and authentication. May be overriden at user level.<br>
This parameter is not used to recover IMPU.
</p>
<span id="tcp_005fthreshold"></span></dd>
<dt><code>tcp_threshold</code></dt>
<dd><p>Optional integer (default = 1300). Set packet threshold in bytes to use TCP instead of UDP.
</p>
<span id="tcp_005fkeepalive"></span></dd>
<dt><code>tcp_keepalive</code></dt>
<dd><p>Optional integer (default = 900). Time in seconds before sending keepalive on TCP connections. 0 means disabling keepalive.
</p>
<span id="tcp_005fkeepcount"></span></dd>
<dt><code>tcp_keepcount</code></dt>
<dd><p>Optional integer (default = 2). Number of TCP keepalive failure before releasing socket.
</p>
<span id="session_005fexpires"></span></dd>
<dt><code>session_expires</code></dt>
<dd><p>Optional object. Defines session timer configuration.<br>
Parameters are the following:
</p><dl compact="compact">
<dt><code>duration</code></dt>
<dd><p>Optional integer (default = 1800). Session duration in seconds.
</p></dd>
<dt><code>min</code></dt>
<dd><p>Optional interger (default = 90). Minimum allowed session expires.
</p></dd>
<dt><code>refresher</code></dt>
<dd><p>Optional string (default = uac). Defines session refresher when it is up to the IMS to take this decision.
</p></dd>
<dt><code>method</code></dt>
<dd><p>Optional string (default = update). Defines SIP method to use for session refresh when IMS is the refresher.
</p></dd>
<dt><code>force</code></dt>
<dd><p>Optional boolean (default = true). If set to true, forces the refresher in IMS request with the <code>refresher</code> value.
</p></dd>
</dl>
<p>For legacy purpose, <code>session_expires</code> can be an integer. If so, only <code>duration</code> is set and other
parameters are kept to their default value.
</p>
</dd>
<dt><code>100rel</code></dt>
<dd><p>Optional Boolean (default = true). Enable/disable 100rel support.
</p>
<span id="precondition"></span></dd>
<dt><code>precondition</code></dt>
<dd><p>Optional string (default = on). Values can be "on", "off" or "silent".<br>
On: IMS will handled QoS according to the standard.<br>
Off: no precondition and no dedicated bearer establishment.<br>
Silent: dedicated bearers will be established regardless the SIP and SDP content.<br>
Note that a Rx connection is necessary to allow dedicated bearer establishment.
</p>
<span id="p_005fcalled_005fparty_005fid"></span></dd>
<dt><code>p_called_party_id</code></dt>
<dd><p>Optional boolean (default is false). Enable P-Called-Party-ID header for INVITE and MESSAGE requests.
</p>
</dd>
<dt><code>ipsec</code></dt>
<dd><p>Optional boolean (default is true). Enable/disable support of ipsec.<br>
</p>
</dd>
<dt><code>ipsec_aalg_list</code></dt>
<dd><p>Array of strings. Each string represent IPsec authentication algorithm supported by IMS.<br>
"null" may be used to indicate no authentication.<br>
Supported algorithms are:
</p><ul>
<li> hmac-md5-96
</li><li> hmac-md5-128
</li><li> hmac-sha-1-96
</li><li> hmac-sha-1-160
</li><li> aes-cmac-96
</li><li> aes-gmac
</li></ul>
</dd>
<dt><code>ipsec_ealg_list</code></dt>
<dd><p>Array of strings. Each string represent IPsec encryption algorithm supported by IMS.<br>
"null" may be used to indicate no encryption.<br>
Supported algorithms are:
</p><ul>
<li> aes-cbc
</li><li> des-cbc
</li><li> des-ede3-cbc
</li><li> blowfish
</li><li> aes-ctr
</li><li> aes-gcm
</li></ul>
</dd>
<dt><code>ipsec_mtu</code></dt>
<dd><p>Optional integer (range 68 to 65535, default = 1400). MTU for IPsec network interface.
</p>
</dd>
<dt><code>ipsec_ifname</code></dt>
<dd><p>Optional string. If set, use this interface for IPsec. In that case, <code>ipsec_netns</code> must be
set and interface must be added to the network namepsace.<br>
In this mode, used to run lteims with non root privileges, it is up to the user to configure
the tun interface.<br>
In particular:
</p><ul>
<li> Add tun interface to specififed network namespace
</li><li> Add <code>sip_addr</code> IP addresses to the interface
</li><li> Set MTU (<code>ipsec_mtu</code> will be ignored)
</li><li> Set routes
</li><li> Set CAP_SYS_ADMIN and CAP_NET_RAW capabilities to <var>PROG</var>
</li></ul>
<p>Ex:
</p><pre class="verbatim">setcap cap_sys_admin,cap_net_raw=ep lteims
ip tuntap add mode tun <ifname>
ip link set dev <ifname> name <ifname> netns <netns>
ip netns exec $netns ip addr add 192.168.4.1/0 dev <ifname>
ip netns exec $netns ip addr add 192.168.0.103/0 dev <ifname>
ip netns exec $netns ip link set <ifname> up mtu 1400
ip netns exec $netns ip route add default dev <ifname>
</pre>
</dd>
<dt><code>ipsec_netns</code></dt>
<dd><p>Optional string. Must be set if <code>ipsec_ifname</code> is set. Defines network namespace name
used for ipsec.
</p>
<span id="dialog_005ftimeout"></span></dd>
<dt><code>dialog_timeout</code></dt>
<dd><p>Optional integer (default = 30). Time in seconds of call session. Stop call if no
activity has been detected during this time.
</p>
<span id="auth_005fon_005fregister_005fonly"></span></dd>
<dt><code>auth_on_register_only</code></dt>
<dd><p>Optional boolean (default = true). If true, don’t try to authenticate other request than
register (unless expires is set to 0).
</p>
</dd>
<dt><code>trunk</code></dt>
<dd><p>Optional object. If set, IMS will accept incoming calls from a SIP trunk and will forward
unknown calls to SIP trunk (<a href="https://tech-academy.amarisoft.com/how_to_run_volte_call_using_a_sip_trunk.wiki">https://tech-academy.amarisoft.com/how_to_run_volte_call_using_a_sip_trunk.wiki</a>).<br>
SIP trunk must accept non authenticated requests.
Parameters are the following:
</p><dl compact="compact">
<dt><code>addr</code></dt>
<dd><p>String. IP address of the SIP trunk.
</p></dd>
<dt><code>name</code></dt>
<dd><p>String. SIP trunk account user name.
</p></dd>
<dt><code>domain</code></dt>
<dd><p>Optional string (default = same as <code>addr</code>). If set, use this for SIP uri domain.
</p></dd>
<dt><code>tcp_threshold</code></dt>
<dd><p>Optional integer (default = 0). If > 0, will override global <code>tcp_threshold</code> parameter.
</p></dd>
</dl>
</dd>
<dt><code>com_addr</code></dt>
<dd><p>Optional string. Address of the WebSocket server remote API. See <a href="#Remote-API">Remote API</a>.<br>
If set, the WebSocket server for remote API will be enabled and bound to this address.<br>
Default port is 9003.<br>
Setting IP address to [::] will make remote API reachable through all network interfaces.
</p>
</dd>
<dt><code>com_name</code></dt>
<dd><p>Optional string. Sets server name. IMS by default
</p>
</dd>
<dt><code>com_ssl_certificate</code></dt>
<dd><p>Optional string. If set, forces SSL for WebSockets. Defines CA
certificate filename.
</p>
</dd>
<dt><code>com_ssl_key</code></dt>
<dd><p>Optional string. Mandatory if <var>com_ssl_certificate</var> is set. Defines CA
private key filename.
</p>
</dd>
<dt><code>com_ssl_peer_verify</code></dt>
<dd><p>Optional boolean (default is false). If <var>true</var>, server will check
client certificate.
</p>
</dd>
<dt><code>com_ssl_ca</code></dt>
<dd><p>Optional string. Set CA certificate. In case of peer verification with self signed
certificate, you should use the client certificate.
</p>
</dd>
<dt><code>com_log_lock</code></dt>
<dd><p>Optional boolean (default is false). If <var>true</var>, logs configuration can’t be changed
via <code>config_set</code> remote API.
</p>
</dd>
<dt><code>com_log_us</code></dt>
<dd><p>Optional boolean (default is false). If <var>true</var>, logs sent by <code>log_get</code> remote API
response will have a <code>timestamp_us</code> parameters instead of <code>timestamp</code>
</p>
</dd>
<dt><code>com_auth</code></dt>
<dd><p>Optional object. If set, remote API access will require authentication.<br>
Authentication mechanism is describe in <a href="#Remote-API-Startup">Remote API Startup</a> section.<br>
</p>
<dl compact="compact">
<dt><code>passfile</code></dt>
<dd><p>Optional string. Defines filename where password is stored (plaintext).<br>
If not set, <code>password</code> must be set
</p>
</dd>
<dt><code>password</code></dt>
<dd><p>Optional string. Defines password.<br>
If not set, <code>passfile</code> must be set.
</p>
</dd>
<dt><code>unsecure</code></dt>
<dd><p>Optional boolean (default false). If set, allow password to be sent plaintext.<br>
NB: you should set it to true if you access it from a Web Browser (Ex: Amarisoft GUI)
without SSL (https) as your Web Browser may prevent secure access to work.
</p>
</dd>
</dl>
</dd>
<dt><code>com_log_count</code></dt>
<dd><p>Optional number (Default = 8192). Defines number of logs to keep in memory before dropping them.<br>
Must be between 4096 and 2097152).
</p>
<span id="sim_005fevents"></span></dd>
<dt><code>sim_events</code></dt>
<dd><p>Array of object. Each element gives an event configuration to execute for
this UE.<br>
Event configuration is exactly the same as for <a href="#Remote-API">Remote API</a> messages
except that message field must be event.
</p>
</dd>
<dt><code>sim_events_loop_count</code></dt>
<dd><p>If set, will define <code>loop_count</code> for each event of <code>sim_events</code>, See <a href="#loop_005fcount">loop_count</a>.
</p>
</dd>
<dt><code>sim_events_loop_delay</code></dt>
<dd><p>If set, will define <code>loop_delay</code> for each event of <code>sim_events</code>, See <a href="#loop_005fdelay">loop_delay</a>.
</p>
</dd>
<dt><code>license_server</code></dt>
<dd><p>Configuration of the Amarisoft license server to use.<br>
Object with following properties:
</p>
<dl compact="compact">
<dt><code>server_addr</code></dt>
<dd><p>String. IP address of the license server.
</p></dd>
<dt><code>name</code></dt>
<dd><p>Optional string. Text to be displayed inside server monitor or remote API.
</p></dd>
<dt><code>tag</code></dt>
<dd><p>Optional string. If set, server will only allow license with same tag.
</p></dd>
</dl>
<p>Example:
</p><pre class="verbatim">license_server: {
server_addr: "192.168.0.20",
name: "My license"
}
</pre>
<span id="sms_005fexpires"></span></dd>
<dt><code>sms_expires</code></dt>
<dd><p>Integer (default = 86400). Delay in seconds before SMS is removed from database. If a MO
SMS contains the TP-Validity-Period field, it will be used instead of <code>sms_expires</code>.
</p>
<span id="sms_005fhook_005fonly"></span></dd>
<dt><code>sms_hook_only</code></dt>
<dd><p>Optional boolean (default = false). If set, when SMS is received and at least one
WebSocket client has registered to <code>sms</code> event, don’t process SMS internally
(Only CP/RP layer will be handled).
</p>
<span id="binding_005fexpires"></span></dd>
<dt><code>binding_expires</code></dt>
<dd><p>Integer (default = 3600, max = 864000). Default duration in seconds for registration.
</p>
<span id="subscribe_005fexpires"></span></dd>
<dt><code>subscribe_expires</code></dt>
<dd><p>Integer (default = 0, max = 864000). Subscription expiration. If set to 0, use value sent by UE.
</p>
</dd>
<dt><code>user_agent</code></dt>
<dd><p>Optional string (default = Amarisoft-IMS-2024-12-13). SIP user agent.
</p>
</dd>
<dt><code>force_user_agent</code></dt>
<dd><p>Boolean (default = true). If true, IMS user-agent will always be used, else remote peer’s one
will be used.
</p>
</dd>
<dt><code>path</code></dt>
<dd><p>Optional string (default = sip:ims.mnc001.mcc001.3gppnetwork.org).
SIP path. If registration supports <code>path</code>, defines content of the <code>Path</code> header in
registration response. If set to an empty string, <code>Path</code> header won’t be set.
</p>
</dd>
<dt><code>timer_t1</code></dt>
<dd><p>Optional number (default = 2). SIP T1 timer duration in seconds.
</p>
</dd>
<dt><code>timer_t2</code></dt>
<dd><p>Optional number (default = 16). SIP T2 timer duration in seconds.
</p>
</dd>
<dt><code>timer_t4</code></dt>
<dd><p>Optional number (default = 17). SIP T4 timer duration in seconds.
</p>
<span id="custom_005fheaders"></span></dd>
<dt><code>custom_headers</code></dt>
<dd><p>Array of object. Each object represents a custom header to add to requests and/or responses,
defined as follows:
</p><dl compact="compact">
<dt><code>name</code></dt>
<dd><p>Header name
</p>
</dd>
<dt><code>value</code></dt>
<dd><p>Header value
</p>
</dd>
<dt><code>codes</code></dt>
<dd><p>Number or array of numbers of the SIP responses on which to apply custom headers.<br>
<code>0</code> can be used for all codes.
</p>
</dd>
<dt><code>methods</code></dt>
<dd><p>String or array of strings of the SIP method on which to apply custom headers.<br>
<code>*</code> can be used for all methods.<br>
If <code>codes</code> is set, the custom headers will be applied to the responses of
the associated request.
</p>
</dd>
<dt><code>replace</code></dt>
<dd><p>Optional boolean (default = false). If set, allow only one occurence of the header.
</p>
</dd>
</dl>
</dd>
<dt><code>sms_centre_address</code></dt>
<dd><p>Optional object used to configure the SMS centre address.
Contains the following parameters:
</p><dl compact="compact">
<dt><code>type_of_number</code></dt>
<dd><p>Optional enumeration "unknown", "international", "national" (default = "unknown").
SMS centre address type of number.
</p></dd>
<dt><code>numbering_plan</code></dt>
<dd><p>Optional enumeration "unknown", "national", "private" (default = "unknown").
SMS centre address numbering plan identification.
</p></dd>