Общедоступная документация для разработчиков Dell
Полную документацию для разработчиков по интерфейсу прикладного программирования (API) VxRail REST и другим продуктам Dell см. на странице
Dell Developer APIs. Чтобы быстро найти API для VxRail, выполните фильтрацию по запросу «Гиперконвергентная инфраструктура».
Конкретную документацию по запросу или обновлению DNS можно найти в разделе «Информация о системе» - «Получение и настройка DNS»:
Эта документация может быть использована для создания пользовательских команд curl или интеграции в такое приложение, как "postman" или другие приложения для более опытных пользователей.
Клиент встроенного API VxRail
Предпочтительный способ (рекомендуется для людей, менее знакомых с REST API) для использования API VxRail — использовать собственный клиент API VxRail Manager.
С версии VxRail 7.0.350 мы перешли на новый интерфейс на основе Spotlight с более широкими возможностями.
Войдите в собственный клиент API, введя FQDN/IP-адрес VxRail Manager в браузере.
< https://VxRail_Manager_IP_or_FQDN>/rest/vxm/api-doc.html
Например, IP-адрес VxRail Manager — 172.168.10.50, поэтому URL-адрес становится
https://172.168.10.50/rest/vxm/api-doc.html:
Запрос текущей конфигурации DNS кластера VxRail
Чтобы запросить текущую конфигурацию DNS, используйте API v1_sytem_dns_get, который можно найти в разделе «System Information» на левой панели:
- Прямой URL-адрес будет https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_get однако он может меняться в разных версиях, поэтому лучше всего перемещаться в пользовательском интерфейсе.
- Введите учетные данные для аутентификации VxRail vCenter с единым входом (SSO), которые часто являются administrator@vsphere.local, но могут отличаться в зависимости от конфигурации домена.
- Нажмите кнопку Send Request, чтобы выполнить запрос GET:
- Клиент API выполняет аутентификацию, и если мы получаем ответ 200 OK, возвращаем запрошенную информацию, где текущий IP-адрес лаборатории DNS-серверов — 172.168.10.253, а VxRail Manager не настроен как «внутренний DNS», то есть мы используем DNS-серверы, предоставленные внешним заказчиком:
Обновление информации об IP-сервере DNS кластера VxRail
Чтобы обновить текущую конфигурацию DNS, используйте v1_system_dns_post API, который можно найти в разделе «System Information» на левой панели:
- Прямой URL-адрес будет https://172.168.10.50/rest/vxm/api-doc.html#/operations/v1_system_dns_post однако он может меняться в разных версиях, поэтому лучше всего перемещаться в пользовательском интерфейсе.
- В разделе «Auth» введите учетные данные аутентификации единого входа VxRail vCenter, которые часто являются administrator@vsphere.local, но могут отличаться в зависимости от конфигурации домена.
- Для обновления DNS-сервера отредактируйте раздел «Body» в трех областях:
- Раздел "components" является необязательным, а раздел "ALL" используется по умолчанию. Если задан параметр ALL, заменяются все DNS-серверы в кластере, включая VxRail Manager, vCenter и ESXi. Если задано значение «VXM», заменяется только DNS-сервер для VxRail Manager, что является ограниченным вариантом использования, поскольку рекомендуется поддерживать согласованность конфигурации всех компонентов. Обратите внимание, что значение «VXM» поддерживается ТОЛЬКО в среде VCF на VxRail.
- В разделе «vCenter» необходимо передать имя пользователя и пароль единого входа администратора. Обычно это та же информация, что и в разделе «Auth», но может быть предоставлена учетная запись единого входа другого уровня администратора.
- «servers», в приведенном ниже примере мы устанавливаем DNS на IP-адрес 172.168.10.253
- Обратите внимание , что при добавлении нескольких серверов IP-адреса должны быть разделены запятыми «172.168.10.253,10.8.8.8».
- Нажмите кнопку Send Request, чтобы выполнить POST-запрос:
- В зависимости от количества хостов ESXi в кластере запрос может занять мин., но после успешного выполнения запроса возвращается код ответа 200 OK.
При получении неожиданных кодов ответа.
В неисправной системе или, возможно, не удается связаться с новым DNS-сервером с хостов ESXi и т. д. Клиент API предоставляет некоторые базовые рекомендации по сообщениям об ошибках, а дополнительные коды ошибок можно найти в Интернете, например
https://restfulapi.net/http-status-codes/ является хорошим расположением.
При наличии каких-либо непредвиденных кодов ошибок обратитесь в службу поддержки Dell для получения дополнительных инструкций по поиску и устранению неисправностей.
В ранних выпусках VxRail 8.0 процедуры Solve Online ссылаются на обновление параметров IP-адреса DNS VxRail с помощью REST API. Эта возможность будет добавлена в подключаемый модуль пользовательского интерфейса VxRail.
В этой статье приведены рекомендации и примеры этого действия для заказчиков с меньшим опытом использования REST API VxRail.
Информация об IP-адресе в этой статье получена из временной виртуальной изолированной лаборатории и не содержит конфиденциальных IP-адресов клиентов.