Команди CLI FreeSWITCH (FS_CLI), profile, gateways, debug, reloadxml.
У цій статті ми розповімо, як користуватися FreeSWITCH CLI (Command Line Interface) (FS_CLI) і наведемо основні команди, які допоможуть вам в процесі експлуатації FreeSWITCH. CLI необхідна для дебага помилок і управління FreeSWITCH.
Для заходу в FreeSWITCH CLI (FS_CLI) необхідно ввести наступні команди:
Параметри командного рядка для запуску FreeSWITCH
-?,-h --help Допомога. Список доступних параметрів командного рядка
-H. --host = hostname Хост, до якого потрібно підключитися
-P. --port = port Порт для підключення (1 - 65535)
-u. --user = user @ domain user @ domain
-p. --password = password Пароль
-i. Дозволити використовувати Ctrl-C, щоб вийти з консолі
-x. "" Для виконання команд з консолі Linux. Наприклад, fs_cli -x "sofia status profile internal"
-l. Рівень ведення журналу
-U. Включити UUID на виході журналу
-S. Включити укорочений UUID в виході журналу
-q. Відключити ведення журналу
-r. У разі невдалого з'єднання спроба повторного з'єднання
-R. Повторне підключення при відключенні
-d. Рівень Налагодження (0 - 7)
-b. пакетний режим
-t. Тайм-аут для команди API (в мілісекундах)
-T. Таймаут для сокет з'єднання (в мілісекундах)
-n. Відключити кольорове оформлення
Тепер перейдемо безпосередньо до командам в CLI.
Запуск нового профілю
Якщо ви створили новий профіль, необхідно запустити його з консолі:
Перевантаження профілів (profiles) і шлюзів (gateways)
Ви можете перевантажити певні профілі, виконавши в консолі команду restart / rescan.
Різниця між rescan і restart в тому, що rescan просто завантажить новий конфіг, і не буде зупиняти FreeSWITCH. так що всі поточні виклики (розмови) не позривають.
Видалення шлюзів (gateways)
Якщо вам потрібно видалити певний шлюз, можна скористатися командою killgw.
Перезавантаження шлюзу (gateways)
Для примусового перезавантаження шлюзу використовуйте комбінацію команд killgw і rescan. При цьому збережуться поточні виклики.
Додати / редагувати існуючих шлюзів (gateways)
Будемо вважати, що всі ваші шлюзи знаходяться в директорії: / usr / local / freeswitch / conf / sip_profiles / external. і ви тільки що створили новий шлюз. Команди rescan. reloadxml додадуть новий шлюз, але не вплинуть на поточні виклики.
Припустимо, що ви помилилися з даними в створеному шлюзі (gateways), і потрібно внести зміни (виправити). Ви вносите потрібні зміни, і тепер потрібно вбити існуючу реєстрацію командою killgw. а потім командами rescan і reloadxml перечитати конфиг і підняти шлюз.
Якщо ви хочете подивитися всі пристрої, зареєстровані в системі, виконайте наступні команди:
Якщо ви хочете подивитися статус зареєстрованих пристроїв в форматі XML, виконайте наступні команди:
Відобразити статус шлюзів
Відобразити статус активних шлюзів:
Відобразити статус неактивних шлюзів:
FreeSWITCH може виводити зневадження наступних рівнів:
Дебагі бувають наступних видів (переклад сенсу не має, так як всі і так зрозуміло):
Рівень детальності повідомлень і дебаг можна задати за допомогою команди:
Рівень 0 відключає налагодження. Вимкнути налагодження у всіх можна за допомогою команди:
Тепер перейдемо до Sip debug
Включити загальний SIP debug:
Включити SIP debug для певного профілю:
Якщо ви хочете отримувати SIP debug в файл /usr/local/freeswitch/log/freeswitch.log. введіть команду:
Якщо хочете включити в загальний лог SIP дебага за замовчуванням, додайте в sofia.conf.xml наступну опцію
А так же потрібно додати в налаштування потрібного нам sip профілю:
Після чого в консолі FS робимо
Sofia SIP Stack Watchdog
Іноді (в окремих випадках) модуль Sofia може перестати відповідати на запити або просто зависне, можна включити опцію контролю watchdog. Ця опція дозволяє контролювати модуль Sofia. і, в разі не відповіді на запити, в перебігу зазначеного кількості мілісекунд watchdog перезавантажить FreeSWITCH.
В FS CLI Watchdog може бути включений або вимкнений глобально або для конкретного профілю: