modules: readme files regenerated - acc ... [skip ci]
[sip-router] / src / modules / ims_ipsec_pcscf / README
index 06125e2..32bb2d6 100644 (file)
@@ -24,11 +24,11 @@ Tsvetomir Dimitrov
 
    <tsv.dimitrov@gmail.com>
 
-   Copyright © 2007 FhG FOKUS
+   Copyright Â© 2007 FhG FOKUS
 
-   Copyright © 2012 Smile Communications
+   Copyright Â© 2012 Smile Communications
 
-   Copyright © 2015 ng-voice GmbH
+   Copyright Â© 2015 ng-voice GmbH
      __________________________________________________________________
 
    Table of Contents
@@ -47,8 +47,9 @@ Tsvetomir Dimitrov
               3.2. ipsec_listen_addr6 (string)
               3.3. ipsec_client_port (int)
               3.4. ipsec_server_port (int)
-              3.5. ipsec_spi_id_start (int)
-              3.6. ipsec_spi_id_range (int)
+              3.5. ipsec_max_connections (int)
+              3.6. ipsec_spi_id_start (int)
+              3.7. ipsec_spi_id_range (int)
 
         4. Functions
 
@@ -62,11 +63,12 @@ Tsvetomir Dimitrov
    1.2. ipsec_listen_addr6 parameter usage
    1.3. ipsec_client_port parameter usage
    1.4. ipsec_server_port parameter usage
-   1.5. ipsec_spi_id_start parameter usage
-   1.6. ipsec_spi_id_range parameter usage
-   1.7. ipsec_create
-   1.8. ipsec_forward
+   1.5. ipsec_max_connections parameter usage
+   1.6. ipsec_spi_id_start parameter usage
+   1.7. ipsec_spi_id_range parameter usage
+   1.8. ipsec_create
    1.9. ipsec_forward
+   1.10. ipsec_destroy
 
 Chapter 1. Admin Guide
 
@@ -84,8 +86,9 @@ Chapter 1. Admin Guide
         3.2. ipsec_listen_addr6 (string)
         3.3. ipsec_client_port (int)
         3.4. ipsec_server_port (int)
-        3.5. ipsec_spi_id_start (int)
-        3.6. ipsec_spi_id_range (int)
+        3.5. ipsec_max_connections (int)
+        3.6. ipsec_spi_id_start (int)
+        3.7. ipsec_spi_id_range (int)
 
    4. Functions
 
@@ -120,8 +123,9 @@ Chapter 1. Admin Guide
    3.2. ipsec_listen_addr6 (string)
    3.3. ipsec_client_port (int)
    3.4. ipsec_server_port (int)
-   3.5. ipsec_spi_id_start (int)
-   3.6. ipsec_spi_id_range (int)
+   3.5. ipsec_max_connections (int)
+   3.6. ipsec_spi_id_start (int)
+   3.7. ipsec_spi_id_range (int)
 
 3.1. ipsec_listen_addr (string)
 
@@ -151,9 +155,10 @@ modparam("ims_ipsec_pcscf", "ipsec_listen_addr6", "")
 
 3.3. ipsec_client_port (int)
 
-   Port number which will be bound for incoming (server) IPSec traffic.
+   Start port number which will be bound for incoming (server) IPSec
+   traffic.
 
-   Default value is 5963.
+   Default value is 5062.
 
    Example 1.3. ipsec_client_port parameter usage
 ...
@@ -162,7 +167,8 @@ modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
 
 3.4. ipsec_server_port (int)
 
-   Port number which will be bound for incoming (server) IPSec traffic.
+   Start port number which will be bound for incoming (server) IPSec
+   traffic.
 
    Default value is 5063.
 
@@ -171,7 +177,22 @@ modparam("ims_ipsec_pcscf", "ipsec_client_port", 5062)
 modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
 ...
 
-3.5. ipsec_spi_id_start (int)
+3.5. ipsec_max_connections (int)
+
+   Maximum IPSec connections for the process. E.g. if
+   ipsec_client_port=5100, ipsec_server_port=6100 and
+   ipsec_max_connections=10, all client ports between 5100 and 5109 and
+   all server ports between 6100 and 6109 will be used for maximum to 10
+   IPSec connections.
+
+   Default value is 2.
+
+   Example 1.5. ipsec_max_connections parameter usage
+...
+modparam("ims_ipsec_pcscf", "ipsec_max_connections", 10)
+...
+
+3.6. ipsec_spi_id_start (int)
 
    Each IPSec tunnel has a unique system-wide identifier. This and the
    following option allows to tune the SPIs used by Kamailio in order to
@@ -180,12 +201,12 @@ modparam("ims_ipsec_pcscf", "ipsec_server_port", 5063)
 
    Default value is 100.
 
-   Example 1.5. ipsec_spi_id_start parameter usage
+   Example 1.6. ipsec_spi_id_start parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
 ...
 
-3.6. ipsec_spi_id_range (int)
+3.7. ipsec_spi_id_range (int)
 
    How many SPIs to be allocated for the process. E.g. if
    ipsec_spi_id_start = 100 and ipsec_spi_id_range = 1000, SPIs between
@@ -193,7 +214,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_start", 100)
 
    Default value is 1000.
 
-   Example 1.6. ipsec_spi_id_range parameter usage
+   Example 1.7. ipsec_spi_id_range parameter usage
 ...
 modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
 ...
@@ -215,7 +236,7 @@ modparam("ims_ipsec_pcscf", "ipsec_spi_id_range", 1000)
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.7. ipsec_create
+   Example 1.8. ipsec_create
 ...
 ipsec_create("location");
 ...
@@ -229,7 +250,7 @@ ipsec_create("location");
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.8. ipsec_forward
+   Example 1.9. ipsec_forward
 ...
 ipsec_forward("location");
 ...
@@ -242,7 +263,7 @@ ipsec_forward("location");
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.9. ipsec_forward
+   Example 1.10. ipsec_destroy
 ...
 ipsec_destroy("location");
 ...