Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

allocate-private-virtual-interface

Описание

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

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

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

Синтаксис

  allocate-private-virtual-interface
--connection-id <value>
--owner-account <value>
--new-private-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-private-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.

addressFamily -> (строка)

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

customerAddress -> (строка)

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

tags -> (список)

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

(структура)

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

key -> (строка)

Ключ.

value -> (строка)

Значение.

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

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

Синтаксис JSON:

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

Для назначения виртуального частного интерфейса

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

aws directconnect allocate-private-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-private-virtual-interface-allocation virtualInterfaceName=PrivateVirtualInterface,vlan=1000,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30

Вывод:

{
    "virtualInterfaceState": "confirming",
    "asn": 65000,
    "vlan": 1000,
    "customerAddress": "192.168.1.2/30",
    "ownerAccount": "123456789012",
    "connectionId": "dxcon-ffjrkx17",
    "virtualInterfaceId": "dxvif-fgy8orxu",
    "authKey": "asdf34example",
    "routeFilterPrefixes": [],
    "location": "TIVIT",
    "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n  <logical_connection id=\"dxvif-fgy8orxu\">\n  <vlan>1000</vlan>\n  <customer_address>192.168.1.2/30</customer_address>\n  <amazon_address>192.168.1.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>private</connection_type>\n</logical_connection>\n",
    "amazonAddress": "192.168.1.1/30",
    "virtualInterfaceType": "private",
    "virtualInterfaceName": "PrivateVirtualInterface"
}

Вывод

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 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 в данной области. Применяется к общедоступным виртуальным интерфейсам.

(структура)

Информация о префиксе фильтра маршрута, который клиент может рекламировать через протокол 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