Изменение параметров EDGE c помощью vCloud API

Введение

В данном руководстве показано, как получать, изменять и отправлять блоки XML, которые представляют конфигурацию туннелей IPsec VPN внутри EDGE Gateway. В руководстве рассматриваются модификации local и peer IP-адресов, local и peer идентификаторов, а также добавление или удаление local и peer подсетей. 

Сценарии использования:

  • Позволяет клиентам быстро вносить изменения в конфигурации IPsec
  • Изменения такого характера невозможны в графическом интерфейсе пользователя VMware Cloud Director без предварительного полного удаления существующей
    конфигурации IPsec VPN и повторного ввода настроек. В зависимости от количества туннелей это может оказаться длительной задачей. Внесение изменений в конфигурацию IPsec VPN через vCloud API может значительно ускорить этот процесс.

Прежде чем вы начнете

Перед использованием vCloud API для просмотра и обновления настроек IPsec VPN мы рекомендуем вам установить REST-клиент, который позволит вам получить доступ к API. В шагах, описанных в этой статье, используется клиент POSTMAN но вы также можете использовать плагин для Firefox RESTClient. Для получения информации о том, как установить этот плагин, а также как получать токен авторизации и данные о VDC, см. статью в нашей БЗ Как получить доступ к VMware Cloud Director через vCloud API. В данном руководстве первоначальная настройка клиента рассматриваться не будет.

Получите сведения о vOrg через API

  1. Получите токен авторизации (См. статью в БЗ)
  2. Создайте GET запрос sessions через API



  3. В ответе сервера найдите API URL для доступа к vOrg




    Полученный URL должен выглядеть примерно так:
    https://<api_url>/api/org/<org_id>
    https://vcd.cloud4y.ru/api/org/958faa8f-e5ab-44f0-a4b5-8144886f1591
  4. После того, как мы получили ссылку на нашу организацию, выполняем GET запрос для получения API URL о таких сущностях, как Networks, VDC и каталоги принадлежащих vOrg. Здесь нас будет интересовать API ссылка на VDC.


Получение сведений VDC и EDGE через AP

Для получения информации о сущностях VDC выполните следующие шаги.

1. Вставьте полученную ссылку в строку запроса и отправьте запрос

https://<api_url>/api/vdc/<vdc_id>
https://vcd.cloud4y.ru/api/vdc/75f35912-e397-493b-81ce-7e745747dbeb

2. Будет выведен новый ответ сервера, в котором мы сможем найти API URL для запроса к EDGE

3. Введите указанный URL в строке запроса для получения информации по указанному EDGE. Если запрос был выполнен успешно, то сервер должен вернуть ответ, где вы сможете найти API URL интересующего нас EDGE.

4. Введите найденный API URL в строке запроса и сформируйте GET запрос. При успешном ответе вы получите ответ сервера со следующим содержимым:

Проверка конфигурации EDGE

В выведеном xml ответе, информация о конфигурации EDGE содержится между открывающим <Configuration> и закрывающим </Configuration> тегами.

Этот блок XML разделен на разделы, в которых подробно описаны параметры конфигурации, применяемые к конкретному элементу, функции или услуге, доступной на EDGE. Всего двенадцать разделов. Но нас интересуют только параметры конфигурации, содержащиеся в тегах <GatewayIpsecVpnService>. В приведенном ниже примере показан общий обзор структуры возвращенного блока XML, включая теги <GatewayIpsecVpnServices>.

! Мы рекомендуем вам, перед дальнейшими действиями сохранить XML данные от тега <Configuration> до тега <\Configuration> в отдельный файл. Это необходимо для того, чтоб была возможность откатиться до рабочей версии в случае некоректных изменений.

Настройка IPsec VPN в возвращенном XML

Чтобы отредактировать настройки IPsec VPN, вставьте в текстовый файл содержимое между открывающим <GatewayIpsecVpnService> и закрывающим </GatewayIpsecVpnService> тегами. Его содержимое должно быть похоже на блок XML, показанный в верхнем пункте.

Теперь вы можете изменить любые параметры находящиеся в данном блоке.

  • Локальный IP-адрес и локальный идентификатор в обозначенных тегами <localIpAddress> и </localIpAddress>, и соответственно <localId> и </localId>.
  • Удаленную конечную точку туннеля на новое устройство или IP-адрес, с тегами <PeerIpAddress> и <PeerId> (Помните что эти значения должны совпадать друг с другом)
  • Локальные подсети с тегом <LocalSubnet> или удаленные локальные подсети с тегом <PeerSubnet>
  • Общий секрет измените значение между открывающим <SharedSecret> и закрывающим </SharedSecret> тегами

Данные изменения являются наиболее частыми при конфигурации IPSec туннелей.

Применение новой конфигурации

После внесения изменений в xml данные вы можете применить их в настройках EDGE. Для этого выполните следующие условия:

    1. Заключите новую конфигурацию в пару тегов <EdgeGatewayServiceConfiguration>. 
    2. Скопируйте и вставьте эту конфигурацию в раздел Body  клиента Postman. В настройках окна укажите параметры Тип данных RAW, метод XML.
    3. В списке типов запроса выберите POST.
    4. Добавьте к URL-адресу в поле URL-адреса следующее:

      /action/configureServices

    5.  Также обязательно необходимо еще один Header в Postman перед отправкой новой конфигурации. В меню заголовков в верхней части клиента REST выберите «Headers». 
    6. В поле Имя введите Content-Type, а в поле Значение атрибута введите следующее:

      application/vnd.vmware.admin.edgeGatewayServiceConfiguration+xml



    7.  Нажимите Send чтоб применить новую конфигурацию.

 

 
 
 
 
 
 
  • 46 Пользователи нашли это полезным
Помог ли вам данный ответ?

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

vCloud API инструкция по программированию для сервис провайдеров

В этом выпуске руководства по программированию API vCloud для сервис провайдеров предоставляется...

vCloud Director API для NSX. Инструкция для программистов.

Про vCloud Director API для NSXvCloud Director API для NSX.API-интерфейс vCloud Director для NSX...

Как получить доступ к VMware Cloud Director через vCloud API

Обзор Для выполнения некоторых задач в среде CLOUD4Y вам может потребоваться доступ к VMware...