Spec-Zone.ru › AWS CLI v2

[ aws . directconnect ]

update-virtual-interface-attributes

Описание

Обновляет указанные атрибуты указанного виртуального частного интерфейса.

Установка MTU виртуального интерфейса в 8500 (jumbo frames) может привести к обновлению базового физического соединения, если оно не было обновлено для поддержки jumbo frames. Обновление соединения прерывает сетевое подключение для всех виртуальных интерфейсов, связанных с соединением, в течение до 30 секунд. Чтобы проверить, поддерживает ли ваше соединение jumbo frames, вызовите DescribeConnections. Чтобы проверить, поддерживает ли ваш виртуальный интерфейс jumbo frames, вызовите DescribeVirtualInterfaces.

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

Синтаксис

  update-virtual-interface-attributes
--virtual-interface-id <value>
[--mtu <value>]
[--enable-site-link | --no-enable-site-link]
[--virtual-interface-name <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 (строка)

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

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

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

--enable-site-link | --no-enable-site-link (булево)

Указывает, следует ли включить или отключить SiteLink.

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

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

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

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

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

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

Примеры

Примечание

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

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

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

Следующий update-virtual-interface-attributes пример обновляет MTU указанного виртуального интерфейса.

aws directconnect update-virtual-interface-attributes \
    --virtual-interface-id dxvif-fEXAMPLE \
    --mtu 1500

Вывод:

{
    "ownerAccount": "1111222233333",
    "virtualInterfaceId": "dxvif-fEXAMPLE",
    "location": "loc1",
    "connectionId": "dxlag-fEXAMPLE",
    "virtualInterfaceType": "transit",
    "virtualInterfaceName": "example transit virtual interface",
    "vlan": 125,
    "asn": 650001,
    "amazonSideAsn": 64512,
    "authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
    "amazonAddress": "169.254.248.1/30",
    "customerAddress": "169.254.248.2/30",
    "addressFamily": "ipv4",
    "virtualInterfaceState": "down",
    "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-fEXAMPLE\">\n  <vlan>125</vlan>\n  <customer_address>169.254.248.2/30</customer_address>\n  <amazon_address>169.254.248.1/30</amazon_address>\n  <bgp_asn>650001</bgp_asn>\n  <bgp_auth_key>0xzxgA9YoW9h58u8SEXAMPLE</bgp_auth_key>\n  <amazon_bgp_asn>64512</amazon_bgp_asn>\n  <connection_type>transit</connection_type>\n</logical_connection>\n",
    "mtu": 1500,
    "jumboFrameCapable": true,
    "virtualGatewayId": "",
    "directConnectGatewayId": "879b76a1-403d-4700-8b53-4a56ed85436e",
    "routeFilterPrefixes": [],
    "bgpPeers": [
        {
            "bgpPeerId": "dxpeer-fEXAMPLE",
            "asn": 650001,
            "authKey": "0xzxgA9YoW9h58u8SEXAMPLE",
            "addressFamily": "ipv4",
            "amazonAddress": "169.254.248.1/30",
            "customerAddress": "169.254.248.2/30",
            "bgpPeerState": "available",
            "bgpStatus": "down",
            "awsDeviceV2": "loc1-26wz6vEXAMPLE"
        }
    ],
    "region": "sa-east-1",
    "awsDeviceV2": "loc1-26wz6vEXAMPLE",
    "tags": []
}

Дополнительную информацию см. в разделе Настройка сетевого MTU для частных виртуальных интерфейсов или транзитных виртуальных интерфейсов в Руководстве пользователя AWS Direct Connect.

Выходные данные

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.

Spec-Zone.ru

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