Rmanager Commands

From Yate Documentation
Jump to: navigation, search

This is a short list of commands that can be issued from the rmanager command line interface.
Other commands or variations can be added by loadable modules, either internal or external.


Unauthenticated commands

These commands are available even when authentication is configured and the connection is not yet authenticated.

  • quit

Disconnect this control session from Yate

  • echo [on|off]

Show or turn remote echo on or off

  • help [command]

Provide help on all or given command

  • auth password

Authenticate so you can access privileged commands

User mode commands

If user level login is configured and authentication was performed using the user password the following commands are also available:

  • status [overview] [modulename]

Shows status of all or selected modules or channels

  • uptime

Show information on how long Yate has run

  • machine [on|off]

Show or turn machine output mode on or off

  • output [on|off]

Show or turn local output on or off

  • color [on|off]

Show status or turn local colorization on or off

Administrative commands

These commands are available if the administrator password was used to authenticate or if authentication is completely disabled.

  • debug [module] [level|on|off]

Show or change debugging level globally or per module

  • drop {chan|*|all} [reason]

Drops one or all active calls

  • call chan target

Execute an outgoing call

  • control chan [operation] [param=val] [param=...]

Apply arbitrary control operations to a channel or entity

  • reload

Reloads module configuration files

  • restart [now]

Restarts the engine if executing supervised

  • stop [exitcode]

Stops the engine with optionally provided exit code

  • module {{load|reload} modulefile|unload modulename|list}

Controls the modules loaded in the Telephony Engine

Module provided commands

These commands are provided by miscelaneous modules, not by the engine itself. They are available in the same conditions as the administrative commands.

The following modules are providing commands:

See also

Personal tools