Spec-Zone.ru › AWS CLI v2

[ aws . networkmanager ]

start-route-analysis

Описание

Начинает анализ маршрута следования трафика между указанным источником и пунктом назначения. Дополнительную информацию см. в разделе Анализатор маршрутов.

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

Синтаксис

  start-route-analysis
--global-network-id <value>
--source <value>
--destination <value>
[--include-return-path | --no-include-return-path]
[--use-middleboxes | --no-use-middleboxes]
[--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]

Параметры

--global-network-id (строка)

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

--source (структура)

Источник, из которого исходит трафик.

TransitGatewayAttachmentArn -> (строка)

ARN привязки шлюза транзита.

IpAddress -> (строка)

IP-адрес.

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

TransitGatewayAttachmentArn=string,IpAddress=string

Синтаксис JSON:

{
  "TransitGatewayAttachmentArn": "string",
  "IpAddress": "string"
}

--destination (структура)

Пункт назначения.

TransitGatewayAttachmentArn -> (строка)

ARN привязки шлюза транзита.

IpAddress -> (строка)

IP-адрес.

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

TransitGatewayAttachmentArn=string,IpAddress=string

Синтаксис JSON:

{
  "TransitGatewayAttachmentArn": "string",
  "IpAddress": "string"
}

--include-return-path | --no-include-return-path (булево)

Указывает, нужно ли анализировать обратный путь. По умолчанию значение false.

--use-middleboxes | --no-use-middleboxes (булево)

Указывает, нужно ли включать расположение устройств middlebox в анализ маршрута. По умолчанию значение false.

--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
  • таблица
  • 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.

Для запуска анализа маршрута

Следующий start-route-analysis пример запускает анализ между источником и пунктом назначения, включая необязательный include-return-path.

aws networkmanager start-route-analysis \
    --global-network-id global-network-00aa0aaa0b0aaa000 \
    --source TransitGatewayAttachmentArn=arn:aws:ec2:us-east-1:503089527312:transit-gateway-attachment/tgw-attach-0d4a2d491bf68c093,IpAddress=10.0.0.0 \
    --destination TransitGatewayAttachmentArn=arn:aws:ec2:us-west-1:503089527312:transit-gateway-attachment/tgw-attach-002577f30bb181742,IpAddress=11.0.0.0 \
    --include-return-path

Вывод:

{
    "RouteAnalysis": {
        "GlobalNetworkId": "global-network-00aa0aaa0b0aaa000
        "OwnerAccountId": "1111222233333",
        "RouteAnalysisId": "a1873de1-273c-470c-1a2bc2345678",
        "StartTimestamp": 1695760154.0,
        "Status": "RUNNING",
        "Source": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-attachment/tgw-attach-1234567890abcdef0,
            "TransitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-abcdef01234567890",
            "IpAddress": "10.0.0.0"
        },
        "Destination": {
            "TransitGatewayAttachmentArn": "arn:aws:ec2:us-west-1:555555555555:transit-gateway-attachment/tgw-attach-021345abcdef6789",
            "TransitGatewayArn": "arn:aws:ec2:us-west-1:111122223333:transit-gateway/tgw-09876543210fedcba0",
            "IpAddress": "11.0.0.0"
        },
        "IncludeReturnPath": true,
        "UseMiddleboxes": false
    }
}

Дополнительную информацию см. в разделе Анализатор маршрутов в Руководстве пользователя AWS Global Networks для шлюзов транзита.

Вывод

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

Анализ маршрута.

GlobalNetworkId -> (строка)

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

OwnerAccountId -> (строка)

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

RouteAnalysisId -> (строка)

Идентификатор анализа маршрута.

StartTimestamp -> (метка времени)

Время начала анализа.

Status -> (строка)

Статус анализа маршрута.

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

Источник.

TransitGatewayAttachmentArn -> (строка)

ARN прикрепления шлюза транзитной сети.

TransitGatewayArn -> (строка)

ARN шлюза транзитной сети.

IpAddress -> (строка)

IP-адрес.

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

Цель.

TransitGatewayAttachmentArn -> (строка)

ARN прикрепления шлюза транзитной сети.

TransitGatewayArn -> (строка)

ARN шлюза транзитной сети.

IpAddress -> (строка)

IP-адрес.

IncludeReturnPath -> (булево)

Указывает, нужно ли анализировать обратный путь. Обратный путь не анализируется, если анализ прямого пути не выполнен успешно.

UseMiddleboxes -> (булево)

Указывает, нужно ли включать расположение устройств промежуточных узлов в анализ маршрута.

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

Прямой путь.

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

Статус анализа при завершении.

ResultCode -> (строка)

Результат анализа. Если статус NOT_CONNECTED , проверьте код причины.

ReasonCode -> (строка)

Код причины. Доступен только если соединение не найдено.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Найден маршрут "чёрной дыры" с целевым блоком CIDR.
  • CYCLIC_PATH_DETECTED - Один и тот же ресурс найден несколько раз во время обхода пути.
  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Найден неактивный маршрут с целевым блоком CIDR.
  • MAX_HOPS_EXCEEDED - Анализ превысил 64 перехода, не найдя целевой пункт.
  • ROUTE_NOT_FOUND - Невозможно найти таблицу маршрутизации с целевым блоком CIDR.
  • TGW_ATTACH_ARN_NO_MATCH - Найдено прикрепление, но не с правильным целевым ARN.
  • TGW_ATTACH_NOT_FOUND - Невозможно найти прикрепление.
  • TGW_ATTACH_NOT_IN_TGW - Найдено прикрепление, но не к правильному шлюзу транзитной сети.
  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - Состояние ассоциации таблицы маршрутизации не ассоциировано.

ReasonContext -> (массив)

Дополнительная информация о пути. Доступна только если соединение не найдено.

ключ -> (строка)

значение -> (строка)

Path -> (список)

Путь анализа маршрута.

(структура)

Описание компонента пути.

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

Номер последовательности в пути. Пункт назначения — 0.

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

Ресурс.

RegisteredGatewayArn -> (строка)

ARN шлюза.

ResourceArn -> (строка)

ARN ресурса.

ResourceType -> (строка)

Тип ресурса.

Definition -> (строка)

Информация о ресурсе в формате JSON. Network Manager получает эту информацию, описывая ресурс с помощью вызова API Describe.

NameTag -> (строка)

Значение для тега Name.

IsMiddlebox -> (булево)

Указывает, является ли это устройством промежуточного узла.

DestinationCidrBlock -> (строка)

Целевой блок CIDR в таблице маршрутизации.

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

Обратный путь.

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

Статус анализа при завершении.

ResultCode -> (строка)

Результат анализа. Если статус NOT_CONNECTED , проверьте код причины.

ReasonCode -> (строка)

Код причины. Доступен только если соединение не найдено.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Найден маршрут "чёрной дыры" с целевым блоком CIDR.
  • CYCLIC_PATH_DETECTED - Один и тот же ресурс найден несколько раз во время обхода пути.
  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Найден неактивный маршрут с целевым блоком CIDR.
  • MAX_HOPS_EXCEEDED - Анализ превысил 64 перехода, не найдя целевой пункт.
  • ROUTE_NOT_FOUND - Невозможно найти таблицу маршрутизации с целевым блоком CIDR.
  • TGW_ATTACH_ARN_NO_MATCH - Найдено прикрепление, но не с правильным целевым ARN.
  • TGW_ATTACH_NOT_FOUND - Невозможно найти прикрепление.
  • TGW_ATTACH_NOT_IN_TGW - Найдено прикрепление, но не к правильному шлюзу транзитной сети.
  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - Состояние ассоциации таблицы маршрутизации не ассоциировано.

ReasonContext -> (массив)

Дополнительная информация о пути. Доступна только если соединение не найдено.

ключ -> (строка)

значение -> (строка)

Path -> (список)

Путь анализа маршрута.

(структура)

Описание компонента пути.

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

Номер последовательности в пути. Пункт назначения — 0.

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

Ресурс.

RegisteredGatewayArn -> (строка)

ARN шлюза.

ResourceArn -> (строка)

ARN ресурса.

ResourceType -> (строка)

Тип ресурса.

Definition -> (строка)

Информация о ресурсе в формате JSON. Network Manager получает эту информацию, описывая ресурс с помощью вызова API Describe.

NameTag -> (строка)

Значение для тега Name.

IsMiddlebox -> (булево)

Указывает, является ли это устройством промежуточного узла.

DestinationCidrBlock -> (строка)

Целевой блок CIDR в таблице маршрутизации.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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