From 9ee0bd917f1e6a2b1fc9f116ea22584388a5e0d8 Mon Sep 17 00:00:00 2001 From: Victor Seva Date: Tue, 15 Dec 2015 10:24:13 +0100 Subject: [PATCH] modules/cfgt: add initial documentation --- modules/cfgt/README | 126 +++++++++++++++++++++++++ modules/cfgt/doc/Makefile | 4 + modules/cfgt/doc/cfgt.xml | 36 ++++++++ modules/cfgt/doc/cfgt_admin.xml | 158 ++++++++++++++++++++++++++++++++ 4 files changed, 324 insertions(+) create mode 100644 modules/cfgt/README create mode 100644 modules/cfgt/doc/Makefile create mode 100644 modules/cfgt/doc/cfgt.xml create mode 100644 modules/cfgt/doc/cfgt_admin.xml diff --git a/modules/cfgt/README b/modules/cfgt/README new file mode 100644 index 00000000000..a3be5ffac22 --- /dev/null +++ b/modules/cfgt/README @@ -0,0 +1,126 @@ +cfgt Module + +Victor Seva + + sipwise.com + +Edited by + +Victor Seva + + + + Copyright © 2015 Victor Seva (sipwise.com) + __________________________________________________________________ + + Table of Contents + + 1. Admin Guide + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + + 3.1. basedir (string) + 3.2. mask (int) + 3.3. callid_prefix (string) + + List of Examples + + 1.1. Set cfgtrace parameter + 1.2. Set mask parameter + 1.3. Set callid_prefix parameter + +Chapter 1. Admin Guide + + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + + 3.1. basedir (string) + 3.2. mask (int) + 3.3. callid_prefix (string) + +1. Overview + + This module provides a report of the way Kamailio SIP Server Platform + configuration has been executed as part of a unit test for different + SIP scenarios. + + In order to identify defferent scenarios a prefix string should be used + at Call-ID header. + +2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + +2.1. Kamailio Modules + + The following modules must be loaded before this module: + * None. + +2.2. External Libraries or Applications + + The following libraries or applications must be installed before + running Kamailio with this module loaded: + * None. + +3. Parameters + + 3.1. basedir (string) + 3.2. mask (int) + 3.3. callid_prefix (string) + +3.1. basedir (string) + + Control where the config reports should be stored. The dir must exists + and Kamailio SIP Server Platform must have perms to write on it. + + Default value is "/tmp". + + Example 1.1. Set cfgtrace parameter +... +modparam("cfgt", "basedir", "/var/run/kamailio/cfgtest") +... + +3.2. mask (int) + + mask - Control the type of vars it should display in the report: + * 1 - dump null values + * 2 - dump avp vars + * 4 - dump script vars + * 8 - dump xavp vars + * 16 - dump DP_OTHER vars + * 32 - dump ALL vars + + Default value is "32" (ALL). + + Example 1.2. Set mask parameter +... +# dump xavp(8) and avp(4) vars +modparam("cfgt", "mask", 12) +... + +3.3. callid_prefix (string) + + Prefix used to indentify test scenario messages. Last char of the + string will be used as delimiter. + + Default value is "NGCP%" (using "%" as delimiter). + + Example 1.3. Set callid_prefix parameter +... +# using '%' as delimiter +modparam("cfgt", "callid_prefix", "TEST-ID%") +... diff --git a/modules/cfgt/doc/Makefile b/modules/cfgt/doc/Makefile new file mode 100644 index 00000000000..5ff9aaec00f --- /dev/null +++ b/modules/cfgt/doc/Makefile @@ -0,0 +1,4 @@ +docs = cfgt.xml + +docbook_dir = ../../../docbook +include $(docbook_dir)/Makefile.module diff --git a/modules/cfgt/doc/cfgt.xml b/modules/cfgt/doc/cfgt.xml new file mode 100644 index 00000000000..dbbdbb8952c --- /dev/null +++ b/modules/cfgt/doc/cfgt.xml @@ -0,0 +1,36 @@ + + + +%docentities; + +]> + + + + cfgt Module + &kamailioname; + + + Victor + Seva + sipwise.com + + + Victor + Seva + linuxmaniac@torreviejawireless.org + + + + 2015 + Victor Seva (sipwise.com) + + + + + + + diff --git a/modules/cfgt/doc/cfgt_admin.xml b/modules/cfgt/doc/cfgt_admin.xml new file mode 100644 index 00000000000..07b8ea4f66f --- /dev/null +++ b/modules/cfgt/doc/cfgt_admin.xml @@ -0,0 +1,158 @@ + + + +%docentities; + +]> + + + + + + &adminguide; + +
+ Overview + + This module provides a report of the way &kamailioname; configuration + has been executed as part of a unit test for different + SIP scenarios. + + + In order to identify defferent scenarios a prefix string should be + used at Call-ID header. + +
+
+ Dependencies +
+ &kamailio; Modules + + The following modules must be loaded before this module: + + + + None. + + + + +
+
+ External Libraries or Applications + + The following libraries or applications must be installed before running + &kamailio; with this module loaded: + + + + None. + + + + +
+
+
+ Parameters +
+ <varname>basedir</varname> (string) + + Control where the config reports should be stored. The dir must + exists and &kamailioname; must have perms to write on it. + + + + Default value is /tmp. + + + + Set <varname>cfgtrace</varname> parameter + +... +modparam("cfgt", "basedir", "/var/run/kamailio/cfgtest") +... + + +
+ +
+ <varname>mask</varname> (int) + + mask - Control the type of vars it should + display in the report: + + + + 1 - dump null values + + + 2 - dump avp vars + + + 4 - dump script vars + + + 8 - dump xavp vars + + + 16 - dump DP_OTHER vars + + + 32 - dump ALL vars + + + + + + Default value is 32 (ALL). + + + + Set <varname>mask</varname> parameter + +... +# dump xavp(8) and avp(4) vars +modparam("cfgt", "mask", 12) +... + + +
+ +
+ <varname>callid_prefix</varname> (string) + + Prefix used to indentify test scenario messages. Last char of the + string will be used as delimiter. + + + + Default value is NGCP% + (using % as delimiter). + + + + Set <varname>callid_prefix</varname> parameter + +... +# using '%' as delimiter +modparam("cfgt", "callid_prefix", "TEST-ID%") +... + + +
+ +
+ + +