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

Примечание

Этот модуль входит в коллекцию 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_bulk_create.

Новое в cisco.meraki 1.0.0

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

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

Управление операцией create ресурса organizations _devices _packet _capture _captures _bulk _create.
Выполнение захвата пакетов на нескольких устройствах с сохранением в облаке Meraki.

Примечание

Для этого модуля имеется соответствующий плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

Документация Cisco Meraki по organizations bulkOrganizationDevicesPacketCaptureCapturesCreate: Полный справочник по API bulkOrganizationDevicesPacketCaptureCapturesCreate.

Примеры

- name: Create
  cisco.meraki.organizations_devices_packet_capture_captures_bulk_create:
    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 }}"
    advanced:
      bufferFiles: 5
      captureType: circular
      controlPlaneDirection: both
      innerFilterMac:
        - aa:bb:cc:dd:ee:ff
        - 11:22:33:44:55:66
      maxFilesize: 10
      physicalInterfaceDirection: both
    devices:
      - interface: TenGigabitEthernet0/0/0
        serial: Q234-ABCD-5678
        switchports: 1, 2
    duration: 60
    filterExpression: (icmp)
    name: Capture no. 3
    notes: Debugging persistent issue on device
    organizationId: string

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"items": [{"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

dictionary

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

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

Пример: {"items": [{"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_bulk_create_module.html