Документация NetAMS

Информацию о текущем и прошедшем трафике можно получить, подсоединившись к программе через telnet и набрав команды:

• show list full

• send report to {user_name} on {unit_name} (при настроенном сервисе alerter)

• html (при настроенном сервисе html — и это наилучший вариант)

Информация о командах их параметрах сгруппирована по сервисам. Все команды, описанные в этом разделе, могут использоваться для подготовки конфигурационного файла перед запуском программы. В то же время большинство из них может быть указано при подключении к работающей программе через telnet и вводе соответствующих директив. Некоторые команды требуют рестарта демона (например, изменение пути, где сервис storage хранит свои базы данных). Вы всегда можете получить справку о доступных командах набрав "?» ; для справки о параметрах наберите «имя_команды ?».

Порядок описания сервисов в конфигурационном файле:

• Сервисы main и scheduler (команды debug, user, schedule)

• Сервис processor (таймауты, restrict, policies, units, список БД)

• Сервисы storage (их может быть несколько)

• Сервисы data–source (их может быть несколько)

• Сервис alerter

• Сервис html

• Сервис monitor (их может быть несколько)

• Сервис quota

• Сервис login

• Сервис billing

Каждый сервис стартует командой

service XXX N

где N — номер экземпляра сервиса. Сервисы main и scheduler явно указывать не надо — команды настройки этих сервисов идут в самом начале конфигурационного файла ДО описания остальных сервисов.

В случае, если какой–то параметр совпадает с значением «по умолчанию» в конфигурации он может не показываться.

Сервисы, которые возможны только в единственном варианте, не показывают свой номер.

Для того чтобы отменить введенную команду или удалить объект, необходимо повторить команду и в начале поставить ключевое слово no

Если хочется исполнить последовательность команд, например для настройки каких–нибудь параметров сервиса, команды можно разделять символами "&&" (перед и после — пробелы), например так:

schedule time at–23:30 action «service processor && unit host name pupkin sys–deny && exit»

или так:

send report to admin on LAN+ && html && show perf

Напоминаем, что явно описывать этот сервис не нужно: подразумевается, что конфигурационный файл начинается с описания этого сервиса.

user { oid OID | name user_name }

[real–name user_human_name]

[email email_addr]

[password pass]

[crypted crypted_pass]

[permit permit_state]

Команда, которая задает пользователя системы и его параметры. Только присутствующий в списке user пользователь имеет право управлять программой через TCP–порт, т.е. интерактивно или через API. Таким образом, вы должны создать столько пользователей user, сколько администраторов в вашей сети + отдельный аккаунт, от имени которого будут выполняться веб–скрипты, использующие NeTAMS API.

• oid OID

• уникальный идентификатор пользователя, создается автоматически если не указан

• name user_name

• логин пользователя программы.

• real–name user_human_name

• его человеческое имя, может быть в кавычках и содержать пробелы, используется например при отправке уведомлений по почте

• email email_addr

• адрес почты для отправки уведомлений администратору

• password pass

• пароль на вход, не зашифрованный

• crypted crypted_pass

• пароль на вход, зашифрованный. Если в конфигурационном файле был введен не зашифрованный пароль, то он тут же автоматически шифруется, и при выводе show config или save выдается именно шифрованная версия. Команда show config unsecure, которая используется сервисом html для генерации статической страницы с конфигурационным файлом, выводит вместо всех паролей звездочки.

• permit permit_state

• права пользователя в системе, от none до all. Подробнее можно посмотреть в src/security.c

no user { oid OID | name user_name }

Удаляет указанного по имени или OID пользователя из программы.

language { ru | en }

Выбор языка, на котором формируются отчеты сервисами HTML и alerter. Пока действуют только английский и русский.

debug deb_str [deb_str] …

Команда, которая задает тип выводимой в ходе работы отладочной информации о деятельности сервисов.

deb_str — идентификатор типа отладки:

• none — отсутствие всех видов отладки

• command — введенные пользователем/файлом конфигурации команды

• parse — разбор введенных команд

• sleep — работа механизма синхронизации сервисов

• server — работа сервиса server

• proc_mux — мультиплексор сообщений сервиса processor

• ds_ip — данные ip сервиса data–source

• storage — работа сервиса storage

• alert — работа сервиса alerter

• scheduler — работа сервиса scheduler

• html — работа сервиса html и генерация статических страниц

• monitor — данные по пакетам для указанных units

• login — работа сервиса логинов

• quota — работа сервиса контроля квот quota

• iptree — работа механизма хранения объектов iptree

• flow — работа механизма потоков трафика

• ds_mux — мультиплексор сообщений сервисов data–source

• memory — работа менеджера памяти

• policy — работа по проверке политик для аккаунтов (биллинг)

• billing — работа сервиса биллинга

• aclserver — работа сервиса контроля списков доступа ACL

• bw — работа механизма ограничения скорости передачи данных юнитом

• all — наличие всех видов отладки (включайте осторожно, иначе на экран могут полезть сотни строк в секунду).

no debug deb_str [deb_str] …

Отключает отладку указанного типа. Команда debug none эквивалентна no debug all.

radius auth {nas|web}

login login_str

[password pass_str]

nas–id nas_name

callback–id callback_name

Обеспечивает авторизацию внешнего радиус–сервера (через модуль rlm_netams) согласно внутренней базе паролей netams. См. подробное описание.

mac {control [ alert ] [ block ]} | {fixate}

control выполняет проверку соответствия MAC–и IP–адресов, используя системную таблицу ARP. Проверке будут подвергаться только юниты типа HOST и USER, для которых задан параметр «mac …».

НЕ рекомендуется делать ее очень часто — оптимальным можно считать 1 раз в 5 минут. Задавать такую проверку рекомендуется через service scheduler. Агрументы block и alert задают, что делать при появлении MAC–адреса, отличного от указанного в настройках: отключать юнит через sys–deny–mac и/или отправлять всем администраторам (user XXX … permit all) почтовое сообщение. При «возврате» MAC–адреса обратно заблокированный юнит вновь включается.

fixate производит «дозапись» параметра MAC всем определенным в конфигурационном файле юнитам, которые в данный момент присутствуют в системной таблице ARP. Рекомендуется применять эту команду для создания привязки MAC–IP для работающей системы NeTAMS с уже определенным набором юнитов: через сервис scheduler запланируйте исполнение этой команды раз в 15 минут, а через пару дней отключите задачу и создайте задачу контроля (mac control …)

html

Вызывает создание HTML–страницы сервисом html (если он работает). В большинстве случаев эта команда должна выполняться не вручную, а сервисом scheduler (параметр run XXX сервиса html приводит к созданию соответствующей записи планировшика автоматически)