Создание обработчика BMC

Вы можете добавить в DCImanager 6 собственный обработчик BMC. Для этого создайте код обработчика и загрузите его в платформу.

Подготовка окружения

Обработчик BMC должен быть написан на языке Python. Рекомендуем использовать версию Python 3.9.

Рекомендуем создать обработчик на основе существующего проекта. Чтобы скопировать проект, подключитесь к серверу-локации DCImanager 6 по SSH и выполните команду:

docker cp eservice_handler:/opt/ispsystem/equip_handler ./

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

/common — общие вспомогательные классы и функции;
/ipmi_common — вспомогательные классы и функции для работы с BMC;
/ipmi_common/handlers — обработчики BMC.

Требуемые библиотеки Python и их версии вы можете посмотреть в файле проекта requirements.txt. Чтобы установить нужные библиотеки, выполните команду:

pip3 install -r requirements.txt

Для проверки типов данных в проекте рекомендуется использовать анализатор mypy.

Создание обработчика

Платформа использует обработчики для взаимодействия с BMC через два протокола:

IPMI — использует утилиту ipmitool;
Redfish — использует REST API.

Обработчик должен наследоваться от базовых классов:

от BaseIpmi — для IPMI;
одновременно от BaseRedfishIpmi и BaseIpmi — для Redfish.

BaseRedfishIpmi — класс, у которого есть методы get, put, post, patch и delete для выполнения соответствующих HTTP запросов к BMC с интерфейсом Redfish.

Для создания экземпляра обработчика BMC также используется класс IpmiData, который содержит информацию о BMC:

IP-адрес;
имя пользователя;
пароль;
другие параметры.

В классе IpmiData есть атрибуты:

device, который отвечает за имя пользовательского обработчика, например "my_handler";
custom_params в него — можно передавать любые параметры, которые могут быть необходимы для работы обработчика.

Файл обработчика должен содержать функцию, которая возвращает экземпляр обработчика:

def make_handler(ipmi_data: IpmiData) -> BaseIpmi:
   """Make handler instance"""
    return MyHandler(ipmi_data)

Если какая-либо функция обработчика должна остаться нереализованной, то вы можете:

написать исключение. Например, NotImplementedError("Is not supported by this handler");
вернуть результат с сообщением о неподдерживаемой операции. Например, return {"result": "Operation is unsupported"}

В методах обработчика можно выбросить исключение, если в ходе выполнения метода возникает ошибка.

Логирование методов

Рекомендуем логировать выполнение методов: это поможет при отладке обработчика. Для этого:

Добавьте в файл обработчика строку:
```
import logging
```
В методах обработчика используйте функции logging.info, logging.debug, logging.warning, logging.error и т.д.;

Загрузка обработчика в платформу

Создайте директорию со следующей структурой:
```
handler_dir/
├── __init__.py
└── my_handler.py
```
Пояснения

handler_dir — имя директории. В платформе не должно быть директории обработчика с таким же именем.
__init__.py — файл инициализации. Если такого файла нет, создайте пустой файл с этим именем.
my_handler.py — файл обработчика
Создайте архив tar.gz с этой директорией:
```
tar -czvf custom_handler.tar.gz handler_dir
```
Пояснения к команде

custom_handler.tar.gz — имя архива
handler_dir –- имя созданной директории с обработчиком
Авторизуйтесь в DCImanager 6 с правами администратора:
```
curl -o- -k https://example.com/api/auth/v4/public/token \
    -H "isp-box-instance: true" \
    -d '{
        "email": "<admin_email>",
        "password": "<admin_pass>"
    }'
```
Пояснения к команде

example.com — доменное имя сервера c DCImanager 6
<admin_email> — email администратора DCImanager 6
<admin_pass> — пароль администратора DCImanager 6

В ответ придёт сообщение вида:
```
{"id":"24","token":"24-cee181d2-ccaa-4b64-a229-234aa7a25db6"}
```
Сохраните из полученного ответа значение параметра token — токена авторизации.
Создайте описание для обработчика:
```
curl -o- -k https://example.com/api/eservice/v3/custom_equipment \
    -H "isp-box-instance: true" \
    -H "x-xsrf-token: <token>" \
    -d '{
        "device_type": "ipmi",
        "handler": "<internal_handler_name>",
        "name": "<handler_name>",
        "protocol": ["<handler_protocol>"],
    }'
```
Пояснения к команде

example.com — доменное имя сервера c DCImanager 6
<token> — токен авторизации
<device_type> — тип устройства. Значение ipmi используется для обработчиков BMC.
<internal_handler_name> — уникальное внутреннее имя обработчика
<handler_name> — имя обработчика для отображения в интерфейсе платформы
<handler_protocol> — протокол для работы с обработчиком. В случае обработчика BMC может быть "lan", "lanplus" или "redfish_v1"

Ответ будет содержать id созданного обработчика. Сохраните это значение.
Пример ответа
```
{"id": 1}
```
Загрузите архив с обработчиком в платформу:
```
curl -o- -k https://example.com/api/eservice/v3/custom_equipment/<handler_id>/content \
    -H "isp-box-instance: true" \
    -H "x-xsrf-token: <token>" \
    -F "data=@custom_handler.tar.gz" \
    -F "handler_import=<import_path>"
```
Пояснения к команде
example.com — доменное имя сервера c DCImanager 6
<handler_id> — id обработчика
<token> — токен авторизации
custom_handler.tar.gz — имя архива с обработчиком
<import_path> — относительный путь для импорта. Например, если файл обработчика my_handler.py находится в директории handler_dir, то относительный путь будет handler_dir.my_handler
Задайте поля device и custom_params для IPMI в dci_back:
```
curl -o- -k https://example.com/dci/v3/ipmi/{ipmi_id} \
    -H "isp-box-instance: true" \
    -H "x-xsrf-token: <token>" \
    -d '{"custom_params" : <custom_handler_params>, "device" : <custom_handler_name>}'
```
Пояснения к команде

example.com — доменное имя сервера c DCImanager 6
<handler_id> — id обработчика
<token> — токен авторизации
<ipmi_id> — номер подключения к BMC по Redfish или IPMI
<custom_handler_name> — имя обработчика
<custom_handler_params> — собственные параметры пользовательского обаботчика, которые будут переданы в экземляр обработчика при его создании в методе init(). В них можно передать любые параметры, которые могут быть необходимы для работы обработчика.

В случае успешного запроса вернётся ответ вида:
```
{"id": 1}
```

После этого вы можете использовать пользовательский обработчик для управления BMC. Для этого запустите опрос BMC в графическом интерфейсе DCImanager или выполните запрос:

curl 'https://example.com/dci/v3/ipmi/1/status' \
-H "isp-box-instance: true" \
-H "x-xsrf-token: <token>" \
-d '{}'

После этого в контейнере службы eservice_handler в директории /opt/ispsystem/equip_handler/custom_handlers/ipmi должна появиться директория handler_dir, содержащая файлы из архива обработчика.

Связанные статьи:

Дата последнего обновления статьи: 01.10.2025. Статья подготовлена техническими писателями ISPsystem