Handler-скрипты

Handler-скрипт — исполняемый файл, как правило, написанный на shell. С его помощью АСР LANBilling может совершать действия во внешних системах. Например, останавливать интернет-сессию абонента, если учётная запись попала в блокировку.

В старых версиях АСР LANBilling вместо handler-скриптов использовались vg-скрипты. Подробнее о том, как перенастроить работу с vg на handler, написано в этой инструкции.

Общая информация

Когда в АСР LANBilling происходит событие, предусмотренное скриптом, система передаёт в handler набор параметров:

• причина запуска;
• для какой учётной записи нужно выполнить действие;
• особенности события.

Скрипт обрабатывает эти параметры и выполняет последовательность команд.

Чтобы работать с handler-скриптом, подготовьте файл и пропишите путь к нему в конфигурации системы. Можно настроить handler-скрипт для модулей:

• LBcore — ядро АСР LANBilling
• LBucd — модуль для агента Netflow
• LBarcd — модуль для агента RADIUS
• LBircd — модуль для агента IP-телефонии

Вы можете использовать сразу несколько скриптов. Например, для ядра АСР LANBilling и для RADIUS-агента. В этом случае убедитесь, что скрипты не будут конфликтовать.

LBcore и handler

Путь к handler-скрипту для LBcore нужно указать в файле конфигурации /etc/billing.conf.

Пример:

# External script handler
handler = /usr/local/billing/scripts/handler.py

Передаваемые параметры

• Для учётных записей телефонии и IP-телефонии с агентами LBphone, VoIP:

  • "--sysid" — идентификатор агента;
  • "--action" — действие;
  • "--vgid" — идентификатор учётной записи;
  • "--login" — логин учётной записи;
  • "--password" — пароль учётной записи;
  • "--phone" — номер телефона. Если в учётной записи их несколько, то каждый передаётся отдельно в "--phone". Если номер имеет пустое значение, то в параметр записывается «empty_phone».

• Для учётных записей интернета с агентами Netflow, RADIUS:

  • "--sysid" — идентификатор агента;
  • "--action" — действие;
  • "--vgid" — идентификатор учётной записи;
  • "--login" — логин учётной записи;
  • "--password" — пароль учётной записи;
  • "--shape" — текущее значение полосы пропускания на учётной записи;
  • "--net" — если к учётной записи привязаны IP-сегменты, то добавляется список, где указываются адреса этих сегментов в формате «IP/маска».

• Для учётных записей услуг:

  • "--sysid" — идентификатор агента;
  • "--action" — действие;
  • "--vgid" — идентификатор учётной записи;
  • "--login" — логин учётной записи;
  • "--password" — пароль учётной записи.

Когда запускается скрипт

Пример handler-скрипта: scripts_handler.py

LBucd и handler

Путь к handler для LBucd нужно указать в файле конфигурации /etc/billing.conf.LBucd.

Пример:

# External script handler
handler = /usr/local/billing/scripts/handler.example.LBucd.sh

Передаваемые параметры

• "--action" — действие;
• "--login" — логин учётной записи;
• "--password" — пароль учётной записи;
• "--shape" — текущее значение полосы пропускания на учётной записи (Кбит/с);
• "--net" — если к учётной записи привязаны IP-сегменты, то добавляется список, где указываются адреса этих сегментов в формате «IP/маска».

Когда запускается скрипт

Пример handler-скрипта: scripts_handler.example.LBucd.py

LBarcd и handler

Путь к handler для LBarcd нужно указать в файле конфигурации /etc/billing.conf.LBarcd.

Пример:

# External script handler
handler = /usr/local/billing/scripts/handler.example.LBarcd.sh

Передаваемые параметры

• "--action" — действие;
• "--reason" — причина разрыва;
• "--session" — идентификатор сессии;
• "--login" — логин учётной записи, переданный во время аутентификации;
• "--nas" — IP-адрес сервера доступа;
• "--ip" — IP-адрес сессии;
• "--net" — если к учётной записи привязаны IP-сегменты, то добавляется список, где указываются адреса этих сегментов в формате «IP/маска»;
• "--shape" — ограничение полосы пропускания (Кбит/с);
• "--oldshape" — старое ограничение полосы пропускания (Кбит/с);
• "--mac" — значение атрибута Calling-Station-Id;
• "--password" — пароль учётной записи;
• "--oldblocked" — старый статус учётной записи;
• "--blocked" — новый статус учётной записи;
• "--username" — имя пользователя, переданное во время аутентификации;
• "--vglogin" — логин учётной записи в системе.

Когда запускается скрипт

Пример handler-скрипта: Setup_handler.example.LBarcd

LBircd и handler

Путь к handler нужно указать в файле конфигурации /etc/billing.conf.LBircd.

Пример:

# External script handler
handler = /usr/local/billing/scripts/handler.example.LBircd.sh

Передаваемые параметры

• "--action" — действие;
• "--reason" — причина разрыва;
• "--session" — идентификатор сессии;
• "--login" — логин учётной записи;
• "--nas" — IP-адрес сервера доступа;
• "--ani" — значение атрибута Calling-Station-Id;
• "--password" — пароль учётной записи;
• "--phone" — номер телефона. Если в учётной записи их несколько, то каждый передаётся отдельно в "--phone". Если номер имеет пустое значение, то в параметр записывается «empty_phone».

Когда запускается скрипт

Пример handler-скрипта: scripts_handler.example.LBircd