Browse Source

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

Kamailio Dev 8 years ago
parent
commit
507533e3c3
1 changed files with 66 additions and 52 deletions
  1. 66 52
      src/modules/cfg_rpc/README

+ 66 - 52
src/modules/cfg_rpc/README

@@ -24,19 +24,20 @@ Miklos Tirpak
               3.3. cfg.seti
               3.3. cfg.seti
               3.4. cfg.set_now_int
               3.4. cfg.set_now_int
               3.5. cfg.sets
               3.5. cfg.sets
-              3.6. cfg.set_now_string
-              3.7. cfg.set
-              3.8. cfg.del
-              3.9. cfg.set_delayed_int
-              3.10. cfg.set_delayed_string
-              3.11. cfg.set_delayed
-              3.12. cfg.del_delayed
-              3.13. cfg.commit
-              3.14. cfg.rollback
-              3.15. cfg.help
-              3.16. cfg.diff
-              3.17. cfg.add_group_inst
-              3.18. cfg.del_group_inst
+              3.6. cfg.reset
+              3.7. cfg.set_now_string
+              3.8. cfg.set
+              3.9. cfg.del
+              3.10. cfg.set_delayed_int
+              3.11. cfg.set_delayed_string
+              3.12. cfg.set_delayed
+              3.13. cfg.del_delayed
+              3.14. cfg.commit
+              3.15. cfg.rollback
+              3.16. cfg.help
+              3.17. cfg.diff
+              3.18. cfg.add_group_inst
+              3.19. cfg.del_group_inst
 
 
    List of Examples
    List of Examples
 
 
@@ -44,6 +45,7 @@ Miklos Tirpak
    1.2. Use cfg.get RPC command
    1.2. Use cfg.get RPC command
    1.3. Use cfg.seti RPC command
    1.3. Use cfg.seti RPC command
    1.4. Use cfg.sets RPC command
    1.4. Use cfg.sets RPC command
+   1.5. Use cfg.reset RPC command
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -62,19 +64,20 @@ Chapter 1. Admin Guide
         3.3. cfg.seti
         3.3. cfg.seti
         3.4. cfg.set_now_int
         3.4. cfg.set_now_int
         3.5. cfg.sets
         3.5. cfg.sets
-        3.6. cfg.set_now_string
-        3.7. cfg.set
-        3.8. cfg.del
-        3.9. cfg.set_delayed_int
-        3.10. cfg.set_delayed_string
-        3.11. cfg.set_delayed
-        3.12. cfg.del_delayed
-        3.13. cfg.commit
-        3.14. cfg.rollback
-        3.15. cfg.help
-        3.16. cfg.diff
-        3.17. cfg.add_group_inst
-        3.18. cfg.del_group_inst
+        3.6. cfg.reset
+        3.7. cfg.set_now_string
+        3.8. cfg.set
+        3.9. cfg.del
+        3.10. cfg.set_delayed_int
+        3.11. cfg.set_delayed_string
+        3.12. cfg.set_delayed
+        3.13. cfg.del_delayed
+        3.14. cfg.commit
+        3.15. cfg.rollback
+        3.16. cfg.help
+        3.17. cfg.diff
+        3.18. cfg.add_group_inst
+        3.19. cfg.del_group_inst
 
 
 1. Overview
 1. Overview
 
 
@@ -114,19 +117,20 @@ Chapter 1. Admin Guide
    3.3. cfg.seti
    3.3. cfg.seti
    3.4. cfg.set_now_int
    3.4. cfg.set_now_int
    3.5. cfg.sets
    3.5. cfg.sets
-   3.6. cfg.set_now_string
-   3.7. cfg.set
-   3.8. cfg.del
-   3.9. cfg.set_delayed_int
-   3.10. cfg.set_delayed_string
-   3.11. cfg.set_delayed
-   3.12. cfg.del_delayed
-   3.13. cfg.commit
-   3.14. cfg.rollback
-   3.15. cfg.help
-   3.16. cfg.diff
-   3.17. cfg.add_group_inst
-   3.18. cfg.del_group_inst
+   3.6. cfg.reset
+   3.7. cfg.set_now_string
+   3.8. cfg.set
+   3.9. cfg.del
+   3.10. cfg.set_delayed_int
+   3.11. cfg.set_delayed_string
+   3.12. cfg.set_delayed
+   3.13. cfg.del_delayed
+   3.14. cfg.commit
+   3.15. cfg.rollback
+   3.16. cfg.help
+   3.17. cfg.diff
+   3.18. cfg.add_group_inst
+   3.19. cfg.del_group_inst
 
 
    The module implements the RPC commands documented in the next sections.
    The module implements the RPC commands documented in the next sections.
 
 
@@ -179,11 +183,21 @@ Chapter 1. Admin Guide
 # kamcmd cfg.sets voicemail srv_ip "1.2.3.4"
 # kamcmd cfg.sets voicemail srv_ip "1.2.3.4"
 ...
 ...
 
 
-3.6. cfg.set_now_string
+3.6. cfg.reset
+
+   cfg.reset - Reset the variable values of a configuration group. The
+   function accepts only one parameter: group name.
+
+   Example 1.5. Use cfg.reset RPC command
+...
+# kamcmd cfg.reset core
+...
+
+3.7. cfg.set_now_string
 
 
    cfg.set_now_string - This is an alias to the command cfg.sets.
    cfg.set_now_string - This is an alias to the command cfg.sets.
 
 
-3.7. cfg.set
+3.8. cfg.set
 
 
    cfg.set - Set the value of a configuration variable and commit the
    cfg.set - Set the value of a configuration variable and commit the
    change immediately. This is a wrapper command for cfg.set_now_int and
    change immediately. This is a wrapper command for cfg.set_now_int and
@@ -192,7 +206,7 @@ Chapter 1. Admin Guide
    int/string value. The group name can optionally contain the group
    int/string value. The group name can optionally contain the group
    instance id, for example foo[5].
    instance id, for example foo[5].
 
 
-3.8. cfg.del
+3.9. cfg.del
 
 
    cfg.del - Delete the value of a configuration variable from a group
    cfg.del - Delete the value of a configuration variable from a group
    instance and commit the change immediately. The value is reset to the
    instance and commit the change immediately. The value is reset to the
@@ -200,21 +214,21 @@ Chapter 1. Admin Guide
    two parameters: group name, variable name. The group name must contain
    two parameters: group name, variable name. The group name must contain
    the group instance id, for example foo[5].
    the group instance id, for example foo[5].
 
 
-3.9. cfg.set_delayed_int
+3.10. cfg.set_delayed_int
 
 
    cfg.set_delayed_int - Prepare the change of a configuration variable,
    cfg.set_delayed_int - Prepare the change of a configuration variable,
    but does not commit the new value yet. The function accepts three
    but does not commit the new value yet. The function accepts three
    parameters: group name, variable name, integer value. The group name
    parameters: group name, variable name, integer value. The group name
    can optionally contain the group instance id, for example foo[5].
    can optionally contain the group instance id, for example foo[5].
 
 
-3.10. cfg.set_delayed_string
+3.11. cfg.set_delayed_string
 
 
    cfg.set_delayed_string - Prepare the change of a configuration
    cfg.set_delayed_string - Prepare the change of a configuration
    variable, but does not commit the new value yet. The function accepts
    variable, but does not commit the new value yet. The function accepts
    three parameters: group name, variable name, string value. The group
    three parameters: group name, variable name, string value. The group
    name can optionally contain the group instance id, for example foo[5].
    name can optionally contain the group instance id, for example foo[5].
 
 
-3.11. cfg.set_delayed
+3.12. cfg.set_delayed
 
 
    cfg.set_delayed - Prepare the change of a configuration variable, but
    cfg.set_delayed - Prepare the change of a configuration variable, but
    does not commit the new value yet. This is a wrapper command for
    does not commit the new value yet. This is a wrapper command for
@@ -223,7 +237,7 @@ Chapter 1. Admin Guide
    variable name, int/string value. The group name can optionally contain
    variable name, int/string value. The group name can optionally contain
    the group instance id, for example foo[5].
    the group instance id, for example foo[5].
 
 
-3.12. cfg.del_delayed
+3.13. cfg.del_delayed
 
 
    cfg.del_delayed - Prepare the deletion of the value of a configuration
    cfg.del_delayed - Prepare the deletion of the value of a configuration
    variable from a group instance, but does not commit the change yet. The
    variable from a group instance, but does not commit the change yet. The
@@ -231,33 +245,33 @@ Chapter 1. Admin Guide
    The function accepts two parameters: group name, variable name. The
    The function accepts two parameters: group name, variable name. The
    group name must contain the group instance id, for example foo[5].
    group name must contain the group instance id, for example foo[5].
 
 
-3.13. cfg.commit
+3.14. cfg.commit
 
 
    cfg.commit - Commit the previously prepared configuration changes. The
    cfg.commit - Commit the previously prepared configuration changes. The
    function does not have any parameters.
    function does not have any parameters.
 
 
-3.14. cfg.rollback
+3.15. cfg.rollback
 
 
    cfg.rollback - Drop the prepared configuration changes. The function
    cfg.rollback - Drop the prepared configuration changes. The function
    does not have any parameters.
    does not have any parameters.
 
 
-3.15. cfg.help
+3.16. cfg.help
 
 
    cfg.help - Print the description of a configuration variable. The
    cfg.help - Print the description of a configuration variable. The
    function accepts two parameters: group name, variable name.
    function accepts two parameters: group name, variable name.
 
 
-3.16. cfg.diff
+3.17. cfg.diff
 
 
    cfg.diff - List the pending configuration changes that have not been
    cfg.diff - List the pending configuration changes that have not been
    committed yet. The function does not have any parameters.
    committed yet. The function does not have any parameters.
 
 
-3.17. cfg.add_group_inst
+3.18. cfg.add_group_inst
 
 
    cfg.add_group_inst - Add a new instance to an existing configuration
    cfg.add_group_inst - Add a new instance to an existing configuration
    group. The function accepts one parameter: group name[instance id], for
    group. The function accepts one parameter: group name[instance id], for
    example foo[5].
    example foo[5].
 
 
-3.18. cfg.del_group_inst
+3.19. cfg.del_group_inst
 
 
    cfg.del_group_inst - Delete an instance of an existing configuration
    cfg.del_group_inst - Delete an instance of an existing configuration
    group. The function accepts one parameter: group name[instance id], for
    group. The function accepts one parameter: group name[instance id], for