Update project description and enhance documentation for clarity
- Revised the project description in `pyproject.toml` to better reflect the functionality of the `oxipy` client. - Improved the README.md by adding detailed explanations of the project structure, installation instructions, and usage examples. - Updated documentation files to enhance clarity and organization, including sections on extending models and writing TTP templates. - Adjusted various TTP templates to ensure consistency and accuracy in the parsing of device configurations.
This commit is contained in:
@@ -1,41 +1,20 @@
|
||||
<doc>
|
||||
Базовый шаблон для нового устройства. Скопируйте этот файл, переименуйте
|
||||
в <vendor>.ttp и заполните группы под формат конфигурации вашего устройства.
|
||||
Base template for a new device parser. Copy this file, rename it to
|
||||
<vendor>.ttp, and fill the groups for the target configuration format.
|
||||
|
||||
Обязательные группы: system, interfaces.
|
||||
Опциональная группа: vlans — добавляйте только если устройство поддерживает VLAN.
|
||||
Required groups: system, interfaces.
|
||||
Optional group: vlans. Add it only when VLAN parsing is implemented.
|
||||
|
||||
--- Группа system ---
|
||||
Должна возвращать одиночный словарь с полями:
|
||||
model (str) — модель устройства
|
||||
serial_number (str) — серийный номер
|
||||
version (str) — версия прошивки
|
||||
system must return one dictionary with: model, serial_number, version.
|
||||
interfaces must return a list of dictionaries with: interface, ip_address,
|
||||
mask, description. Use a prefix length for mask; convert dotted decimal masks
|
||||
with `to_cidr` or in the device class.
|
||||
vlans must return dictionaries with vlan_id and optional name/description.
|
||||
|
||||
--- Группа interfaces ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
interface (str) — имя интерфейса (alias поля name)
|
||||
ip_address (str|None) — IPv4-адрес
|
||||
mask (int|None) — длина префикса (напр. 24)
|
||||
description (str|None) — описание интерфейса
|
||||
Useful TTP modifiers: ORPHRASE, _start_, strip(), replace(), exclude(),
|
||||
ignore, ignore('.*'), to_cidr, unrange(), split().
|
||||
|
||||
Если устройство возвращает маску в виде 255.255.255.0, конвертируйте
|
||||
её в prefix length в методе interfaces() класса устройства.
|
||||
|
||||
--- Группа vlans ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
id (int) — номер VLAN (alias поля vlan_id)
|
||||
description (str|None) — название VLAN (alias поля name)
|
||||
|
||||
--- Полезные модификаторы TTP ---
|
||||
{{ field | ORPHRASE }} — одно слово или фраза до конца строки
|
||||
{{ field | _start_ }} — начало новой записи группы
|
||||
{{ field | strip('"') }} — убрать кавычки
|
||||
{{ field | replace("yes","True") }} — замена подстроки
|
||||
{{ field | exclude("pattern") }} — пропустить строку при совпадении
|
||||
{{ ignore }} — захватить и выбросить значение
|
||||
{{ ignore('.*') }} — выбросить всё до конца строки
|
||||
|
||||
Подробнее: docs/templates.md
|
||||
See docs/templates.md for details.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
@@ -1,41 +1,10 @@
|
||||
<doc>
|
||||
Базовый шаблон для нового устройства. Скопируйте этот файл, переименуйте
|
||||
в <vendor>.ttp и заполните группы под формат конфигурации вашего устройства.
|
||||
Eltex configuration parser.
|
||||
|
||||
Обязательные группы: system, interfaces.
|
||||
Опциональная группа: vlans — добавляйте только если устройство поддерживает VLAN.
|
||||
|
||||
--- Группа system ---
|
||||
Должна возвращать одиночный словарь с полями:
|
||||
model (str) — модель устройства
|
||||
serial_number (str) — серийный номер
|
||||
version (str) — версия прошивки
|
||||
|
||||
--- Группа interfaces ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
interface (str) — имя интерфейса (alias поля name)
|
||||
ip_address (str|None) — IPv4-адрес
|
||||
mask (int|None) — длина префикса (напр. 24)
|
||||
description (str|None) — описание интерфейса
|
||||
|
||||
Если устройство возвращает маску в виде 255.255.255.0, конвертируйте
|
||||
её в prefix length в методе interfaces() класса устройства.
|
||||
|
||||
--- Группа vlans ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
id (int) — номер VLAN (alias поля vlan_id)
|
||||
description (str|None) — название VLAN (alias поля name)
|
||||
|
||||
--- Полезные модификаторы TTP ---
|
||||
{{ field | ORPHRASE }} — одно слово или фраза до конца строки
|
||||
{{ field | _start_ }} — начало новой записи группы
|
||||
{{ field | strip('"') }} — убрать кавычки
|
||||
{{ field | replace("yes","True") }} — замена подстроки
|
||||
{{ field | exclude("pattern") }} — пропустить строку при совпадении
|
||||
{{ ignore }} — захватить и выбросить значение
|
||||
{{ ignore('.*') }} — выбросить всё до конца строки
|
||||
|
||||
Подробнее: docs/templates.md
|
||||
The system group reads software version data and the serial group extracts
|
||||
serial numbers from the unit table. The interfaces group parses interface IP
|
||||
settings. The vlans group supports named VLAN interfaces and compressed VLAN
|
||||
lists.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
@@ -1,41 +1,9 @@
|
||||
<doc>
|
||||
Базовый шаблон для нового устройства. Скопируйте этот файл, переименуйте
|
||||
в <vendor>.ttp и заполните группы под формат конфигурации вашего устройства.
|
||||
H3C configuration parser.
|
||||
|
||||
Обязательные группы: system, interfaces.
|
||||
Опциональная группа: vlans — добавляйте только если устройство поддерживает VLAN.
|
||||
|
||||
--- Группа system ---
|
||||
Должна возвращать одиночный словарь с полями:
|
||||
model (str) — модель устройства
|
||||
serial_number (str) — серийный номер
|
||||
version (str) — версия прошивки
|
||||
|
||||
--- Группа interfaces ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
interface (str) — имя интерфейса (alias поля name)
|
||||
ip_address (str|None) — IPv4-адрес
|
||||
mask (int|None) — длина префикса (напр. 24)
|
||||
description (str|None) — описание интерфейса
|
||||
|
||||
Если устройство возвращает маску в виде 255.255.255.0, конвертируйте
|
||||
её в prefix length в методе interfaces() класса устройства.
|
||||
|
||||
--- Группа vlans ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
id (int) — номер VLAN (alias поля vlan_id)
|
||||
description (str|None) — название VLAN (alias поля name)
|
||||
|
||||
--- Полезные модификаторы TTP ---
|
||||
{{ field | ORPHRASE }} — одно слово или фраза до конца строки
|
||||
{{ field | _start_ }} — начало новой записи группы
|
||||
{{ field | strip('"') }} — убрать кавычки
|
||||
{{ field | replace("yes","True") }} — замена подстроки
|
||||
{{ field | exclude("pattern") }} — пропустить строку при совпадении
|
||||
{{ ignore }} — захватить и выбросить значение
|
||||
{{ ignore('.*') }} — выбросить всё до конца строки
|
||||
|
||||
Подробнее: docs/templates.md
|
||||
The system group reads boot image version and board model data. The interfaces
|
||||
group parses interface IP settings. The vlans groups parse both named VLANs and
|
||||
range-style VLAN declarations.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
@@ -1,40 +1,9 @@
|
||||
<doc>
|
||||
Базовый шаблон для нового устройства. Скопируйте этот файл, переименуйте
|
||||
в <vendor>.ttp и заполните группы под формат конфигурации вашего устройства.
|
||||
Huawei VRP configuration parser.
|
||||
|
||||
Обязательные группы: system, interfaces.
|
||||
Опциональная группа: vlans — добавляйте только если устройство поддерживает VLAN.
|
||||
|
||||
--- Группа system ---
|
||||
Должна возвращать одиночный словарь с полями:
|
||||
model (str) — модель устройства
|
||||
serial_number (str) — серийный номер
|
||||
version (str) — версия прошивки
|
||||
|
||||
--- Группа interfaces ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
interface (str) — имя интерфейса (alias поля name)
|
||||
ip_address (str|None) — IPv4-адрес
|
||||
mask (int|None) — длина префикса (напр. 24)
|
||||
description (str|None) — описание интерфейса
|
||||
|
||||
Если устройство возвращает маску в виде 255.255.255.0, конвертируйте
|
||||
её в prefix length в методе interfaces() класса устройства.
|
||||
|
||||
--- Группа vlans ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
id (int) — номер VLAN (alias поля vlan_id)
|
||||
description (str|None) — название VLAN (alias поля name)
|
||||
|
||||
--- Полезные модификаторы TTP ---
|
||||
{{ field | ORPHRASE }} — одно слово или фраза до конца строки
|
||||
{{ field | _start_ }} — начало новой записи группы
|
||||
{{ field | strip('"') }} — убрать кавычки
|
||||
{{ field | replace("yes","True") }} — замена подстроки
|
||||
{{ field | exclude("pattern") }} — пропустить строку при совпадении
|
||||
{{ ignore }} — захватить и выбросить значение
|
||||
{{ ignore('.*') }} — выбросить всё до конца строки
|
||||
Подробнее: docs/templates.md
|
||||
The system group reads VRP version and slot ESN data. The interfaces group
|
||||
parses interface blocks and converts dotted decimal masks to prefix lengths.
|
||||
The vlans group parses `vlan batch` declarations and emits VLAN IDs.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
@@ -1,4 +1,13 @@
|
||||
<doc>
|
||||
Qtech switch configuration parser.
|
||||
|
||||
The system group reads the model, serial number, and build number. For Qtech,
|
||||
system.version intentionally stores the build number from lines like
|
||||
`Version 2.2.0C Build 96279`.
|
||||
|
||||
The interfaces group parses CLI interface blocks and converts dotted decimal
|
||||
masks to prefix lengths. The vlans group supports named VLANs, comma-separated
|
||||
VLAN lists, ranges, and continuation lines.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
@@ -1,41 +1,10 @@
|
||||
<doc>
|
||||
Базовый шаблон для нового устройства. Скопируйте этот файл, переименуйте
|
||||
в <vendor>.ttp и заполните группы под формат конфигурации вашего устройства.
|
||||
Quasar configuration parser.
|
||||
|
||||
Обязательные группы: system, interfaces.
|
||||
Опциональная группа: vlans — добавляйте только если устройство поддерживает VLAN.
|
||||
|
||||
--- Группа system ---
|
||||
Должна возвращать одиночный словарь с полями:
|
||||
model (str) — модель устройства
|
||||
serial_number (str) — серийный номер
|
||||
version (str) — версия прошивки
|
||||
|
||||
--- Группа interfaces ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
interface (str) — имя интерфейса (alias поля name)
|
||||
ip_address (str|None) — IPv4-адрес
|
||||
mask (int|None) — длина префикса (напр. 24)
|
||||
description (str|None) — описание интерфейса
|
||||
|
||||
Если устройство возвращает маску в виде 255.255.255.0, конвертируйте
|
||||
её в prefix length в методе interfaces() класса устройства.
|
||||
|
||||
--- Группа vlans ---
|
||||
Должна возвращать список словарей. Каждый элемент:
|
||||
id (int) — номер VLAN (alias поля vlan_id)
|
||||
description (str|None) — название VLAN (alias поля name)
|
||||
|
||||
--- Полезные модификаторы TTP ---
|
||||
{{ field | ORPHRASE }} — одно слово или фраза до конца строки
|
||||
{{ field | _start_ }} — начало новой записи группы
|
||||
{{ field | strip('"') }} — убрать кавычки
|
||||
{{ field | replace("yes","True") }} — замена подстроки
|
||||
{{ field | exclude("pattern") }} — пропустить строку при совпадении
|
||||
{{ ignore }} — захватить и выбросить значение
|
||||
{{ ignore('.*') }} — выбросить всё до конца строки
|
||||
|
||||
Подробнее: docs/templates.md
|
||||
The system group supports Assembly-based and Engine-based firmware blocks. The
|
||||
interfaces group parses the management Ethernet address, while bulkinterfaces
|
||||
collects per-port descriptions that the Python model merges into interface
|
||||
records.
|
||||
</doc>
|
||||
<vars>
|
||||
default_system = {
|
||||
|
||||
Reference in New Issue
Block a user