Загальний опис
Історія змін
Рекомендації до оновлення
Плани на майбутнє
Відомі проблеми
Онлайн демо
Допомога проекту
Люди
Трохи про безпеку
FAQ
Це стара версія документу!
В Ubilling начиная с релиза 0.4.1 появилась возможность опроса активного сетевого оборудования посредством SNMP (требует установленного net-snmp). Механика опроса шаблонизирована и позволяет опрашивать оборудование по любым OID-ам. Также модуль “Опрос свичей” использует в своей работе кеширование результатов, что позволяет сделать отображение результатов приемлемым по времени.
И много-много других, о которых мы уже задолбались писать. Давайте вы сами посмотрите что будет работать из коробки заглянув в директорию config/snmptemplates?
В общем случае настройка сводиться к добавлению модели свича с правильным шаблоном SNMP
После чего следует добавить устройство с нужной моделькой и указанным SNMP комьюнити, а также подстрокой SWPOLL в описании, которая сигнализирует Ubilling о том, что для данного устройства следует применить стандартные механизмы опроса относительно выбранного шаблона.
Если все добавлено верно - у свича в колонке действия должна появиться иконка “Опрос при помощи SNMP”
Набор параметров запрашиваемых с устройства, полностью зависит от выбранного шаблона и может быть практически произвольным. Также возможно отображение FDB с устройства.
Учитывая, что опрос устройства происходит не слишком быстро, для ускорения отображения результатов используется механика кеширования. Для периодического опроса всех устройств, с целью заполнения кеша сырых данных следует использовать вызов swpoll из API удаленного вызова процедур.
Шаблоны всех устройств лежат в /config/snmptemplates/ и имеют например какой-то такой вид:
[define] DEVICE="ZIZITRA MegaSwitch-9000 2ports" FDB=true FDB_MODE=default [PORTSTATE] NAME="Port states" OIDS=".1.3.6.1.2.1.2.2.1.8.1,.1.3.6.1.2.1.2.2.1.8.2" PARSER=sp_parse_zyportstates [UPTIME] NAME="Uptime" OIDS=".1.3.6.1.2.1.1.3.0" PARSER=sp_parse_raw
или такой для OLT:
[define] DEVICE="BDCOM OLT GP3600-8" PON_ONU_PORT_MAX=128 [signal] SIGNALMODE="GPBDCOM" SIGINDEX=".1.3.6.1.4.1.3320.10.3.4.1.2" MACINDEX=".1.3.6.1.4.1.3320.10.3.3.1.2" SIGVALUE="INTEGER:" MACVALUE="STRING:" OFFSET="10" OFFSETMODE="div" DOWNVALUE="2147483648" [misc] ONUINDEX=".1.3.6.1.4.1.3320.10.3.3.1.2" ONUVALUE="STRING:" FDBINDEX=".1.3.6.1.2.1.17.7.1.2.2.1.1" FDBVALUE="Hex-STRING:" FDBDEVINDEX=".1.3.6.1.2.1.17.7.1.2.2.1.2" FDBDEVVALUE="INTEGER:" DISTINDEX=".1.3.6.1.4.1.3320.10.3.1.1.33" DISTVALUE="INTEGER:" INTERFACEINDEX=".1.3.6.1.2.1.2.2.1.2" INTERFACEVALUE="STRING:" RTTINDEX=".1.3.6.1.4.1.3320.101.11.1.1.8" [system] CPULOAD=".1.3.6.1.2.1.25.3.3.1.2"
Как видим файл состоит из секций.
Секция [define] является обязательной. В ней описываются такие характеристики устройства как DEVICE (полное наименование модели) и булевый параметр FDB - означающий, что для устройства следует попытаться достать FDB а также необязательный параметр FDB_MODE указывающий на метод опроса FDB таблиц. Он может принимать значения default (по-умолчанию) или dlp (для некоторых моделей свитчей Dlink) и tlp5428ev2 для соответствующего tp-link. В случае, если параметр FDB_MODE не указан, по-умолчанию будет считаться, что он установлен в значение default.
Также существуют необязательные параметры:
Следует отметить, что параметр FDB_ALLOW_ONLY_PORTS имеет преимущество и, если номер порта будет указан одновременно в обеих этих опциях - преимущество будет за FDB_ALLOW_ONLY_PORTS и МАСи с этого порта таки попадут в FDB-кэш.
Далее каждая из секций описывает уникальный набор параметров, по которому будет опрашиваться устройство. Имя секции особого значения не имеет и просто должно быть уникальным. Каждая секция состоит из как минимум трех обязательных переменных. Это NAME - отображаемое название опрашиваемой характеристики (будет локализовано), OIDS - список OID-ов через запятую которые будут опрошены для конкретной модели и PARSER - парсер данных, через который будут пропущены данные полученные от каждого OID-а в текущей секции. Из вышеприведенного примера можно заключить, что данный шаблон будет отображать состояние двух первых портов свича и его аптайм а также пытаться показывать таблицу соответствия MAC-ов по портам.
Начиная с релиза Ubilling 0.8.5 также можно хранить ваши шаблоны в content/documents/mysnmptemplates/. Они будут иметь приоритет перед базовыми и будут нормально переживать обновления биллинга. Также, если вам требуется изменить поведение какого-то существующего шаблона (например игнорируемые FDB порты) потрудитесь перед модификацией, скопировать его в content/documents/mysnmptemplates/ и редактировать его уже там.
На данный момент доступны следующие парсеры полученных из OID данных:
Также доступны следующие режимы FDB:
Полностью базируется на базовом формате шаблонов, но имеет свои особенности, о которых будет рассказано ниже. Собственно вся “кумулятивность” заключается в том, что нам не нужно указывать конкретный порт для каждой секции в конце OID'а - мы указываем только OID необходимой нам таблицы, будь то dot1dFdb, dot1qFdb, банальный ifDescr или чуть менее банальный ifAlias. А дальше наш модуль уже самостоятельно переберет все имеющиеся порты и по их индексам постарается достать все, что сможет(ну, из того, что мы укажем в шаблоне, конечно).
Итак, новые параметры секции [define]:
Далее немного об “особенных” секциях:
PORTIFACE - в этой секции указываются OID'ы для получения индексов портов, дескрипшинов и алиасов портов. На закономерный вопрос: “А зачем и дескрипшины, и алиасы?” - даем не менее закономерный ответ: “А зачем они вообще существуют по отдельности?”. Но, если серьезно - логика здесь весьма проста: некоторые девайсы хранят наименования интерфейсов в ifDescr, а некоторые - в ifAlias. Потому наш модуль сначала пытается найти описание порта в ifDescr, а если не находит - тогда уже в ifAlias. И нам абсолютно не нужно над этим заморачиваться. Удобно, не правда ли?
[PORTIFACE] PORTINDEX=".1.3.6.1.2.1.2.2.1.1" PORTDESCR=".1.3.6.1.2.1.2.2.1.2" PORTALIAS=".1.3.6.1.2.1.31.1.1.1.18"
PORTDESC - как и следует из комментария к этой секции, в кумулятивных шаблонах - это просто заглушка. Когда кумулятивный обработчик “встречает” в шаблоне эту секцию - он просто запускает специальный парсер для обработки описаний/наименований портов устройства.
[PORTDESC] ; just a placeholder NAME="Desc"
PORT.1D_FDB, PORT.1Q_FDB - еще две секции, характерные только для кумулятивного режима обработки и не предполагающие использования какого-либо парсера. Предназначены для получения FDB-таблицы девайса. Таблица PORT.1Q_FDB, как более подробная и детальная, используется для получения номеров VLAN для МАС адресов с опрашиваемых портов.
[PORT.1D_FDB] PORTTABLE=".1.3.6.1.2.1.17.4.3.1.2" PORTSTATUS=".1.3.6.1.2.1.17.4.3.1.3" [PORT.1Q_FDB] PORTTABLE=".1.3.6.1.2.1.17.7.1.2.2.1.2" PORTSTATUS=".1.3.6.1.2.1.17.7.1.2.2.1.3"
А ещё мы теперь можем указывать в секциях единицы измерения и величину, на которую нужно поделить возвращённое OID'ом значение, используя параметры DIV и UNITS. Эти параметры могут жить абсолютно раздельно, то есть: для любой секции мы можем указать только один из них. Например, если OID нам возвращает сразу корректное значение, которое не нужно ни на что делить и нам нужно только прицепить к нему единицы измерения, то для секции достаточно указать только один лишь параметр UNITS. Так же стоит отметить, что для корректной обработки этого всего нужно использовать новые парсеры. Выглядит это как-то так:
[SFPTXPOWER] NAME="SFP TX power" OIDS=".1.3.6.1.4.1.14988.1.1.19.1.1.9" DIV=1000 UNITS="dBm" PARSER=sp_parse_division_units [CPU TEMP] NAME="CPU temperature" SECTPOLLMODE="noncumulative" OIDS=".1.3.6.1.4.1.14988.1.1.3.11.0" DIV=10 UNITS="C" PARSER=sp_parse_division_units_noport
Новые парсеры:
Так как же в итоге будет выглядеть кумулятивный шаблон для устройства? Покажем на примере довольно известного девайса Mikrotik RB260GSP / CSS106-1G-4P-1S:
[define] DEVICE=Mikrotik-CSS106_RB260GSP_SW_SFP POLLMODE=cumulative SFPSTARTPORT=5 SFPENDPORT=5 POESTARTPORT=2 POEENDPORT=5 FDB=true FDB_MODE=sw_cumulative FDB_ALLOW_ONLY_PORTS= FDB_IGNORE_PORTS= [PORTIFACE] PORTINDEX=".1.3.6.1.2.1.2.2.1.1" PORTDESCR=".1.3.6.1.2.1.2.2.1.2" PORTALIAS=".1.3.6.1.2.1.31.1.1.1.18" [PORT.1D_FDB] PORTTABLE=".1.3.6.1.2.1.17.4.3.1.2" PORTSTATUS=".1.3.6.1.2.1.17.4.3.1.3" [PORT.1Q_FDB] PORTTABLE=".1.3.6.1.2.1.17.7.1.2.2.1.2" PORTSTATUS=".1.3.6.1.2.1.17.7.1.2.2.1.3" [PORTSTATE] NAME="Port states" OIDS=".1.3.6.1.2.1.2.2.1.8" PARSER=sp_parse_zyportstates [PORTDESC] ; just a placeholder NAME="Desc" [PORTTX] NAME="Bytes transmitted" OIDS=".1.3.6.1.2.1.2.2.1.16" PARSER=sp_parse_zyportbytes [PORTRX] NAME="Bytes received" OIDS=".1.3.6.1.2.1.2.2.1.10" PARSER=sp_parse_zyportbytes [PORTERRTX] NAME="TX errors" OIDS=".1.3.6.1.2.1.2.2.1.20" PARSER=sp_parse_zyportbytes [PORTERRRX] NAME="RX errors" OIDS=".1.3.6.1.2.1.2.2.1.14" PARSER=sp_parse_zyportbytes [PORTMULTTX] NAME="Multicast TX" OIDS=".1.3.6.1.2.1.31.1.1.1.12" PARSER=sp_parse_zyportbytes [PORTMULTRX] NAME="Multicast RX" OIDS=".1.3.6.1.2.1.31.1.1.1.8" PARSER=sp_parse_zyportbytes [PORTBRODTX] NAME="Broadcast TX" OIDS=".1.3.6.1.2.1.31.1.1.1.13" PARSER=sp_parse_zyportbytes [PORTBRODRX] NAME="Broadcast RX" OIDS=".1.3.6.1.2.1.31.1.1.1.9" PARSER=sp_parse_zyportbytes [SFPWAVELENGTH] NAME="SFP wave length" OIDS=".1.3.6.1.4.1.14988.1.1.19.1.1.5" DIV=100 UNITS="nm" PARSER=sp_parse_division_units [SFPTEMP] NAME="SFP temperature" OIDS=".1.3.6.1.4.1.14988.1.1.19.1.1.6" UNITS="C" PARSER=sp_parse_division_units [SFPVOLTAGE] NAME="SFP voltage" OIDS=".1.3.6.1.4.1.14988.1.1.19.1.1.7" DIV=1000 UNITS="V" PARSER=sp_parse_division_units [SFPCURRENT] NAME="SFP current" OIDS=".1.3.6.1.4.1.14988.1.1.19.1.1.8" UNITS="mA" PARSER=sp_parse_division_units [POESTATUS] NAME="POE status" OIDS=".1.3.6.1.4.1.14988.1.1.15.1.1.3" PARSER=sp_parse_mikrotik_poe [POECURRENT] NAME="POE current" OIDS=".1.3.6.1.4.1.14988.1.1.15.1.1.5" UNITS="mA" PARSER=sp_parse_division_units [POEPOWER] NAME="POE power" OIDS=".1.3.6.1.4.1.14988.1.1.15.1.1.6" DIV=10 UNITS="W" PARSER=sp_parse_division_units [UPTIME] NAME="Uptime" SECTPOLLMODE="noncumulative" OIDS=".1.3.6.1.2.1.1.3.0" PARSER=sp_parse_raw_trim_tab [SYSTEM VOLTAGE] NAME="System voltage" SECTPOLLMODE="noncumulative" OIDS=".1.3.6.1.4.1.14988.1.1.3.8.0" DIV=10 UNITS="V" PARSER=sp_parse_division_units_noport [SYSTEM TEMP] NAME="System temperature" SECTPOLLMODE="noncumulative" OIDS=".1.3.6.1.4.1.14988.1.1.3.10.0" DIV=10 UNITS="C" PARSER=sp_parse_division_units_noport [SYSTEM VERSION] NAME="System version" SECTPOLLMODE="noncumulative" OIDS=".1.3.6.1.2.1.1.1.0" PARSER=sp_parse_raw_trim_tab
Начиная с релиза 0.8.4 появилась возможность в процессе опроса, делать устройствам snmp set. Для этого в каждой секции за исключением “define” добавлена возможность указать опцию SETOIDS в формате:
SETOIDS="oid|type|value,oid|type|value"
Где oid является собственно oid-ом, value является значением которое будет установлено, а type указывает на тип и может принимать следующие значения:
Следует также заметить, что секция с SETOIDS может быть самодостаточной и не требует указания других опций, таких как NAME, OIDS или скажем PARSER. В таком случае, она просто проведет по очереди все write операции и завершит свою работу. Вот пример указания port description для двух портов:
[portnames] SETOIDS=".1.3.6.1.2.1.31.1.1.1.18.4|s|testport1,.1.3.6.1.2.1.31.1.1.1.18.5|s|testport2"
Хотя да, никто не запрещает быть ей при этом обычной интерактивной секцией и показывать в процессе своей работы какие-то результаты. Например как-то так:
[portnames] SETOIDS=".1.3.6.1.2.1.31.1.1.1.18.4|s|testport1,.1.3.6.1.2.1.31.1.1.1.18.5|s|testport2" NAME="Ports" OIDS=".1.3.6.1.2.1.31.1.1.1.18.4,.1.3.6.1.2.1.31.1.1.1.18.5" PARSER=sp_parse_raw
В таком случае, следует всегда помнить о том, что сначала всегда выполняются все snmp set операции, а потом уже производиться опрос и рендер указанных в опции OIDS данных.
[define] PON_ONU_PORT_MAX=128
Если вы используете две технологии ПОН у себя в сети и вам нужно перекрыть глобальный обязательный параметр alter.ini PON_ONU_PORT_MAX - то добавьте этот параметр в SNMP шаблоны для OLT и у вас будет нормально отображаться статистика и другие параметры.
Также камрадом DemonidZe был запилен генератор шаблонов опроса оборудования, для тех кому лень самому разбираться.
