В предыдущей статье описан плагин интеграции vRealize Automation с phpIPAM. Для организации полноценной работы с phpIPAM потребуется пакет для vRealize Orchestrator, это позволит задействовать IPAM в процессах автоматизации. Пакет включает набор процессов для вызова самых востребованных функций phpIPAM.
Официальная документация по API phpIPAM содержит описание всех доступных функций. Описание функций недостаточно полное, часто не хватает списка обязательных параметров и их описаний.
Пакет интеграции с phpIPAM
v3.0.1
В новой версии пакета расширился набор процессов (список процессов). Также переработаны все основные процессы.
Процесс выполнения запроса
Все параметры для соединения с сервером хранятся в конфигурационном элементе phpipam_api. Основной процесс, который выполняет все запросы к API phpIPAM называется «Invoke a REST operation (phpIPAM)». На вход процесс принимает параметры запроса: param_0 .. param_3, тело запроса content, если оно необходимо, и название REST-операции.
Для работы с API в phpIPAM необходимо создать «API key» (пункт меню Administration -> API) с параметром App security равным «SSL with App code token». В конфигурационном элементе сохраняются App ID в атрибуте appId и App Code в token.
Дополнительный необязательный параметр процесса restHostVariable позволяет задать имя переменной конфигурационного элемента phpipam_api, в котором хранится ссылка на REST-хост. Этот параметр нужен при работе с несколькими серверами phpIPAM (на каждом сервере необходимо создать одинаковые App ID и App Code).
Процесс «Invoke a REST operation (phpIPAM)»:
- находит на REST-хосте объект REST:RESTOperation по его имени;
- поиск может осуществляется по всем хостам, указанным в переменных конфигурационного элемента (параметры, имеющие тип REST:RESTHost, Вы можете указать в конфигурационном элементе несколько REST-хостов, имена параметров с хостами не имеют значения);
- если значение restHostVariable не задано, то используется первый найденный объект REST:RESTOperation с указанным именем;
- получает токен из конфигурационного элемента и отправляет запрос на REST-сервер;
- возвращает ответ сервера;
- в случае ошибки формирует json-строку с ответом сервера.
Подготовка пакета к работе
1. Установка пакета в vRealize Orchestrator
- скачайте vRO пакет phpipam.package;
- импортируйте пакет в оркестратор через вкладку Packages;
- проверьте, что успешно импортированы процессы и конфигурационный элемент;
2. Регистрация REST-хоста phpIPAM
- используйте стандартный процесс “Add a REST host”;
- выберите тип аутентификации: “Host’s authentication type” = “NONE”;
3. Настройка
Запустите процесс «Initialize (phpIPAM)». Подготовка пакета к работе включает:
- Выбор основного REST-хоста (остальные добавьте в конфигурационный элемент самостоятельно);
- Запуск процесса регистрации используемых REST-операций: «Add REST operations (phpIPAM)»;
- Сохранение токена phpIPAM в конфигурационном элементе phpipam_api.
Загрузка плагина и список процессов
Пишите вопросы и предложения по доработке.