Агент на PHP
Требования системы
Агент и сервер не требуют большого количества системных ресурсов, таких как ЦП, ОЗУ или место на жестком диске.
Требования к программному обеспечению
| ПО | Минимальные требования к оборудованию | Требования к ПО |
|---|---|---|
| Агент |
|
|
Сервер инфраструктуры настроен на экземпляре SimpleOne как запись справочника, которая включает в себя подходящую бизнес-логику со стороны сервера и клиента.
Процедура взаимодействия
Для настройки взаимодействия выполните следующие шаги:
- Установите агента инфраструктуры на сервер Microsoft Windows в пользовательской инфраструктуре.
- Настройте ваш экземпляр SimpleOne.
- Настройте агент инфраструктуры.
В результате взаимодействие настроено и начинает работать. Агент отправляет запросы на сервер, чтобы получить задачи. Вы можете настроить интервал запросов в Планировщике заданий Windows (по умолчанию интервал составляет 1 минуту).
- Если нет задач для выполнения, агент выполняет дальнейшие попытки отправки запросов в настроенный интервал времени.
- Если есть задачи для выполнения, агент начинает их выполнять.
- Агент соединяется с сервером для отчета о выполнении задач, независимо от того, были они завершены успешно или нет.
Разрешите соединение агент→сервер в правилах вашего брандмауэра.
Схематично этот процесс выглядит следующим образом:
Настройка инфраструктурного сервера
Логика таблицы Серверы MID находится в разработке и будет дополнена в будущих версиях платформы.
Чтобы добавить параметры сервера в соответствующую таблицу, выполните следующие действия:
- Перейдите в Серверы MID → Серверы MID.
- Нажмите Создать и заполните поля.
- Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.
Поля формы Серверы MID
| Поле | Обязательно | Описание |
|---|---|---|
| Наименование | Да | Укажите имя сервера инфраструктуры, отображаемое в списке. |
| Имя хоста | Да | Укажите имя хоста внешнего сервера, к которому необходимо подключиться. Например, mid_server. |
| Пользователь | Да | Укажите системного пользователя с доступом к функциональности агента инфраструктуры. Пользователь должен иметь роль admin. |
Инфраструктурный агент на PHP содержит два BAT-файла:
- первый: для добавления инфраструктурного агента, который запускается внешним серверным расписанием.
- второй: для удаления инфраструктурного агента из планировщика.
Эта функциональность обеспечивает мониторинг обработки задач с учетом заданного интервала.
Настройка агента инфраструктуры
Извлеките zip-архив с файлами инфраструктурного агента и выполните следующие шаги:
- Найдите конфигурационный файл .env в папке bin инфраструктурного агента.
- Скопируйте ваш файл .env.пример в файл .env и измените его в соответствии с настройками вашего экземпляра.
Описание файла настройки инфраструктурного сервера
| Поле | Описание |
|---|---|
| MID_API_USERNAME | Имя пользователя системы с предоставленным доступом к агенту инфраструктуры. |
| MID_API_PASSWORD | Пароль указанного пользователя. |
| MID_API_SERVERID | ID сервера, настроенного ранее в таблице Серверы MID. |
| MID_API_ENDPOINT | Ссылка на экземпляр SimpleOne, на котором будет работать сервер MID. |
Пример заполненных значений:
- MID_API_USERNAME=admin
- MID_API_PASSWORD=123456
- MID_API_SERVERID=157237947616342741
- MID_API_ENDPOINT=
https://instance.example.com/rest
Добавление скриптов
После настройки агента инфраструктуры вам необходимо настроить для него скрипты PowerShell.
Инструкции по написанию скриптов в PowerShell не входят в эту статью. Всю необходимую информацию вы можете найти на сайте продуктовой документации PowerShell.
- Перейдите в Серверы MID → Скрипты MID.
- Нажмите Создать и заполните поля.
- Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.
Поля формы Скрипты MID
| Поле | Обязательно | Описание |
|---|---|---|
| Наименование | Да | Укажите имя сервера инфраструктуры, отображаемое в списке. |
| Описание | Нет | Введите краткое описание скрипта. |
| Активен | Нет | Установите флажок, чтобы активировать запись скрипта. |
| Скрипт | Да | Укажите скрипт, который будет обрабатывать необходимые задачи и обязанности, связанные с соответствующей деятельностью. |
В этих скриптах вы можете использовать переменные для облегчения обмена данными между клиентской инфраструктурой и экземплярами SimpleOne.
Например, вы можете указать такое определение в своем скрипте MID:
$title='Title:\n';Write-Host($title);Write-Host($param1);
После этого значение переменной title должно быть передано в поле Запрос соответствующей записи Очереди MID:
{"param1":"String value"}
После выполнения скрипта поле Ответ в соответствующей записи Очереди MID будет содержать следующее значение:
Title:
String value
Настройка задачи
Для настройки задач на элементе внешней инфраструктуры необходимо создать запись в таблице Очереди MID (sys_mid_queue). Для этого выполните следующие действия:
- Перейдите в Серверы MID → Очереди MID.
- Нажмите Создать и заполните поля.
- Нажмите Сохранить или Сохранить и выйти, чтобы применить изменения.
Поля формы Очередь MID
| Поле | Обязательно | Описание |
|---|---|---|
| Запрос | Нет | Введите запрос к внешнему серверу в формате JSON. |
| Ответ | Нет | Ответ сервера, содержащий выходные данные команды (ответ stdout) и другую информацию. Это поле заполняется автоматически. Максимальный размер данных – 2,5Мб. Превышение этого объема приведет ошибке валидации, запись не будет сохранена. |
| Описание | Нет | Укажите краткое описание задачи. |
| Сервер | Да | Укажите запись, содержащую информацию о настроенном ранее сервере инфраструктуры в таблице Серверы MID. |
| Скрипт | Да | Укажите запись, содержащую скрипт инфраструктуры, настроенный ранее, в таблице Скрипты MID. |
| Статус | Да | Статус задания. Это поле заполняется автоматически. Возможные варианты:
2. Если внешний сервер не отвечает более минуты, работа скрипта будет остановлена. В этом случае соответствующее задание не вернет код ошибки. 3.При необходимости вы можете запустить задание вручную. Для этого выполните команду run:job где job – название задания, которое необходимо выполнить.bin\agent – относительный путь к установочной папке инфраструктурного агента. Если вы сохранили его в другой папке, укажите полный путь. Иначе задание не будет выполнено. |
| Обработано в | Нет | Дата и время обработки запроса. |