README
1IMS Usrloc PCSCF Module
2
3Jason Penton
4
5 Smile Communications
6
7Edited by
8
9Richard Good
10
11 Smile Communications
12
13Carsten Bock
14
15 ng-voice GmbH
16
17 Copyright © 2012 Smile Communications
18 __________________________________________________________________
19
20 Table of Contents
21
22 1. Admin Guide
23
24 1. Overview
25 2. Dependencies
26
27 2.1. Kamailio Modules
28 2.2. External Libraries or Applications
29
30 3. Parameters
31
32 3.1. hash_size (int)
33 3.2. timer_interval (int)
34 3.3. db_url (int)
35 3.4. db_mode (int)
36 3.5. match_contact_host_port (int)
37
38 4. RPC Commands
39
40 4.1. ulpcscf.status
41
42 5. Statistics
43
44 5.1. registered contacts
45 5.2. impus
46 5.3. expired contacts
47
48 2. Frequently Asked Questions
49
50 List of Examples
51
52 1.1. Set hash_size parameter
53 1.2. Set timer_interval parameter
54 1.3. Set db_url parameter
55 1.4. Set db_mode parameter
56 1.5. Set match_contact_host_port parameter
57
58Chapter 1. Admin Guide
59
60 Table of Contents
61
62 1. Overview
63 2. Dependencies
64
65 2.1. Kamailio Modules
66 2.2. External Libraries or Applications
67
68 3. Parameters
69
70 3.1. hash_size (int)
71 3.2. timer_interval (int)
72 3.3. db_url (int)
73 3.4. db_mode (int)
74 3.5. match_contact_host_port (int)
75
76 4. RPC Commands
77
78 4.1. ulpcscf.status
79
80 5. Statistics
81
82 5.1. registered contacts
83 5.2. impus
84 5.3. expired contacts
85
861. Overview
87
88 This module serves as a storage engine for PCSCF contacts, much like
89 the standard Kamailio module, usrloc, is a storage engine for standard
90 SIP contacts. The concept of a contact in IMS, PCSCF specifically, is
91 very different to that of std. SIP and as a result we have built this
92 new module. A lot of the design has been borrowed from the std. usrloc
93 module. For example. An IMS contact, in PCSCF, needs things like:
94 * Diameter Rx session for signalling bearer status. i.e. this is
95 effectively QoS from the network to make sure the signalling link
96 can be 'trusted'
97 * IPSEC Security Association for secure signalling between UE and
98 PCSCF (first point of contact)
99 * IMPU, each contact can have a number of associated public
100 identities (IMPU).
101
1022. Dependencies
103
104 2.1. Kamailio Modules
105 2.2. External Libraries or Applications
106
1072.1. Kamailio Modules
108
109 The following modules must be loaded before this module:
110 * None.
111
1122.2. External Libraries or Applications
113
114 The following libraries or applications must be installed before
115 running Kamailio with this module loaded:
116 * None.
117
1183. Parameters
119
120 3.1. hash_size (int)
121 3.2. timer_interval (int)
122 3.3. db_url (int)
123 3.4. db_mode (int)
124 3.5. match_contact_host_port (int)
125
1263.1. hash_size (int)
127
128 The number of entries of the hash table used by to store the contact
129 records is 2^hash_size. For hash_size=4, the number of entries of the
130 hash table is 16.
131
132 Default value is 9.
133
134 Example 1.1. Set hash_size parameter
135...
136modparam("ims_usrloc_pcscf", "hash_size", 10)
137...
138
1393.2. timer_interval (int)
140
141 Number of seconds between two timer runs. The module uses timer to
142 delete expired contacts.
143
144 Default value is 60.
145
146 Example 1.2. Set timer_interval parameter
147...
148modparam("ims_usrloc_pcscf", "timer_interval", 30)
149...
150
1513.3. db_url (int)
152
153 Database URL
154
155 Default value is "mysql://kamailio:kamailiorw@localhost/kamailio".
156
157 Example 1.3. Set db_url parameter
158...
159modparam("ims_usrloc_pcscf", "db_url",
160 "dbdriver://username:password@dbhost/dbname")
161...
162
1633.4. db_mode (int)
164
165 This is the database mode to be used for the PCSCF usrloc data
166 persistent storage. Currently this module supports the Write-Through
167 scheme only.
168 * 0 - This disables DB mode. Only memory will be used for usrloc and
169 data will not survive a restart.
170 * 1 - Write-Through Scheme. All changes to usrloc are immediately
171 reflected in the database. This is slow but very reliable. This
172 mode will ensure that no registration data is lost as a result of a
173 restart or crash.
174
175 Default value is 0.
176
177 Example 1.4. Set db_mode parameter
178...
179modparam("ims_usrloc_pcscf", "db_mode", 1)
180...
181
1823.5. match_contact_host_port (int)
183
184 If set to 1 (default), the contact is matched using only host and port
185 in the contact URI.
186 * 0 - When matching contact do full contact match procedure.
187 * 1 - When matching contact compare only host and port of the contact
188 URI.
189
190 Default value is 1.
191
192 Example 1.5. Set match_contact_host_port parameter
193...
194modparam("ims_usrloc_pcscf", "match_contact_host_port", 0)
195...
196
1974. RPC Commands
198
199 4.1. ulpcscf.status
200
201 exported RPC commands.
202
2034.1. ulpcscf.status
204
205 Status of pcscf_usrloc, AORs, max slots, etc.
206
2075. Statistics
208
209 5.1. registered contacts
210 5.2. impus
211 5.3. expired contacts
212
213 Exported statistics are listed in the next sections.
214
2155.1. registered contacts
216
217 Number of AOR contacts in registered state - cannot be reset.
218
2195.2. impus
220
221 Number of IMPUs - cannot be reset.
222
2235.3. expired contacts
224
225 Number of expired contacts - can be reset.
226
227Chapter 2. Frequently Asked Questions
228
229 2.1. Where can I find more about Kamailio?
230 2.2. Where can I post a question about this module?
231 2.3. How can I report a bug?
232
233 2.1.
234
235 Where can I find more about Kamailio?
236
237 Take a look at https://www.kamailio.org/.
238
239 2.2.
240
241 Where can I post a question about this module?
242
243 First at all check if your question was already answered on one of our
244 mailing lists:
245 * User Mailing List -
246 https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
247 * Developer Mailing List -
248 https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
249
250 E-mails regarding any stable Kamailio release should be sent to
251 <sr-users@lists.kamailio.org> and e-mails regarding development
252 versions should be sent to <sr-dev@lists.kamailio.org>.
253
254 2.3.
255
256 How can I report a bug?
257
258 Please follow the guidelines provided at:
259 https://github.com/kamailio/kamailio/issues.
260