Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-traffic-mirror-sessions

Описание

Описывает одну или несколько сессий Трафик Миррор. По умолчанию описываются все сессии Трафик Миррор. В качестве альтернативы можно отфильтровать результаты.

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

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

Синтаксис

  describe-traffic-mirror-sessions
[--traffic-mirror-session-ids <value>]
[--dry-run | --no-dry-run]
[--filters <value>]
[--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]

Параметры

--traffic-mirror-session-ids (список)

Идентификатор сессии Трафик Миррор.

(строка)

Синтаксис:

"string" "string" ...

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

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

--filters (список)

Один или несколько фильтров. Возможные значения:

  • description : Описание сессии Трафик Миррор.
  • network-interface-id : Идентификатор сетевого интерфейса сессии Трафик Миррор.
  • owner-id : Идентификатор учетной записи, владеющей сессией Трафик Миррор.
  • packet-length : Назначенное количество пакетов для зеркалирования.
  • session-number : Назначенный номер сессии.
  • traffic-mirror-filter-id : Идентификатор фильтра Трафик Миррор.
  • traffic-mirror-session-id : Идентификатор сессии Трафик Миррор.
  • traffic-mirror-target-id : Идентификатор целевого объекта Трафик Миррор.
  • virtual-network-id : Идентификатор виртуальной сети сессии Трафик Миррор.

(структура)

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

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

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

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

Для описания сессии Трафик Миррор

Следующий describe-traffic-mirror-sessions пример отображает подробности ваших сессий Трафик Миррор.

aws ec2 describe-traffic-mirror-sessions

Вывод:

{
    "TrafficMirrorSessions": [
        {
            "Tags": [],
            "VirtualNetworkId": 42,
            "OwnerId": "111122223333",
            "Description": "TCP Session",
            "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE",
            "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE",
            "TrafficMirrorFilterId": "tmf-083e18f985EXAMPLE",
            "PacketLength": 20,
            "SessionNumber": 1,
            "TrafficMirrorSessionId": "tms-0567a4c684EXAMPLE"
        },
        {
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "tag test"
                }
            ],
            "VirtualNetworkId": 13314501,
            "OwnerId": "111122223333",
            "Description": "TCP Session",
            "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE",
            "TrafficMirrorTargetId": "tmt-03665551cbEXAMPLE",
            "TrafficMirrorFilterId": "tmf-06c787846cEXAMPLE",
            "SessionNumber": 2,
            "TrafficMirrorSessionId": "tms-0060101cf8EXAMPLE"
        }
    ]
}

Дополнительную информацию см. в разделе Просмотр подробностей сессии Трафик Миррор в Руководстве по Трафик Мирроринг AWS.

Вывод

TrafficMirrorSessions -> (список)

Описывает одну или несколько сессий Traffic Mirror. По умолчанию описываются все сессии Traffic Mirror. В качестве альтернативы можно отфильтровать результаты.

(структура)

Описывает сессию Traffic Mirror.

TrafficMirrorSessionId -> (строка)

Идентификатор сессии Traffic Mirror.

TrafficMirrorTargetId -> (строка)

Идентификатор целевого объекта Traffic Mirror.

TrafficMirrorFilterId -> (строка)

Идентификатор фильтра Traffic Mirror.

NetworkInterfaceId -> (строка)

Идентификатор сетевого интерфейса сессии Traffic Mirror.

OwnerId -> (строка)

Идентификатор учётной записи, владеющей сессией Traffic Mirror.

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

Количество байтов в каждом пакете для зеркалирования. Это байты после заголовка VXLAN. Чтобы зеркалировать подмножество, установите это значение в длину (в байтах) для зеркалирования. Например, если вы установите это значение в 100, то первые 100 байт, удовлетворяющих критериям фильтра, копируются в целевой объект. Не указывайте этот параметр, когда вы хотите зеркалировать весь пакет

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

Номер сессии определяет порядок оценки сессий, когда интерфейс используется несколькими сессиями. Первая сессия с соответствующим фильтром - та, которая зеркалирует пакеты.

Допустимые значения: 1-32766.

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

Идентификатор виртуальной сети, связанной с сессией Traffic Mirror.

Description -> (строка)

Описание сессии Traffic Mirror.

Tags -> (список)

Теги, назначенные сессии Traffic Mirror.

(структура)

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

Key -> (строка)

Ключ тега.

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

Value -> (строка)

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

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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