fs_cli

Connect to the local FreeSWITCH instance with an interactive session

$ fs_cli

$ fs_cli -H [host] -P [port] -p [password]

$ fs_cli -x "[command]"

$ fs_cli -x "status"

$ fs_cli -x "reloadxml"

$ fs_cli -x "module_exists [module_name]"

$ fs_cli -x "show calls"

$ fs_cli -r

fs_cli [options]

fs_cli is the FreeSWITCH command-line interface client that connects to a running FreeSWITCH server via the Event Socket Layer (ESL). It provides interactive access to FreeSWITCH's API for managing calls, configurations, and system status.
The tool can operate in interactive mode for real-time control or execute single commands via the -x option for scripting and automation. It connects to the ESL port (default 8021) using configured credentials.
Common operations include checking call status, reloading configurations, managing channels, and monitoring system health.

-H, --host HOST

Connect to remote FreeSWITCH server at HOST

Connect to Event Socket on PORT (default: 8021)

Event Socket password (default: ClueCon)

Execute command and exit

Retry connection on failure

Set log level (0-7)

Disable logging to console

Debug level (0-7)

/etc/freeswitch/autoload_configs/event_socket.conf.xml

Event Socket Layer configuration controlling the listen address, port, and authentication password for ESL connections.

Requires the Event Socket module to be loaded and properly configured in FreeSWITCH. Default password "ClueCon" should be changed in production. Network access to ESL port must be properly secured.

fs_cli is part of the FreeSWITCH project, an open-source communications platform started in 2006 by Anthony Minessale II. It was created as a modern, scalable alternative to Asterisk for building telephony applications.

asterisk(8), freeswitch(1)