Введение

Настоящий документ содержит руководство по эксплуатации программного продукта vNMS — Virtual Network Management System. Документ предназначен для администраторов и операторов, осуществляющих повседневное управление, мониторинг и обслуживание программного обеспечения.

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

Целевая аудитория

Администраторы, осуществляющие управление экземплярами vNMS

Операторы, выполняющие мониторинг и контроль работоспособности

Инженеры, участвующие в настройке и оптимизации параметров работы

Специалисты технической поддержки

Необходимая квалификация

Уверенное владение командной строкой (Linux bash, Windows PowerShell)

Понимание основ сетевых технологий и протоколов (HTTP, REST API)

Навыки анализа текстовых файлов журналов

1. Запуск и остановка программного обеспечения

1.1 Запуск программы

Программа поставляется в собранном виде в составе исполняемого файла или может быть запущена непосредственно из исходного кода.

Запуск из исходного кода:

bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j
./build/vnms --help

При запуске программа выполняет следующие действия:

Выполняет миграции схемы базы данных при необходимости

Инициализирует встроенное хранилище (SQLite)

Загружает конфигурационные параметры из переменных окружения

Выводит сообщение о готовности с информацией о режиме работы

1.2 Останов программы

Штатная остановка:

Нажмите Ctrl+C (SIGINT) в окне терминала. Программа выполняет:

Завершение обработки текущих операций

Закрытие соединения с базой данных

Завершение процесса

Принудительная остановка (только в крайнем случае):

bash
kill -TERM <PID> # Linux
taskkill /PID <PID> # Windows

1.3 Перезапуск программы

Для полного перезапуска остановите программу и запустите заново.

2. Консоль управления и CLI

Управление осуществляется через интерфейс командной строки (CLI).

2.1 Доступ к CLI

Базовый формат команд:

bash
vnms <команда> <подкоманда> [параметры]

Глобальные ключи:

2.2 Команды мониторинга состояния

Проверка общего статуса системы:

bash
vnms status

Проверка состояния сетевых элементов:

bash
vnms ne list
vnms ne show <имя_узла>

Проверка активных аварий:

bash
vnms alarm list --active
vnms alarm stats

Проверка загруженных измерений:

bash
vnms pm summary
vnms pm counters --like="pm*"

2.3 Команды управления

Управление сетевыми элементами:

bash

Управление конфигурацией (дерево управляемых объектов):

bash

Управление авариями:

bash

Управление загрузкой измерений:

bash

Управление KPI:

bash

Управление отчётами:

bash

3. Конфигурирование программы

3.1 Параметры конфигурации

Программа использует следующие способы конфигурации:

Переменные окружения

Параметры командной строки

Файл базы данных

Основные параметры:

VNMS_DB — путь к файлу базы данных (по умолчанию vnms.db)

Параметры командной строки:

--db=<файл> — база данных

--log-level=error|warn|info|debug — подробность лога

--log-json — лог машиночитаемыми строками JSON

--log-file=<файл> — дублировать лог в файл

3.2 Пример конфигурации (переменные окружения)

bash
VNMS_DB=/opt/vnms/data/vnms.db

3.3 Изменение конфигурации в процессе эксплуатации

Для изменения параметров конфигурации требуется перезапуск программы.

Постоянное изменение:

Остановите программу (Ctrl+C или через системный сигнал)

Измените необходимые переменные окружения

Запустите программу заново

4. Мониторинг и сбор диагностической информации

4.1 Журнал событий

Программа ведёт журнал с выводом на консоль (stderr). Формат строки журнала:

text
YYYY-MM-DD HH:MM:SS.mmm [LEVEL] [ИСТОЧНИК] Сообщение

Пример строки журнала:

text
2026-04-07 16:40:05.691 [INFO ] [PM_LOADER] Starting collection from directory InputData

Уровни журнала: error, warn, info, debug.

4.2 Мониторинг состояния системы

Программа предоставляет следующие команды для мониторинга состояния:

Получение общего статуса:

bash

Вывод сводки:

text

Получение информации о сетевых элементах:

bash

Получение списка активных аварий:

bash

Получение информации о загруженных измерениях:

bash

4.3 Мониторинг использования ресурсов

Процессор и память (Linux):

bash
top -p $(pgrep -f vnms)

4.4 Сбор диагностического пакета

При возникновении инцидента соберите следующие данные:

Версия программы (из vnms --version)

Вывод команд:

bash

Информация об окружении (Linux):

bash
uname -a
cat /etc/os-release

5. Типовые эксплуатационные процедуры

5.1 Ежедневные операции

Проверка работоспособности:

bash

Проверка загрузки измерений:

bash

Проверка статуса активаций (при наличии заданий на сбор):

bash

5.2 Еженедельные операции

Анализ ключевых метрик (количество активаций, успехов, сбоев):

bash

Проверка состояния зарегистрированных сетевых элементов:

bash

5.3 Ежемесячные операции

Анализ производительности (среднее количество операций, пиковые нагрузки):

Экспорт отчётов за период:

bash

Резервное копирование базы данных:

bash
cp vnms.db vnms.db.$(date +%Y%m%d)

Проверка актуальности версии: сравните текущую версию с последним релизом.

5.4 Действия в нештатных ситуациях

Программа не отвечает на команды:

Проверьте, запущен ли процесс:

bash
ps aux | grep vnms # Linux
Get-Process vnms # Windows

Проверьте состояние базы данных:

bash
sqlite3 vnms.db "SELECT * FROM schema_version"

Принудительно остановите и запустите заново.

Загрузка измерений завершилась со сбоем (FAILED):

Проверьте логи загрузки:

bash
vnms pm rops --status=FAILED

Проверьте наличие алармов:

bash
vnms alarm list --active

При необходимости выполните повтор:

bash
vnms pm collect --dir=InputData --force

KPI показал нарушения порогов:

Проверьте результаты KPI:

bash
vnms kpi results --kpi="*" --limit=10
vnms kpi check --no-alarm

Проверьте связанные аварии:

bash
vnms alarm list --source=KPI

При необходимости скорректируйте пороги KPI:

bash

Блокировка сетевого элемента (maintenance mode):

Блокировка сетевого элемента в конфигурации:

bash

Разблокировка:

bash

6. Взаимодействие со смежными системами

6.1 Проверка доступности

Проверка доступности базы данных:

bash

6.2 Мониторинг с внешних систем

Программа может интегрироваться с внешними системами мониторинга через:

Анализ журнала (syslog):

bash
tail -f /var/log/vnms.log | while read line; do
if echo "$line" | grep -q "ERROR|CRITICAL"; then

Отправка alert во внешнюю систему

fi
done

Экспорт отчётов для внешних систем:

bash

Приложение А. Быстрый справочник команд (CLI)

Быстрый скрипт для bash:

bash

Статус

vnms status

Активные аварии

vnms alarm list --active

Состояние узлов

vnms ne list

Сводка по измерениям

vnms pm summary

Список KPI

vnms kpi list

Проверка порогов

vnms kpi check

Отчёт по авариям

vnms report alarms --format=txt

Отчёт по KPI

vnms report kpi --format=csv

Приложение Б. Расположение файлов