Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

allocate-transit-virtual-interface

Описание

Создаёт транзитный виртуальный интерфейс, который будет принадлежать указанной учётной записи Amazon Web Services. Используйте этот тип интерфейса для подключения транзитной шлюзовой точки к шлюзу Direct Connect.

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

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

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

Синтаксис

  allocate-transit-virtual-interface
--connection-id <value>
--owner-account <value>
--new-transit-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-transit-virtual-interface-allocation (структура)

Информация о транзитном виртуальном интерфейсе.

virtualInterfaceName -> (строка)

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

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

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

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

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

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

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

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

authKey -> (строка)

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

amazonAddress -> (строка)

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

customerAddress -> (строка)

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

addressFamily -> (строка)

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

tags -> (список)

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

(структура)

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

key -> (строка)

Ключ.

value -> (строка)

Значение.

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

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

Синтаксис JSON:

{
  "virtualInterfaceName": "string",
  "vlan": integer,
  "asn": integer,
  "mtu": integer,
  "authKey": "string",
  "amazonAddress": "string",
  "customerAddress": "string",
  "addressFamily": "ipv4"|"ipv6",
  "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Для создания транзитного виртуального интерфейса, который будет принадлежать указанной учётной записи AWS

Следующий allocate-transit-virtual-interface пример создаёт транзитный виртуальный интерфейс для указанной учётной записи.

aws directconnect allocate-transit-virtual-interface \
    --connection-id dxlag-fEXAMPLE \
    --owner-account 123456789012 \
    --new-transit-virtual-interface-allocation "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,tags=[{key=Tag,value=Example}]"

Вывод:

{
    "virtualInterface": {
        "ownerAccount": "123456789012",
        "virtualInterfaceId": "dxvif-fEXAMPLE",
        "location": "loc1",
        "connectionId": "dxlag-fEXAMPLE",
        "virtualInterfaceType": "transit",
        "virtualInterfaceName": "Example Transit Virtual Interface",
        "vlan": 126,
        "asn": 65110,
        "amazonSideAsn": 7224,
        "authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
        "amazonAddress": "192.168.1.1/30",
        "customerAddress": "192.168.1.2/30",
        "addressFamily": "ipv4",
        "virtualInterfaceState": "confirming",
        "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-fEXAMPLE\">\n  <vlan>126</vlan>\n  <customer_address>192.168.1.2/30</customer_address>\n  <amazon_address>192.168.1.1/30</amazon_address>\n  <bgp_asn>65110</bgp_asn>\n  <bgp_auth_key>0xzxgA9YoW9h58u8SEXAMPLE</bgp_auth_key>\n  <amazon_bgp_asn>7224</amazon_bgp_asn>\n  <connection_type>transit</connection_type>\n</logical_connection>\n",
        "mtu": 1500,
        "jumboFrameCapable": true,
        "virtualGatewayId": "",
        "directConnectGatewayId": "",
        "routeFilterPrefixes": [],
        "bgpPeers": [
            {
                "bgpPeerId": "dxpeer-fEXAMPLE",
                "asn": 65110,
                "authKey": "0xzxgA9YoW9h58u8EXAMPLE",
                "addressFamily": "ipv4",
                "amazonAddress": "192.168.1.1/30",
                "customerAddress": "192.168.1.2/30",
                "bgpPeerState": "pending",
                "bgpStatus": "down",
                "awsDeviceV2": "loc1-26wz6vEXAMPLE"
            }
        ],
        "region": "sa-east-1",
        "awsDeviceV2": "loc1-26wz6vEXAMPLE",
        "tags": [
            {
                "key": "Tag",
                "value": "Example"
            }
        ]
    }
}

Для получения дополнительной информации см. раздел «Создание виртуального интерфейса транзитного шлюза с размещением» в руководстве пользователя AWS Direct Connect.

Вывод

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

Информация о транзитной виртуальной интерфейсе.

ownerAccount -> (строка)

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

virtualInterfaceId -> (строка)

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

location -> (строка)

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

connectionId -> (строка)

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

virtualInterfaceType -> (строка)

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

virtualInterfaceName -> (строка)

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

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

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

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

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

Допустимые значения: от 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