Модуль cisco.meraki.organizations_devices_packet_capture_captures — модуль ресурса для organizations _devices _packet _capture _captures

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.organizations_devices_packet_capture_captures.

Добавлено в cisco.meraki 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление операциями создания и удаления ресурса organizations _devices _packet _capture _captures.
Выполнение захвата пакетов на устройстве и сохранение результата в облаке Meraki. Для одного запроса можно выбрать только один коммутатор, но несколько точек доступа.
Удаление отдельного захвата пакетов из облака с помощью captureId.

Примечание

Этому модулю соответствует модуль действия.

Требования

На хосте, где выполняется этот модуль, необходимы следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
advanced словарь	Расширенные фильтры для устройств IOSXE (поддерживаются только устройствами Campus Gateway).
bufferFiles целое число	Количество файлов буфера для захвата с циклическим буфером (от 1 до 5 для устройств Campus Gateway).
captureType строка	Тип захвата. Возможные значения: linear (по умолчанию), circular.
controlPlaneDirection строка	Направление захвата для плоскости управления.
innerFilterMacs список / элементы=строка	Внутренний фильтр MAC-адресов для туннелированного трафика (до 5 MAC-адресов для устройств Campus Gateway).
maxFilesize целое число	Максимальный размер файла в мегабайтах (МБ). Диапазон 1–100 МБ при bufferFiles=1, 1–500 МБ при bufferFiles=2–5.
packetsPerSecond целое число	Ограничение скорости передачи пакетов в секунду для устройств Campus Gateway (1–1000000).
physicalInterfaceDirection строка	Направление захвата для физического интерфейса.
captureId строка	Параметр пути CaptureId. Идентификатор захвата.
destination строка	Место назначения файла захвата пакетов. Возможное значение: upload_to_cloud.
duration целое число	Длительность захвата пакетов в секундах.
filterExpression строка	Выражение фильтра для захвата пакетов.
interface строка	Интерфейс устройства.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе через локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь к выходному журналу; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором после ошибки Nginx 429 По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять попытку при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором после другой ошибки 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время выполнения каждого вызова API в секундах По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять попытку при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
name строка	Имя файла захвата пакетов.
notes строка	Причина выполнения захвата пакетов.
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.
outputType строка	Формат выходного файла захвата пакетов. Возможные значения: text, pcap, cloudshark или upload_to_cloud.
ports строка	Порты файла захвата пакетов, разделенные запятыми.
serials список / элементы=строка	Серийный номер устройства или устройств.

Примечания

Примечание

Используемые методы SDK: organizations.Organizations.create_organization_devices_packet_capture_capture, organizations.Organizations.delete_organization_devices_packet_capture_capture,
Используемые пути: post /organizations/{organizationId}/devices/packetCapture/captures, delete /organizations/{organizationId}/devices/packetCapture/captures/{captureId},
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki по методу organizations createOrganizationDevicesPacketCaptureCapture: Полное описание API createOrganizationDevicesPacketCaptureCapture.
Документация Cisco Meraki по методу organizations deleteOrganizationDevicesPacketCaptureCapture: Полное описание API deleteOrganizationDevicesPacketCaptureCapture.

Примеры

- name: Create
  cisco.meraki.organizations_devices_packet_capture_captures:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    advanced:
      bufferFiles: 5
      captureType: circular
      controlPlaneDirection: both
      innerFilterMacs:
        - aa:bb:cc:dd:ee:ff
        - 11:22:33:44:55:66
      maxFilesize: 10
      packetsPerSecond: 10000
      physicalInterfaceDirection: both
    destination: upload_to_cloud
    duration: 3
    filterExpression: host 10.1.27.253
    interface: wireless
    name: Capture no. 3
    notes: Debugging connectivity issue...
    organizationId: string
    outputType: upload_to_cloud
    ports: 1, 3
    serials:
      - Q234-ABCD-5678
- name: Delete by id
  cisco.meraki.organizations_devices_packet_capture_captures:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: absent
    captureId: string
    organizationId: string

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"admin": {"id": "string", "name": "string"}, "captureId": "string", "client": {"id": "string", "mac": "string"}, "counts": {"packets": {"total": 0}}, "destination": "string", "details": [{"name": "string", "productType": "string", "value": "string"}], "device": {"name": "string", "serial": "string"}, "devices": [{}], "duration": 0, "errorMessage": "string", "file": {"size": 0}, "filterExpression": "string", "interface": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": "string", "process": "string", "startTs": "string", "status": "string"}

Ключ

Описание

meraki_response

словарь

Словарь или список с ответом, возвращенным Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"admin": {"id": "string", "name": "string"}, "captureId": "string", "client": {"id": "string", "mac": "string"}, "counts": {"packets": {"total": 0}}, "destination": "string", "details": [{"name": "string", "productType": "string", "value": "string"}], "device": {"name": "string", "serial": "string"}, "devices": [{}], "duration": 0, "errorMessage": "string", "file": {"size": 0}, "filterExpression": "string", "interface": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": "string", "process": "string", "startTs": "string", "status": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/organizations_devices_packet_capture_captures_module.html