Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

describe-virtual-interfaces

Описание

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

Виртуальный интерфейс (VLAN) передает трафик между локацией Direct Connect и сетью клиента.

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

Синтаксис

  describe-virtual-interfaces
[--connection-id <value>]
[--virtual-interface-id <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 (строка)

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

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

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

--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.

Для перечисления всех виртуальных интерфейсов

Следующая команда describe-virtual-interfaces выводит информацию обо всех виртуальных интерфейсах, связанных с вашей учетной записью AWS:

aws directconnect describe-virtual-interfaces --connection-id dxcon-ffjrkx17

Вывод:

{
    "virtualInterfaces": [
        {
            "virtualInterfaceState": "down",
            "asn": 65000,
            "vlan": 101,
            "customerAddress": "192.168.1.2/30",
            "ownerAccount": "123456789012",
            "connectionId": "dxcon-ffjrkx17",
            "virtualGatewayId": "vgw-aba37db6",
            "virtualInterfaceId": "dxvif-ffhhk74f",
            "authKey": "asdf34example",
            "routeFilterPrefixes": [],
            "location": "TIVIT",
            "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-ffhhk74f\">\n  <vlan>101</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"
        },
        {
            "virtualInterfaceState": "verifying",
            "asn": 65000,
            "vlan": 2000,
            "customerAddress": "203.0.113.2/30",
            "ownerAccount": "123456789012",
            "connectionId": "dxcon-ffjrkx17",
            "virtualGatewayId": "",
            "virtualInterfaceId": "dxvif-fgh0hcrk",
            "authKey": "asdf34example",
            "routeFilterPrefixes": [
                {
                    "cidr": "203.0.113.4/30"
                },
                {
                    "cidr": "203.0.113.0/30"
                }
            ],
            "location": "TIVIT",
            "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-fgh0hcrk\">\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"
        }
    ]
}

Вывод

virtualInterfaces -> (список)

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

(структура)

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

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 неактивен.
  • 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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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