Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-route-server-peers

Описание

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

Узел маршрутизатора — это сессия между конечной точкой маршрутизатора и устройством, развернутым в Amazon Web Services (например, брандмауэром или другой функцией сетевой безопасности, работающей на экземпляре EC2). Устройство должно соответствовать этим требованиям:

  • Иметь интерфейс эластичной сети в VPC
  • Поддерживать BGP (Border Gateway Protocol)
  • Мочь инициировать сессии BGP

Дополнительную информацию см. в разделе Динамическое маршрутизирование в вашей VPC с маршрутизатором VPC в Руководстве пользователя Amazon VPC.

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

describe-route-server-peers является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлечь данные из результатов следующих выражений запроса: RouteServerPeers

Синтаксис

  describe-route-server-peers
[--route-server-peer-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--route-server-peer-ids (список)

Идентификаторы узлов маршрутизатора, которые необходимо описать.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров для применения к запросу описания.

(структура)

Пара имя-значение фильтра, используемая для получения более специфического списка результатов из операции описания. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как метки, атрибуты или идентификаторы.

Если вы укажете несколько фильтров, фильтры будут объединены с помощью AND, и запрос вернёт только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2.

Имя -> (строка)

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

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения будут объединены с помощью OR, и запрос вернёт все результаты, соответствующие любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--dry-run | --no-dry-run (логическое значение)

Проверка наличия необходимых разрешений для действия без фактического выполнения запроса и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это может не указываться вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, где начать постраничную обработку. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

Вывод

RouteServerPeers -> (список)

Информация о описанных маршрутизаторах-пирах.

(структура)

Описание конфигурации пира BGP для конечной точки маршрутизатора.

Маршрутизатор-пир — это сессия между конечной точкой маршрутизатора и устройством, развернутым в Amazon Web Services (например, брандмауэр или другая сетевая функция безопасности, работающая на экземпляре EC2). Устройство должно соответствовать следующим требованиям:

  • Иметь эластичный сетевой интерфейс во VPC
  • Поддерживать BGP (Border Gateway Protocol)
  • Мочь инициировать сессии BGP

RouteServerPeerId -> (строка)

Уникальный идентификатор маршрутизатора-пира.

RouteServerEndpointId -> (строка)

Идентификатор конечной точки маршрутизатора, связанной с этим пиром.

RouteServerId -> (строка)

Идентификатор маршрутизатора, связанного с этим пиром.

VpcId -> (строка)

Идентификатор VPC, содержащего маршрутизатор-пира.

SubnetId -> (строка)

Идентификатор подсети, содержащей маршрутизатор-пира.

State -> (строка)

Текущее состояние маршрутизатора-пира.

FailureReason -> (строка)

Причина любого сбоя при создании или работе пира.

EndpointEniId -> (строка)

Идентификатор эластичного сетевого интерфейса для конечной точки маршрутизатора.

EndpointEniAddress -> (строка)

IP-адрес эластичного сетевого интерфейса для конечной точки маршрутизатора.

PeerAddress -> (строка)

IPv4-адрес устройства-пира.

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

Параметры конфигурации BGP для этого пира, включая ASN (номер автономной системы) и настройки BFD (двунаправленного обнаружения потери связи).

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

Номер автономной системы (ASN) Border Gateway Protocol (BGP) для устройства. Допустимые значения находятся в диапазоне от 1 до 4294967295. Рекомендуется использовать частный ASN в диапазоне 64512–65534 (16-битный ASN) или 4200000000–4294967294 (32-битный ASN).

PeerLivenessDetection -> (строка)

Протокол обнаружения жизнеспособности, используемый для пира BGP.

Запрошенный протокол обнаружения жизнеспособности для пира BGP.

  • bgp-keepalive : Стандартный механизм поддержания связи BGP (RFC4271), который стабилен, но может дольше восстанавливаться в случае воздействия на сеть или сбоя маршрутизатора.
  • bfd : Дополнительный протокол двунаправленного обнаружения потери связи (BFD) (RFC5880), который обеспечивает быстрое восстановление, используя более чувствительное обнаружение жизнеспособности.

По умолчанию bgp-keepalive .

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

Текущее состояние сессии BGP с этим пиром.

Status -> (строка)

Рабочее состояние сессии BGP. Состояние позволяет отслеживать жизнеспособность сессии, если у вас нет мониторинга на вашем маршрутизаторе/устройстве.

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

Текущее состояние сессии BFD с этим пиром.

Status -> (строка)

Рабочее состояние сессии BFD.

Tags -> (список)

Все теги, назначенные маршрутизатору-пиру.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов регистрозависимы и принимают максимум 127 символов Юникода. Не может начинаться с aws: .

Value -> (строка)

Значение тега.

Ограничения: значения тегов регистрозависимы и принимают максимум 256 символов Юникода.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение null, если больше результатов нет.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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