Задача: REST API
Обзор возможностей
Задача REST API позволяет собирать данные с VMware.
Полный список собираемых данных вы можете посмотреть в справочнике.
Предварительные настройки
Настройка учетных записей
Для выполнения задачи вам понадобятся учетные данные пользователей, через которых будет работать агент для выполнения задачи.
Учетная запись должна обладать правами администратора.
После того, как вы настроите учетную запись на компьютере, добавьте ее данные в справочник Администрирование / Учетные данные.
В задачах используются учетные данные, у которых Платформа = RestAPI.
Настройка SQL-запросов
Запросы для получения данных задаются отдельно от создания задачи с помощью сенсоров.
Вы можете это сделать в разделе Сбор данных / Сенсоры.
Далее, при создании задачи вы сможете выбрать сенсоры с соответствующими запросами на шаге Нормализация.
Создание задачи
Для создания задачи
- Наведите курсор на раздел Сбор данных в верхнем меню.
- Выберите пункт Управление инвентаризацией в открывшемся подменю.
- Нажмите кнопку Создать задачу в правом верхнем углу открывшейся страницы.
Выбор типа задачи
После нажатия на кнопку Создать задачу откроется пошаговый мастер. На первом шаге:
- Нажмите кнопку REST API.
Настройка задачи
После выбора вы перейдете на шаг настроек задачи.
Заполните базовые свойства задачи:
- Наименование задачи – укажите любое удобное вам значение.
- Метки (опционально) – ключевые слова, теги, которые потом можно использовать для поиска и фильтрации списка задач.
- Приоритетность (опционально) – число, которое определяет приоритет запуска задачи. Если две задачи имеют одинаковую дату и время старта, то в начале будет выполнена задачи с наибольшим приоритетом.
Подключение к базе данных
Заполните данные для подключения работы с API, для этого заполните поля:
- Сервер - адрес сервера, например: https://vmware.vcenter.ru.
- Апи для получения ключа сессии - например: /rest/com/vmware/cis/session
- Апи для получения списка инвентаризируемых объектов - например: api/vcenter/mv
- Пользователь - выберите пользователя, от лица которого будут выполняться запросы для выполнения задачи.
Для выбора пользователя:- Нажмите на поле Пользователи.
- Откроется список пользователей, добавленных в систему. Управление списком осуществляется в разделе Администрирование / Учетные данные. В списке отображаются только пользователи, у которых указана платформа "RestApi"
- Выберите пользователя или нажмите кнопку Добавить, если нужного пользователя нет в списке.
- Проверка сертификата
Объекты инвентаризации
Добавьте объекты инвентаризации - это определит данные, которые будут получены в рамках задачи.
Для этого:
- В блоке Объекты инвентаризации нажмите кнопку Добавить объект.
- Отобразится поле для выбора объекта.
- Выберите необходимый объект из списка.
Обратите внимание, запросы для получения данных задаются с помощью сенсоров. Выбрать, какие сенсоры использовать для каждого объекта инвентаризации вы сможете далее на шаге Нормализация. - Нажмите кнопку Добавить рядом с полем, чтобы подтвердить выбор, или кнопку Отменить, чтобы отменить добавление.
Вы можете добавить несколько объектов таким образом.
Если вы хотите удалить добавленный объект, то нажмите иконку в строке объекта.
Расписание запуска
После того, как все цели добавлены, заполните расписание запуска задачи:
В случае, если расписание не заполнено, то дата старта заполнится автоматически текущей датой и выполнение задачи запустится сразу после ее создания.
Для настройки расписания заполните поля:
- Дата старта - дата и время начала выполнения задачи. Если не заполнено, то при создании задачи поле автоматически заполнится текущей датой и временем.
- Повторять - позволяет задать правила автоматического повторного запуска задачи.
Узнайте подробнее о возможностях настройки расписания »
После этого нажмите кнопку Далее, чтобы перейти на следующий шаг выполнения задачи.
Дальнейшие шаги мастера задач
Заполнение дальнейших шагов аналогично задаче сбора данных для инвентаризации:
- Настройка агентов
- Нормализация
Важно! на этом шаге выберите сенсоры для каждого объекта инвентаризации, которые вы добавили на шаге настройки задачи. Отключите источники данных, которые вы не добавляли в объекты инвентаризации. - Идентификация
- Обогащение
Запуск задачи
Запуск задачи выполняется аналогично задаче сбора данных для инвентаризации.
Просмотр истории
Вы можете посмотреть статусы выполнения задачи агентов в разделе История на странице редактирования задачи.
Для этого:
- Перейдите в раздел Сбор данных / Управление инвентаризацией с помощью верхнего меню.
- Найдите задачу в списке.
- Нажмите на название задачи, чтобы открыть ее на редактирование.
- Перейдите в раздел История с помощью меню слева.
Результат выполнения задачи
Результат выполнения задачи доступен в раздел Сбор данных / Все устройства.