модуль cisco.meraki.organizations_devices_packet_capture_captures_info – информационный модуль для 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_info.

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

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

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

Информационный модуль для получения сведений о захватах пакетов устройств организации.
Получить все захваты пакетов устройств организации.
Список захватов пакетов. Текущий уровень лицензии позволяет хранить в облаке до 10 файлов захвата. При достижении этого предела после создания нового захвата самый старый захват будет автоматически удалён, чтобы освободить место. Дополнительное хранилище для коммутаторов станет доступно с лицензией Advantage позднее. Эти будущие возможности будут соответствовать тем, которые уже доступны для точек доступа по лицензии Advantage.

Примечание

Этому модулю соответствует плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
adminName строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса AdminName. Возвращает захваты пакетов, соответствующие имени администратора.
captureIds список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса CaptureIds. Возвращает захваты пакетов с указанными идентификаторами.
captureStatus список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса CaptureStatus. Возвращает захваты пакетов с указанным статусом.
clientMac список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса ClientMac. Возвращает захваты пакетов, соответствующие указанным MAC-адресам клиентов.
deviceName строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса DeviceName. Возвращает захваты пакетов, соответствующие указанному имени устройства.
direction строка	direction (строка) — направление постраничной навигации: «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса EndingBefore. Токен, который сервер использует для обозначения конца страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
headers словарь	Дополнительные заголовки.
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 (целое число) — время ожидания перед повторной попыткой после ответа 429 от Nginx По умолчанию: `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 список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса Name. Возвращает захваты пакетов, соответствующие указанному имени.
networkIds список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса NetworkIds. Возвращает захваты пакетов указанных сетей.
notes строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса Notes. Возвращает захваты пакетов, соответствующие указанным примечаниям.
organizationId строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон — от 3 до 100. Значение по умолчанию — 10.
process список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса Process. Возвращает захваты пакетов указанного процесса.
serials список / элементы — строки	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса Serials. Возвращает захваты пакетов указанных устройств.
sortOrder строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса SortOrder. Порядок сортировки записей. Возможные значения: «ascending» и «descending». По умолчанию — «descending».
startingAfter строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса StartingAfter. Токен, который сервер использует для обозначения начала страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
t0 строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса T0. Начало временного интервала данных. Максимальная глубина просмотра — 365 дней от текущей даты.
t1 строка	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса T1. Конец временного интервала данных. Значение T1 может быть не более чем на 365 дней позже t0.
timespan число с плавающей точкой	Информационный модуль для получения сведений о захватах пакетов устройств организации. Параметр запроса Timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение задаётся в секундах и не должно превышать 365 дней. По умолчанию — 365 дней.
total_pages строка / обязательный	total_pages (целое число): используется вместе с perPage для получения общего числа результатов до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.get_organization_devices_packet_capture_captures,
Используемый путь: get /organizations/{organizationId}/devices/packetCapture/captures,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого применяет встроенный диспетчер подключений Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления подключения

См. также

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

Примеры

- name: Get all organizations _devices _packet _capture _captures
  cisco.meraki.organizations_devices_packet_capture_captures_info:
    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 }}"
    captureIds: []
    networkIds: []
    serials: []
    process: []
    captureStatus: []
    name: []
    clientMac: []
    notes: string
    deviceName: string
    adminName: string
    t0: string
    t1: string
    timespan: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    sortOrder: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"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"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Авторы

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