← Документация и информация о ПО

Инструкция по эксплуатации программного обеспечения (руководство пользователя и администратора)

Программное обеспечение: XK Server Management Platform (XKSM)
Версия: 2.64.0
Правообладатель: ООО «ХК СЕРВ»
Дата документа: 26.10.2026

ВВЕДЕНИЕ

Настоящее руководство пользователя предназначено для системных администраторов и специалистов ИТ-служб, работающих с платформой XK Server Management Platform (XKSM) версии 2.64.0.

Состав функций определяется лицензией, правами и возможностями BMC. Описание сценария не означает, что он испытан на каждой модели. В офлайн-профиле AI отключён; федерация и внешние СХД требуют отдельной инфраструктуры и разрешений. Версия и commit экземпляра определяются манифестом выпуска. Текущий согласованный состав — Base без AI, федерации и внешних СХД. Сценарии ниже являются порядком работы; успешное выполнение каждого фиксируется отдельным протоколом для фактической сборки и оборудования.

Используемые обозначения

Обозначение Смысл
[Жирный текст] Кнопка или элемент интерфейса
Моноширинный шрифт Команда, URL, путь к файлу
⚠️ Внимание Важное предупреждение
ℹ️ Примечание Дополнительная информация

ГЛАВА 1. НАЧАЛО РАБОТЫ

1.1 Системные требования для рабочего места

1.2 Вход в систему

  1. Откройте браузер и перейдите на адрес вашей инсталляции XKSM: https://your-xksm-server/ (например, https://app.xksm.ru)

  2. Введите Логин (имя пользователя или email) и Пароль.

  3. Если включена двухфакторная аутентификация (2FA), введите шестизначный код из приложения-аутентификатора (Google Authenticator, Яндекс.Ключ или аналогичного).

  4. Нажмите кнопку [Войти].

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

1.3 Первичная настройка (Setup Wizard)

При первом запуске XKSM отображается мастер начальной настройки:

  1. Шаг 1 — Создание организации: Введите название вашей организации.
  2. Шаг 2 — Создание администратора: Задайте логин, email и пароль для учётной записи администратора.
  3. Шаг 3 — Завершение: Нажмите [Завершить настройку].

После завершения мастера вы будете перенаправлены на дашборд.

1.4 Выход из системы

Нажмите на иконку профиля в правом верхнем углу → [Выйти].


ГЛАВА 2. ИНТЕРФЕЙС ПЛАТФОРМЫ

2.1 Структура интерфейса

Интерфейс XKSM состоит из следующих элементов:

2.2 Разделы навигационного меню

Пункт меню Назначение
Дашборд Сводная информация и виджеты
Устройства Список серверов, управление, инвентаризация
Мониторинг Метрики в реальном времени, алерты
Прошивки Управление версиями прошивок
Логи Журналы событий серверов
Отчёты Аналитические отчёты, экспорт данных
Резервирование Настройка и запуск резервного копирования
Планировщик Задачи по расписанию
Пользователи Управление учётными записями (для администраторов)
Настройки Параметры системы

ГЛАВА 3. УПРАВЛЕНИЕ УСТРОЙСТВАМИ

3.1 Просмотр списка устройств

Перейдите в раздел Устройства. Отображается таблица со всеми серверами, добавленными в систему. Доступны фильтрация по производителю, модели, группе, состоянию здоровья, а также поиск по имени или IP-адресу.

3.2 Добавление устройства вручную

  1. Нажмите кнопку [+ Добавить устройство].
  2. Заполните поля: - IP-адрес BMC — адрес контроллера управления (обязательно) - Логин BMC — учётная запись BMC - Пароль BMC — пароль учётной записи BMC - Имя устройства — произвольное название (опционально) - Группа — группа для организации (опционально)
  3. Нажмите [Сохранить]. Система автоматически подключится к BMC и получит доступные инвентарные данные. Проверить совпадение модели и серийного номера с фактическим оборудованием. Для XK требуется валидный Platform Token либо настроенная автоматическая активация; лицензию приложения он не заменяет. При ошибке identity_not_provisioned заводская идентичность BMC ещё не подготовлена: не удалять ключи и не выполнять перепровижен вслепую.

3.3 Пакетный импорт устройств

  1. Подготовьте файл CSV или XLSX с колонками: ip, login, password, name, group
  2. В разделе Устройства нажмите [Импорт] → [Загрузить файл].
  3. Выберите файл и нажмите [Начать импорт].
  4. По завершении отображается отчёт: добавлено / ошибки.

3.4 Сканирование сети

  1. Нажмите [Сканировать сеть].
  2. Введите сетевой диапазон в формате CIDR (например, 192.168.1.0/24).
  3. Укажите учётные данные BMC для обнаруженных устройств (или выберите из ранее сохранённых).
  4. Нажмите [Начать сканирование]. Найденные устройства появятся в списке.

3.5 Карточка устройства

Нажмите на устройство в списке для открытия его карточки. Карточка содержит вкладки:

Вкладка Содержание
Обзор Общие сведения, состояние здоровья, аппаратный состав
Питание Управление питанием, текущее потребление
Прошивки Версии прошивок, обновление
Конфигурация Поддерживаемые BIOS/BMC; advanced RAID требует отдельного допуска
Мониторинг Графики метрик данного сервера
Логи Журналы событий данного сервера
Вендор Специфические OEM-функции (Dell/HPE/Lenovo)

ГЛАВА 4. УПРАВЛЕНИЕ ПИТАНИЕМ

4.1 Базовые операции питания

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

⚠️ Принудительное выключение может привести к потере несохранённых данных в работающей ОС. Используйте только при необходимости.

4.2 Управление Power Cap

  1. На вкладке Питание найдите раздел Ограничение мощности (Power Cap).
  2. Введите значение в ваттах (Вт).
  3. Нажмите [Применить].

4.3 Массовые операции питания

  1. В списке устройств отметьте несколько серверов (чекбоксы).
  2. В верхней панели нажмите [Действия] → выберите операцию питания.
  3. Подтвердите действие.

ГЛАВА 5. ОБНОВЛЕНИЕ ПРОШИВОК

5.1 Просмотр текущих версий

Перейдите в Устройства → карточка устройства → вкладка Прошивки. Отображается таблица всех компонентов с текущей версией прошивки.

Также доступен общий раздел Прошивки в боковом меню — отображает все серверы с версиями ключевых компонентов.

5.2 Загрузка и применение обновления

  1. В карточке устройства, вкладка Прошивки, нажмите [Обновить прошивку].
  2. Выберите компонент для обновления.
  3. Загрузите файл прошивки с вашего компьютера.
  4. Выберите тип применения: - Сейчас — немедленное применение - При следующей перезагрузке — применение после restart
  5. Нажмите [Начать обновление].

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

5.3 История обновлений

В карточке устройства → вкладка Прошивки → раздел История отображается лог всех выполненных операций обновления: компонент, версия до/после, дата, исполнитель, результат.


ГЛАВА 6. МОНИТОРИНГ

6.1 Раздел «Мониторинг»

Перейдите в раздел Мониторинг в боковом меню. Доступны:

6.2 Просмотр метрик

  1. Выберите устройство или группу устройств из выпадающего списка.
  2. Выберите метрику: температура, вентиляторы, напряжение, мощность.
  3. Выберите период: 1 час, 24 часа, 7 дней, 30 дней, произвольный.
  4. График обновляется автоматически.

Статус Online означает доступность опроса BMC, а Off — выключенное питание хоста. LIVE подтверждает поток браузер–XKSM и не гарантирует свежесть данных самого BMC. При таймауте и circuit breaker повторные ручные запросы не ускоряют восстановление; проверьте время последнего успешного сбора и журнал ошибок. Снимки могут быть кэшированными; полная инвентаризация выполняется в фоне.

6.3 Настройка алертов

  1. Перейдите в Мониторинг → Алерты → [+ Создать алерт].
  2. Заполните параметры: - Устройство / группа — к чему применяется алерт - Метрика — датчик (например, CPU Temp) - Условие — больше / меньше порогового значения - Пороговое значение — числовое значение - Уровень — Warning или Critical
  3. Нажмите [Сохранить].

ГЛАВА 7. РАБОТА С ЖУРНАЛАМИ

7.1 Просмотр журналов событий

  1. В карточке устройства перейдите на вкладку Логи, или воспользуйтесь разделом Логи в боковом меню.
  2. Выберите тип журнала: SEL, IEL, LC Log, OS Log (в зависимости от вендора).
  3. Используйте фильтры: дата, уровень критичности (Info / Warning / Critical), категория события, текстовый поиск.

7.2 Экспорт журналов

  1. Настройте фильтры для нужного периода и типа событий.
  2. Нажмите [Экспортировать] → выберите формат: CSV или JSON.
  3. Файл будет скачан автоматически.

7.3 Очистка журналов

В карточке устройства, вкладка Логи: 1. Нажмите кнопку [Очистить журнал]. 2. Подтвердите операцию.

⚠️ Очистка журнала на устройстве необратима. Исторические данные в ClickHouse при этом сохраняются.


ГЛАВА 8. УПРАВЛЕНИЕ ПОЛЬЗОВАТЕЛЯМИ

(Доступно только для ролей: Администратор)

8.1 Просмотр пользователей

Перейдите в Пользователи в боковом меню. Отображается таблица всех учётных записей с ролями и статусом.

8.2 Создание пользователя

  1. Нажмите [+ Добавить пользователя].
  2. Заполните: имя, email, пароль, роль.
  3. Нажмите [Сохранить].

8.3 Роли доступа

Роль Описание
Администратор Полный доступ, управление пользователями и системой
Оператор Управление серверами (включая опасные операции)
Просмотр Только чтение, без права изменений

8.4 Настройка двухфакторной аутентификации

  1. Перейдите в профиль пользователя (иконка в правом верхнем углу).
  2. В разделе Безопасность нажмите [Включить 2FA].
  3. Отсканируйте QR-код приложением-аутентификатором.
  4. Введите код подтверждения из приложения.
  5. Нажмите [Активировать].

8.5 API-ключи

  1. В профиле пользователя перейдите в API-ключи.
  2. Нажмите [Создать ключ], задайте название и срок действия.
  3. Скопируйте ключ — он отображается единственный раз.
  4. Используйте ключ в заголовке X-API-Key при запросах к REST API.

ГЛАВА 9. РЕЗЕРВНОЕ КОПИРОВАНИЕ

9.1 Создание резервной копии

  1. Перейдите в Резервирование → [Создать резервную копию].
  2. Выберите компоненты: настройки платформы, пользователи, устройства, конфигурации серверов.
  3. Нажмите [Запустить]. Прогресс отображается в статусе задачи.

9.2 Восстановление из резервной копии

  1. Перейдите в Резервирование → список резервных копий.
  2. Найдите нужную копию, нажмите [Восстановить].
  3. Подтвердите операцию.

⚠️ Восстановление перезапишет текущие настройки. Рекомендуется предварительно создать актуальную резервную копию.

9.3 Расписание резервного копирования

  1. Перейдите в Резервирование → [Расписание].
  2. Нажмите [+ Добавить расписание].
  3. Укажите компоненты, частоту (ежедневно/еженедельно) и время.
  4. Нажмите [Сохранить].

ГЛАВА 10. ДАШБОРД И ОТЧЁТЫ

10.1 Настройка дашборда

  1. На главной странице (Дашборд) нажмите [Редактировать] (иконка карандаша).
  2. Перетащите виджеты для изменения порядка (drag-and-drop).
  3. Измените размер виджета, потянув за угол.
  4. Нажмите [+ Добавить виджет] для добавления нового блока.
  5. Нажмите [Сохранить компоновку].

10.2 Доступные виджеты

Виджет Описание
Обзор устройств Общее количество серверов, статусы
Активные алерты Список текущих нарушений
Топ по потреблению Серверы с наибольшим энергопотреблением
Активность Последние действия пользователей
Тепловая карта Температурный статус парка

В офлайн-проверочном экземпляре AI-модуль отключён и не входит в заявленный набор функций. Наличие AI-компонентов в исходниках не означает их доступность в этом комплекте. Для отдельной поставки с AI необходимо согласовать зависимости, провайдера, условия использования и провести отдельные испытания.

10.3 Формирование отчётов

  1. Перейдите в Отчёты в боковом меню.
  2. Выберите тип отчёта: инвентаризация, энергопотребление, журнал событий, история обновлений.
  3. Задайте период и фильтры.
  4. Нажмите [Сформировать].
  5. После формирования доступны кнопки [Скачать PDF] и [Экспорт CSV].

ГЛАВА 11. ПЛАНИРОВЩИК ЗАДАЧ

11.1 Создание задачи

  1. Перейдите в Планировщик → [+ Создать задачу].
  2. Заполните: - Название — произвольное наименование - Тип задачи — мониторинг, инвентаризация, сбор логов, резервирование - Расписание — CRON-выражение (например, 0 3 * * * — каждую ночь в 3:00) - Устройства / Группы — к чему применяется задача
  3. Нажмите [Сохранить].

11.2 История выполнения

В разделе Планировщик для каждой задачи доступна кнопка [История]. Отображается журнал всех запусков с временем, статусом и сообщением о результате.


ГЛАВА 12. НАСТРОЙКИ СИСТЕМЫ

(Доступно только для роли Администратор)

12.1 Общие настройки

Настройки → Общие: - Название организации - Логотип - Временная зона

12.2 Интеграции

Настройки → Интеграции: - Настройка webhook-уведомлений - Настройка SMTP для email-уведомлений

12.3 Безопасность

Настройки → Безопасность: - Политика паролей (минимальная длина, сложность) - Количество попыток входа до блокировки - Срок жизни сессии - Обязательная 2FA для всех пользователей


ПРИЛОЖЕНИЕ А. КЛАВИАТУРНЫЕ СОЧЕТАНИЯ

Сочетание Действие
Ctrl+K Быстрый поиск по устройствам
F5 Обновить список устройств
Esc Закрыть диалоговое окно

ПРИЛОЖЕНИЕ Б. КОДЫ СОСТОЯНИЯ

Код Цвет Значение
OK Зелёный Устройство работает нормально
Warning Жёлтый Обнаружена потенциальная проблема
Critical Красный Критическая неисправность
Unknown Серый Состояние неизвестно / нет связи
Offline Тёмный Устройство недоступно

ПРИЛОЖЕНИЕ В. ТЕХНИЧЕСКАЯ ПОДДЕРЖКА

По вопросам работы с XKSM обращайтесь: - Email: support@xkserv.ru - Сайт: https://xkserv.ru/support - Телефон: +7 (499) 504-42-22

Режим работы технической поддержки: будние дни, 09:00–18:00. Часовой пояс уточняется при согласовании сопровождения. По вопросам приобретения и выпуска лицензии: info@xkserv.ru.


XK Server Management Platform — Руководство пользователя v2.64.0 © ООО «ХК СЕРВ», 2026. Все права защищены.

ПРИЛОЖЕНИЕ Г. ЛИЦЕНЗИЯ И ПЕРВЫЙ ПРОГОН

Для локальной поставки используется подписанный файл LICENSE.xksm, выпущенный для согласованных срока, функций и аппаратной привязки. Fingerprint снимается на целевом Linux-хосте после загрузки образов по инструкции установки; он передаётся поддержке по закрытому каналу. Файл загружается штатным установщиком, а не записью BMC-токена. Для переноса на другой хост может потребоваться перевыпуск лицензии. Приватный ключ подписи пользователю и эксперту не передаётся.

После входа отдельного эксперта проверить лицензию, доступ к устройствам и ограничения роли. Подключить сначала один тестовый BMC и проверить чтение инвентаря, датчиков и журналов. До операций записи согласовать окно и резервные копии. Статус Offline/таймаут означает ошибку опроса; статус Critical относится к сообщённому состоянию оборудования. Сам по себе Critical не доказывает неработоспособность приложения или необходимость перепрошивки.

Для диагностики передавать версию/идентификатор сборки, дату, шаги и очищенный фрагмент ошибки. Не передавать .env, keys/, license/, пароли BMC и токены.