Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

create-bgp-peer

Описание

Создаёт BGP-пейринг на указанном виртуальном интерфейсе.

Вы должны создать BGP-пейринг для соответствующей адресной семьи (IPv4/IPv6), чтобы получить доступ к ресурсам Amazon Web Services, которые также используют эту адресную семью.

Если логическая избыточность не поддерживается соединением, интерконнектом или LAG, BGP-пейринг не может быть в той же адресной семье, что и существующий BGP-пейринг на виртуальном интерфейсе.

При создании IPv6 BGP-пейринга опустите Amazon-адрес и адрес клиента. IPv6-адреса автоматически назначаются из пула Amazon IPv6-адресов; вы не можете указать собственные IPv6-адреса.

Предупреждение

Если вы позволите Amazon Web Services автоматически назначать IPv4-адреса, будет выделен CIDR /30 из 169.254.0.0/16. Amazon Web Services не рекомендует этот вариант, если вы планируете использовать IP-адрес маршрутизатора клиента в качестве источника и пункта назначения трафика. Вместо этого следует использовать адреса RFC 1918 или другие адреса, и указать адрес самостоятельно. Дополнительную информацию об адресации RFC 1918 см. в разделе Назначение адресов для частных сетей.

Для публичного виртуального интерфейса номер автономной системы (ASN) должен быть частным или уже присутствовать в разрешённом списке для виртуального интерфейса.

См. также: Документация AWS API

Синтаксис

  create-bgp-peer
[--virtual-interface-id <value>]
[--new-bgp-peer <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--virtual-interface-id (строка)

ID виртуального интерфейса.

--new-bgp-peer (структура)

Информация о BGP-пейринге.

asn -> (целое число)

Номер автономной системы (AS) для конфигурации Border Gateway Protocol (BGP).

authKey -> (строка)

Ключ аутентификации для конфигурации BGP. Эта строка должна иметь длину от 6 до 80 символов.

addressFamily -> (строка)

Адресная семья для BGP-пейринга.

amazonAddress -> (строка)

IP-адрес, назначенный Amazon-интерфейсу.

customerAddress -> (строка)

IP-адрес, назначенный клиенту-интерфейсу.

Сокращённый синтаксис:

asn=integer,authKey=string,addressFamily=string,amazonAddress=string,customerAddress=string

Синтаксис JSON:

{
  "asn": integer,
  "authKey": "string",
  "addressFamily": "ipv4"|"ipv6",
  "amazonAddress": "string",
  "customerAddress": "string"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если не указано значение или указано значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию для команды указанным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла параметров.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Пакет сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурируемого параметра cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить вывод пейджера CLI.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования для Unix-подобных систем. Эти примеры нужно адаптировать к правилам цитирования вашей терминальной программы. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Создание IPv6 BGP-пейринга

В следующем примере создаётся IPv6 BGP-пейринг на частном виртуальном интерфейсе dxvif-fg1vuj3d. Адреса пейринга IPv6 автоматически назначаются Amazon.

Команда:

aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6

Вывод:

{
  "virtualInterface": {
      "virtualInterfaceState": "available",
      "asn": 65000,
      "vlan": 125,
      "customerAddress": "169.254.255.2/30",
      "ownerAccount": "123456789012",
      "connectionId": "dxcon-fguhmqlc",
      "addressFamily": "ipv4",
      "virtualGatewayId": "vgw-f9eb0c90",
      "virtualInterfaceId": "dxvif-fg1vuj3d",
      "authKey": "0xC_ukbCerl6EYA0example",
      "routeFilterPrefixes": [],
      "location": "EqDC2",
      "bgpPeers": [
          {
              "bgpStatus": "down",
              "customerAddress": "169.254.255.2/30",
              "addressFamily": "ipv4",
              "authKey": "0xC_ukbCerl6EYA0uexample",
              "bgpPeerState": "available",
              "amazonAddress": "169.254.255.1/30",
              "asn": 65000
          },
          {
              "bgpStatus": "down",
              "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125",
              "addressFamily": "ipv6",
              "authKey": "0xS27kAIU_VHPjjAexample",
              "bgpPeerState": "pending",
              "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125",
              "asn": 64600
          }
      ],
      "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-fg1vuj3d\">\n  <vlan>125</vlan>\n  <customer_address>169.254.255.2/30</customer_address>\n  <amazon_address>169.254.255.1/30</amazon_address>\n  <bgp_asn>65000</bgp_asn>\n  <bgp_auth_key>0xC_ukbCerl6EYA0uexample</bgp_auth_key>\n  <ipv6_customer_address>2001:db8:1100:2f0:0:1:9cb4:4216/125</ipv6_customer_address>\n  <ipv6_amazon_address>2001:db8:1100:2f0:0:1:9cb4:4211/125</ipv6_amazon_address>\n  <ipv6_bgp_asn>64600</ipv6_bgp_asn>\n  <ipv6_bgp_auth_key>0xS27kAIU_VHPjjAexample</ipv6_bgp_auth_key>\n  <amazon_bgp_asn>7224</amazon_bgp_asn>\n  <connection_type>private</connection_type>\n</logical_connection>\n",
      "amazonAddress": "169.254.255.1/30",
      "virtualInterfaceType": "private",
      "virtualInterfaceName": "Test"
  }
}

Вывод

virtualInterface -> (структура)

Виртуальный интерфейс.

ownerAccount -> (строка)

Идентификатор учетной записи Amazon Web Services, владеющей виртуальным интерфейсом.

virtualInterfaceId -> (строка)

Идентификатор виртуального интерфейса.

location -> (строка)

Местоположение подключения.

connectionId -> (строка)

Идентификатор подключения.

virtualInterfaceType -> (строка)

Тип виртуального интерфейса. Возможные значения: private , public и transit .

virtualInterfaceName -> (строка)

Имя виртуального интерфейса, назначенное сетевой инфраструктурой клиента. Максимальная длина имени — 100 символов. Допустимые символы: a-z, 0-9 и дефис (-).

vlan -> (целое число)

Идентификатор VLAN.

asn -> (целое число)

Номер автономной системы (AS) для конфигурации протокола BGP.

Допустимые значения: от 1 до 2147483647.

amazonSideAsn -> (целое число)

Номер автономной системы (ASN) для стороны Amazon подключения.

authKey -> (строка)

Ключ аутентификации для конфигурации BGP. Длина этой строки должна быть не менее 6 и не более 80 символов.

amazonAddress -> (строка)

IP-адрес, назначенный интерфейсу Amazon.

customerAddress -> (строка)

IP-адрес, назначенный интерфейсу клиента.

addressFamily -> (строка)

Семейство адресов для BGP-пиринга.

virtualInterfaceState -> (строка)

Состояние виртуального интерфейса. Возможные значения:

  • confirming : Создание виртуального интерфейса ожидает подтверждения от владельца виртуального интерфейса. Если владелец виртуального интерфейса отличается от владельца подключения, на котором он провайжен, виртуальный интерфейс останется в этом состоянии до подтверждения владельцем виртуального интерфейса.
  • verifying : Это состояние применимо только к общедоступным виртуальным интерфейсам. Каждый общедоступный виртуальный интерфейс требует проверки перед созданием.
  • pending : Виртуальный интерфейс находится в этом состоянии с момента создания до момента готовности к передаче трафика.
  • available : Виртуальный интерфейс готов к передаче трафика.
  • down : Виртуальный интерфейс BGP отключён.
  • testing : Виртуальный интерфейс находится в этом состоянии сразу после вызова StartBgpFailoverTest и остается в этом состоянии в течение всего срока тестирования.
  • deleting : Виртуальный интерфейс находится в этом состоянии сразу после вызова DeleteVirtualInterface, до тех пор, пока он больше не может передавать трафик.
  • deleted : Виртуальный интерфейс не может передавать трафик.
  • rejected : Владелец виртуального интерфейса отказался от создания виртуального интерфейса. Если виртуальный интерфейс в состоянии Confirming удаляется владельцем виртуального интерфейса, виртуальный интерфейс переходит в состояние Rejected.
  • unknown : Состояние виртуального интерфейса недоступно.

customerRouterConfig -> (строка)

Конфигурация маршрутизатора клиента.

mtu -> (целое число)

Максимальный размер пакета (MTU) в байтах. Поддерживаются значения 1500 и 8500. Значение по умолчанию — 1500.

jumboFrameCapable -> (булево)

Указывает, поддерживаются ли Jumbo-фреймы.

virtualGatewayId -> (строка)

Идентификатор виртуального частного шлюза. Применимо только к частным виртуальным интерфейсам.

directConnectGatewayId -> (строка)

Идентификатор шлюза Direct Connect.

routeFilterPrefixes -> (список)

Маршруты, которые будут объявляться сети Amazon Web Services в данном регионе. Применимо к общедоступным виртуальным интерфейсам.

(структура)

Информация о префиксе фильтрации маршрутов, который клиент может объявлять через протокол BGP по общедоступному виртуальному интерфейсу.

cidr -> (строка)

Блок CIDR объявленного маршрута. Несколько маршрутов разделяются запятыми. IPv6 CIDR должен использовать /64 или меньший префикс.

bgpPeers -> (список)

BGP-пиринги, сконфигурированные на этом виртуальном интерфейсе.

(структура)

Информация о BGP-пиринге.

bgpPeerId -> (строка)

Идентификатор BGP-пиринга.

asn -> (целое число)

Номер автономной системы (AS) для конфигурации протокола BGP.

authKey -> (строка)

Ключ аутентификации для конфигурации BGP. Длина этой строки должна быть не менее 6 и не более 80 символов.

addressFamily -> (строка)

Семейство адресов для BGP-пиринга.

amazonAddress -> (строка)

IP-адрес, назначенный интерфейсу Amazon.

customerAddress -> (строка)

IP-адрес, назначенный интерфейсу клиента.

bgpPeerState -> (строка)

Состояние BGP-пиринга. Возможные значения:

  • verifying : Адреса BGP-пиринга или ASN требуют проверки перед созданием BGP-пиринга. Это состояние применимо только к общедоступным виртуальным интерфейсам.
  • pending : BGP-пиринг создан и остается в этом состоянии до момента готовности к установлению.
  • available : BGP-пиринг готов к установлению.
  • deleting : BGP-пиринг удаляется.
  • deleted : BGP-пиринг удалён и не может быть установлен.

bgpStatus -> (строка)

Состояние BGP-пиринга. Возможные значения:

  • up : BGP-пиринг установлен. Это состояние не указывает на состояние функции маршрутизации. Убедитесь, что вы получаете маршруты по сессии BGP.
  • down : BGP-пиринг отключён.
  • unknown : Состояние BGP-пиринга недоступно.

awsDeviceV2 -> (строка)

Точка подключения Direct Connect, которая завершает BGP-пиринг.

awsLogicalDeviceId -> (строка)

Точка подключения Direct Connect, которая завершает логическое соединение. Это устройство может отличаться от устройства, которое завершает физическое соединение.

region -> (строка)

Регион Amazon Web Services, в котором расположен виртуальный интерфейс.

awsDeviceV2 -> (строка)

Точка подключения Direct Connect, которая завершает физическое соединение.

awsLogicalDeviceId -> (строка)

Точка подключения Direct Connect, которая завершает логическое соединение. Это устройство может отличаться от устройства, которое завершает физическое соединение.

tags -> (список)

Теги, связанные с виртуальным интерфейсом.

(структура)

Информация о теге.

key -> (строка)

Ключ.

value -> (строка)

Значение.

siteLinkEnabled -> (булево)

Указывает, включён ли SiteLink.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API