Browse code

modules: readme files regenerated - uac ... [skip ci]

Kamailio Dev authored on 18/11/2020 09:01:15
Showing 1 changed files
... ...
@@ -83,11 +83,12 @@ Ramona-Elena Modroiu
83 83
               8.2. uac.reg_info
84 84
               8.3. uac.reg_enable
85 85
               8.4. uac.reg_disable
86
-              8.5. uac.reg_reload
87
-              8.6. uac.reg_refresh
88
-              8.7. uac.reg_active
89
-              8.8. uac.reg_add
90
-              8.9. uac.reg_remove
86
+              8.5. uac.reg_unregister
87
+              8.6. uac.reg_reload
88
+              8.7. uac.reg_refresh
89
+              8.8. uac.reg_active
90
+              8.9. uac.reg_add
91
+              8.10. uac.reg_remove
91 92
 
92 93
         9. Remote Registration
93 94
 
... ...
@@ -134,12 +135,13 @@ Ramona-Elena Modroiu
134 135
    1.39. uac.reg_info usage
135 136
    1.40. uac.reg_enable usage
136 137
    1.41. uac.reg_disable usage
137
-   1.42. uac.reg_reload usage
138
-   1.43. uac.reg_refresh usage
139
-   1.44. uac.reg_active usage
140
-   1.45. uac.reg_add usage
141
-   1.46. uac.reg_remove usage
142
-   1.47. lookup remote registrations usage
138
+   1.42. uac.reg_unregister usage
139
+   1.43. uac.reg_reload usage
140
+   1.44. uac.reg_refresh usage
141
+   1.45. uac.reg_active usage
142
+   1.46. uac.reg_add usage
143
+   1.47. uac.reg_remove usage
144
+   1.48. lookup remote registrations usage
143 145
 
144 146
 Chapter 1. Admin Guide
145 147
 
... ...
@@ -205,11 +207,12 @@ Chapter 1. Admin Guide
205 207
         8.2. uac.reg_info
206 208
         8.3. uac.reg_enable
207 209
         8.4. uac.reg_disable
208
-        8.5. uac.reg_reload
209
-        8.6. uac.reg_refresh
210
-        8.7. uac.reg_active
211
-        8.8. uac.reg_add
212
-        8.9. uac.reg_remove
210
+        8.5. uac.reg_unregister
211
+        8.6. uac.reg_reload
212
+        8.7. uac.reg_refresh
213
+        8.8. uac.reg_active
214
+        8.9. uac.reg_add
215
+        8.10. uac.reg_remove
213 216
 
214 217
    9. Remote Registration
215 218
 
... ...
@@ -998,11 +1001,12 @@ event_route[uac:reply] {
998 1001
    8.2. uac.reg_info
999 1002
    8.3. uac.reg_enable
1000 1003
    8.4. uac.reg_disable
1001
-   8.5. uac.reg_reload
1002
-   8.6. uac.reg_refresh
1003
-   8.7. uac.reg_active
1004
-   8.8. uac.reg_add
1005
-   8.9. uac.reg_remove
1004
+   8.5. uac.reg_unregister
1005
+   8.6. uac.reg_reload
1006
+   8.7. uac.reg_refresh
1007
+   8.8. uac.reg_active
1008
+   8.9. uac.reg_add
1009
+   8.10. uac.reg_remove
1006 1010
 
1007 1011
 8.1.  uac.reg_dump
1008 1012
 
... ...
@@ -1063,43 +1067,57 @@ event_route[uac:reply] {
1063 1067
    kamcmd uac.reg_disable l_uuid s:12345678
1064 1068
 ...
1065 1069
 
1066
-8.5.  uac.reg_reload
1070
+8.5.  uac.reg_unregister
1071
+
1072
+   Send REGISTER with expires 0 for matching record, disabling it. The
1073
+   command has two parameter: attribute and value. The attribute can be:
1074
+   l_uuid, l_username, r_username or auth_username. The value is what
1075
+   should be matched against the value of the attribute in the remote
1076
+   registration record.
1077
+
1078
+   Example 1.42. uac.reg_unregister usage
1079
+...
1080
+   kamcmd uac.reg_unregister l_uuid account123
1081
+   kamcmd uac.reg_unregister l_uuid s:12345678
1082
+...
1083
+
1084
+8.6.  uac.reg_reload
1067 1085
 
1068 1086
    Reload the records from database for remote registrations. There is a
1069 1087
    limit of how often the reload command can be executed, by default is
1070 1088
    150 seconds between reloads -- see the reg_gc_interval parameter for
1071 1089
    more details.
1072 1090
 
1073
-   Example 1.42. uac.reg_reload usage
1091
+   Example 1.43. uac.reg_reload usage
1074 1092
 ...
1075 1093
    kamcmd uac.reg_reload
1076 1094
 ...
1077 1095
 
1078
-8.6.  uac.reg_refresh
1096
+8.7.  uac.reg_refresh
1079 1097
 
1080 1098
    Load one record by l_uuid from database for remote registrations. If
1081 1099
    the record exists in memory, it will be replaced with the new values
1082 1100
    loaded from database.
1083 1101
 
1084
-   Example 1.43. uac.reg_refresh usage
1102
+   Example 1.44. uac.reg_refresh usage
1085 1103
 ...
1086 1104
    kamcmd uac.reg_refresh account123
1087 1105
    kamcmd uac.reg_refresh s:12345678
1088 1106
 ...
1089 1107
 
1090
-8.7.  uac.reg_active
1108
+8.8.  uac.reg_active
1091 1109
 
1092 1110
    Control if the module should do remote registrations or not. Setting to
1093 1111
    1 enables remote registrations for all records and 0 disables doing
1094 1112
    them.
1095 1113
 
1096
-   Example 1.44. uac.reg_active usage
1114
+   Example 1.45. uac.reg_active usage
1097 1115
 ...
1098 1116
    kamctl rpc uac.reg_active 0
1099 1117
    kamctl rpc uac.reg_active 1
1100 1118
 ...
1101 1119
 
1102
-8.8.  uac.reg_add
1120
+8.9.  uac.reg_add
1103 1121
 
1104 1122
    Add a new UAC remote registration record. If one with the same unique
1105 1123
    id is found, it is deleted.
... ...
@@ -1124,16 +1142,16 @@ event_route[uac:reply] {
1124 1142
    Use a dot (.) if no value should be set for auth_password, auth_ha1, or
1125 1143
    contact_addr.
1126 1144
 
1127
-   Example 1.45. uac.reg_add usage
1145
+   Example 1.46. uac.reg_add usage
1128 1146
 ...
1129 1147
    kamcmd uac.reg_add ...
1130 1148
 ...
1131 1149
 
1132
-8.9.  uac.reg_remove
1150
+8.10.  uac.reg_remove
1133 1151
 
1134 1152
    Remove a UAC remote registration record by l_uuid.
1135 1153
 
1136
-   Example 1.46. uac.reg_remove usage
1154
+   Example 1.47. uac.reg_remove usage
1137 1155
 ...
1138 1156
    kamcmd uac.reg_remove my_l_uuid
1139 1157
 ...
... ...
@@ -1189,7 +1207,7 @@ event_route[uac:reply] {
1189 1207
    if the call is coming from a remote SIP provider and can change the
1190 1208
    R-URI to local username@domain. Afterwards you can run location lookup.
1191 1209
 
1192
-   Example 1.47. lookup remote registrations usage
1210
+   Example 1.48. lookup remote registrations usage
1193 1211
 ...
1194 1212
     if(uac_reg_lookup("$rU", "$ru")) {
1195 1213
         xlog("request from a remote SIP provider [$ou => $ru]\n");