Загальний опис
Історія змін
Рекомендації до оновлення
Плани на майбутнє
Відомі проблеми
Онлайн демо
Допомога проекту
Люди
Трохи про безпеку
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 был запилен генератор шаблонов опроса оборудования, для тех кому лень самому разбираться.
