How to find which external modules are loaded from rmanager

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Example usage)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
To debug external module in telnet the command '''external''' is used.
+
To see what external scripts are running at any moment you can run in Telnet the command '''external'''. <br>From telnet you can start/stop/restart an external module without stopping Yate (operations needed when you want to update the changes in your script).<br>
To use it (to see what global external module is on) follow the steps bellow.
+
Follow the next steps to know how to see from Telnet the running global external modules.
  
=== Connect using telnet from the localhost===
+
=== Connect using Telnet from the localhost===
 +
 
 +
Connect to Yate through telnet:
  
 
   >> telnet 127.0.0.1 5038  
 
   >> telnet 127.0.0.1 5038  
Line 9: Line 11:
 
5038 is the default Yate port, in case your Yate uses another port use that.
 
5038 is the default Yate port, in case your Yate uses another port use that.
  
=== Type ===
+
=== Command 'external' parameters meaning ===
 +
 
 +
By typing this commands in telnet:
 +
*    ''external script_name.php'' - just start another instance of the module
 +
*    ''external '''start''' script_name.php'' - start an instance only if one isn't already running
 +
*    ''external '''stop''' script_name.php'' - stops the first running instance with that name
 +
*    ''external '''restart''' script_name.php'' - stops (if running) and then starts an external module
 +
*    ''external '''info''''' - provides more detailed information about each of the running modules (no module name is supported)
 +
 
 +
=== Command 'external' without parameters ===
 +
 
 +
Type in telnet:
  
 
   external
 
   external
  
The output should be the external modules that are running at that time. Example:
+
The output should be the external modules that are running at that time.  
 +
 
 +
Examples:
  
 
   1. external_module1.php
 
   1. external_module1.php
 
   2. external_module2.php
 
   2. external_module2.php
  
=== Restart script ===
+
=== Example usage ===
  
 
Let's say you want to restart one if the scripts without restarting Yate, because you modified it.
 
Let's say you want to restart one if the scripts without restarting Yate, because you modified it.
Line 24: Line 39:
 
Type:
 
Type:
  
   external ''restart'' name_of_module
+
   external ''restart'' external_module1.php
  
 
For the same target you can use "stop" and "start" instead of "restart".
 
For the same target you can use "stop" and "start" instead of "restart".
  
 
=== External parameters meaning ===
 
 
*    ''no command'' - just start another instance of the module
 
*    ''start'' - start an instance only if one isn't already running
 
*    ''stop'' - stops the first running instance with that name
 
*    ''restart'' - stops (if running) and then starts an external module
 
*    ''info'' - provides more detailed information about each of the running modules (no module name is supported)
 
  
 
'''See also'''
 
'''See also'''
  
 
* [[Rmanager]]
 
* [[Rmanager]]
 +
* [[Debug Output]]
 +
* [[How To's]]
 +
 +
[[Category:Debug]] [[Category:Telnet]] [[Category:Rmanager]] [[Category:External]] [[Category:External module]]

Latest revision as of 18:59, 31 October 2013

To see what external scripts are running at any moment you can run in Telnet the command external.
From telnet you can start/stop/restart an external module without stopping Yate (operations needed when you want to update the changes in your script).
Follow the next steps to know how to see from Telnet the running global external modules.

Contents

[edit] Connect using Telnet from the localhost

Connect to Yate through telnet:

  >> telnet 127.0.0.1 5038 

5038 is the default Yate port, in case your Yate uses another port use that.

[edit] Command 'external' parameters meaning

By typing this commands in telnet:

  • external script_name.php - just start another instance of the module
  • external start script_name.php - start an instance only if one isn't already running
  • external stop script_name.php - stops the first running instance with that name
  • external restart script_name.php - stops (if running) and then starts an external module
  • external info - provides more detailed information about each of the running modules (no module name is supported)

[edit] Command 'external' without parameters

Type in telnet:

  external

The output should be the external modules that are running at that time.

Examples:

  1. external_module1.php
  2. external_module2.php

[edit] Example usage

Let's say you want to restart one if the scripts without restarting Yate, because you modified it.

Type:

  external restart external_module1.php

For the same target you can use "stop" and "start" instead of "restart".


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers