Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

allocate-public-virtual-interface

Описание

Предоставляет общедоступный виртуальный интерфейс, который будет принадлежать указанной учетной записи Amazon Web Services.

Владелец подключения вызывает эту функцию для предоставления общедоступного виртуального интерфейса, который будет принадлежать указанной учетной записи Amazon Web Services.

Виртуальные интерфейсы, созданные с помощью этой функции, должны быть подтверждены владельцем с помощью ConfirmPublicVirtualInterface. До тех пор, пока этот шаг не будет завершен, виртуальный интерфейс находится в состоянии confirming и не может обрабатывать трафик.

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

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

Синтаксис

  allocate-public-virtual-interface
--connection-id <value>
--owner-account <value>
--new-public-virtual-interface-allocation <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]

Параметры

--connection-id (строка)

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

--owner-account (строка)

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

--new-public-virtual-interface-allocation (структура)

Информация об общедоступном виртуальном интерфейсе.

virtualInterfaceName -> (строка)

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

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

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

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

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

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

authKey -> (строка)

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

amazonAddress -> (строка)

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

customerAddress -> (строка)

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

addressFamily -> (строка)

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

routeFilterPrefixes -> (список)

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

(структура)

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

cidr -> (строка)

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

tags -> (список)

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

(структура)

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

key -> (строка)

Ключ.

value -> (строка)

Значение.

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

virtualInterfaceName=string,vlan=integer,asn=integer,authKey=string,amazonAddress=string,customerAddress=string,addressFamily=string,routeFilterPrefixes=[{cidr=string},{cidr=string}],tags=[{key=string,value=string},{key=string,value=string}]

Синтаксис JSON:

{
  "virtualInterfaceName": "string",
  "vlan": integer,
  "asn": integer,
  "authKey": "string",
  "amazonAddress": "string",
  "customerAddress": "string",
  "addressFamily": "ipv4"|"ipv6",
  "routeFilterPrefixes": [
    {
      "cidr": "string"
    }
    ...
  ],
  "tags": [
    {
      "key": "string",
      "value": "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.

Для создания общедоступного виртуального интерфейса

Следующая allocate-public-virtual-interface команда создает общедоступный виртуальный интерфейс, который будет принадлежать другому клиенту:

aws directconnect allocate-public-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-public-virtual-interface-allocation virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}]

Вывод:

{
    "virtualInterfaceState": "confirming",
    "asn": 65000,
    "vlan": 2000,
    "customerAddress": "203.0.113.2/30",
    "ownerAccount": "123456789012",
    "connectionId": "dxcon-ffjrkx17",
    "virtualInterfaceId": "dxvif-fg9xo9vp",
    "authKey": "asdf34example",
    "routeFilterPrefixes": [
        {
            "cidr": "203.0.113.0/30"
        },
        {
            "cidr": "203.0.113.4/30"
        }
    ],
    "location": "TIVIT",
    "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-fg9xo9vp\">\n  <vlan>2000</vlan>\n  <customer_address>203.0.113.2/30</customer_address>\n  <amazon_address>203.0.113.1/30</amazon_address>\n  <bgp_asn>65000</bgp_asn>\n  <bgp_auth_key>asdf34example</bgp_auth_key>\n  <amazon_bgp_asn>7224</amazon_bgp_asn>\n  <connection_type>public</connection_type>\n</logical_connection>\n",
    "amazonAddress": "203.0.113.1/30",
    "virtualInterfaceType": "public",
    "virtualInterfaceName": "PublicVirtualInterface"
}

Вывод

ownerAccount -> (строка)

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

virtualInterfaceId -> (строка)

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

location -> (строка)

Расположение подключения.

connectionId -> (строка)

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

virtualInterfaceType -> (строка)

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

virtualInterfaceName -> (строка)

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

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

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

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

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

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

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

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

authKey -> (строка)

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

amazonAddress -> (строка)

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

customerAddress -> (строка)

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

addressFamily -> (строка)

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

virtualInterfaceState -> (строка)

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

  • confirming : Создание виртуального интерфейса ожидает подтверждения от владельца виртуального интерфейса. Если владелец виртуального интерфейса отличается от владельца подключения, на котором он предоставлен, виртуальный интерфейс будет оставаться в этом состоянии до тех пор, пока не будет подтвержден владельцем виртуального интерфейса.
  • verifying : Это состояние применимо только к общедоступным виртуальным интерфейсам. Каждый общедоступный виртуальный интерфейс требует проверки перед созданием.
  • pending : Виртуальный интерфейс находится в этом состоянии с момента его создания до момента готовности к передаче трафика.
  • available : Виртуальный интерфейс готов к передаче трафика.
  • down : Виртуальный интерфейс находится в состоянии BGP down.
  • 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 в данном регионе. Применимо к общедоступным виртуальным интерфейсам.

(структура)

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

cidr -> (строка)

Диапазон CIDR рекламируемого маршрута. Разделяйте несколько маршрутов запятыми. Для IPv6 CIDR необходимо использовать /64 или более короткую запись.

bgpPeers -> (список)

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

(структура)

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

bgpPeerId -> (строка)

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

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

Номер автономной системы (AS) для конфигурации Border Gateway Protocol (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