модуль cisco.meraki.organizations_devices_packet_capture_schedules_info — информационный модуль для организаций _devices _packet _capture _schedules

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о расписаниях захвата пакетов на устройствах организации.
Получение всех расписаний захвата пакетов на устройствах организаций.
Вывод списка расписаний захвата пакетов.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceIds list / elements=string	Информационный модуль для получения сведений о расписаниях захвата пакетов на устройствах организации. Параметр запроса DeviceIds. Возвращает запланированные сеансы захвата пакетов для указанных устройств.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором пакетного действия при ошибке параллельного выполнения По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый адрес перед ресурсами всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также можно задать как переменную окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе через локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение), наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и время По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь для выходного журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение), создавать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для получения сведений о расписаниях захвата пакетов на устройствах организации. Параметр запроса NetworkIds. Возвращает запланированные сеансы захвата пакетов для указанных сетей.
organizationId string	Информационный модуль для получения сведений о расписаниях захвата пакетов на устройствах организации. Параметр пути OrganizationId. Идентификатор организации.
scheduleIds list / elements=string	Информационный модуль для получения сведений о расписаниях захвата пакетов на устройствах организации. Параметр запроса ScheduleIds. Возвращает расписания захвата пакетов с указанными идентификаторами.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices _packet _capture _schedules
  cisco.meraki.organizations_devices_packet_capture_schedules_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 }}"
    scheduleIds: []
    networkIds: []
    deviceIds: []
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: {"items": [{"admin": {"id": "string", "name": "string"}, "captureCount": 0, "createdAt": "string", "devices": [{"device": {"interface": "string", "serial": "string", "switchports": "string"}}], "duration": 0, "enabled": true, "filterExpression": "string", "lastCaptureId": "string", "name": "string", "notes": "string", "priority": 0, "schedule": {"endTs": "string", "frequency": "string", "name": "string", "nextCaptureTs": "string", "recurrence": 0, "startTs": "string", "weekdays": ["string"]}, "scheduleId": "string", "updatedAt": "string", "warnings": ["string"]}], "meta": {"counts": {"items": {"total": 0}}}}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"items": [{"admin": {"id": "string", "name": "string"}, "captureCount": 0, "createdAt": "string", "devices": [{"device": {"interface": "string", "serial": "string", "switchports": "string"}}], "duration": 0, "enabled": true, "filterExpression": "string", "lastCaptureId": "string", "name": "string", "notes": "string", "priority": 0, "schedule": {"endTs": "string", "frequency": "string", "name": "string", "nextCaptureTs": "string", "recurrence": 0, "startTs": "string", "weekdays": ["string"]}, "scheduleId": "string", "updatedAt": "string", "warnings": ["string"]}], "meta": {"counts": {"items": {"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_schedules_info_module.html