Модуль cisco.meraki.organizations_devices_packet_capture_schedules — модуль ресурсов для organizations _devices _packet _capture _schedules
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в playbook, укажите: cisco.meraki.organizations_devices_packet_capture_schedules.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление операциями создания, обновления и удаления ресурса organizations _devices _packet _capture _schedules.
- Создание расписания захвата пакетов.
- Удаление расписания из облака.
- Обновление расписания захвата пакетов.
Примечание
Этому модулю соответствует модуль действий.
Требования
Следующие требования необходимы на узле, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
devices list / elements=dictionary | Сведения об устройстве. |
|
interface string |
Интерфейс для захвата. |
|
serial string |
Серийный номер устройства, для которого планируется захват пакетов. |
|
switchports string |
Порты коммутатора для захвата. |
duration integer | Длительность захвата в секундах. |
enabled boolean | Включить или отключить расписание. Варианты:
|
filterExpression string | Выражение фильтра для захвата. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), ключ API, созданный на панели управления; его также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый URL для всех ресурсов конечных точек По умолчанию: |
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), наследовать собственный экземпляр средства ведения журнала Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), к имени файла журнала добавляются дата и временная метка По умолчанию: |
meraki_log_path string | log_path (string), путь к файлу журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой после ошибки 429 от Nginx По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создавать файл журнала вывода? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), адрес и порт прокси-сервера, если он требуется для HTTPS По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять попытку при получении других ошибок 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой после другой ошибки 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное время выполнения каждого вызова API в секундах По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить ведение журналов? Тогда вы действуете на свой страх и риск! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять попытку при ошибке ограничения частоты запросов 429? Варианты:
|
name string | Имя файла захвата пакетов. |
notes string | Причина захвата. |
organizationId string | Параметр пути organizationId. Идентификатор организации. |
schedule dictionary | Сведения о расписании. |
|
endTs string |
Дата и время окончания повторяющейся записи расписания. |
|
frequency string |
Частота повторения записи расписания (час, неделя, месяц, день, минута). |
|
name string |
Имя расписания. |
|
recurrence integer |
Кратность частоты расписания, например: 1 = каждый день, 2 = через день (при frequency = day). |
|
startTs string |
Дата и время начала повторяющейся записи расписания. |
|
weekdays list / elements=string |
Дни недели для расписания: воскресенье, понедельник, вторник, среда, четверг, пятница, суббота. |
scheduleId string | Параметр пути scheduleId. Идентификатор расписания. |
Примечания
Примечание
- Используемые методы SDK: organizations.Organizations.create_organization_devices_packet_capture_schedule, organizations.Organizations.delete_organization_devices_packet_capture_schedule, organizations.Organizations.update_organization_devices_packet_capture_schedule,
- Используемые пути: post /organizations/{organizationId}/devices/packetCapture/schedules, delete /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}, put /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId},
- Не поддерживает
check_mode - Модуль выполняется на управляющем узле и не использует модули подключения Ansible, а вместо этого использует встроенный менеджер подключений
- из Python SDK Cisco Dashboard API
- Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установления подключения
См. также
См. также
- Документация Cisco Meraki по методу organizations createOrganizationDevicesPacketCaptureSchedule
-
Полный справочник по API createOrganizationDevicesPacketCaptureSchedule.
- Документация Cisco Meraki по методу organizations deleteOrganizationDevicesPacketCaptureSchedule
-
Полный справочник по API deleteOrganizationDevicesPacketCaptureSchedule.
- Документация Cisco Meraki по методу organizations updateOrganizationDevicesPacketCaptureSchedule
-
Полный справочник по API updateOrganizationDevicesPacketCaptureSchedule.
Примеры
- name: Create
cisco.meraki.organizations_devices_packet_capture_schedules:
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
devices:
- interface: TenGigabitEthernet0/0/0
serial: Q234-ABCD-5678
switchports: 1, 2
duration: 60
enabled: true
filterExpression: (icmp)
name: daily_capture_for_debugging
notes: Debugging persistent issue on device
organizationId: string
schedule:
endTs: '2021-01-01T14:00:00Z'
frequency: daily
name: Daily at 1pm
recurrence: 1
startTs: '2021-01-01T13:00:00Z'
weekdays:
- Monday
- Wednesday
- Friday
- name: Update by id
cisco.meraki.organizations_devices_packet_capture_schedules:
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
devices:
- interface: TenGigabitEthernet0/0/0
serial: Q234-ABCD-5678
switchports: 1, 2
duration: 60
enabled: true
filterExpression: (icmp)
name: daily_capture_for_debugging
notes: Debugging persistent issue on device
organizationId: string
schedule:
endTs: '2021-01-01T14:00:00Z'
frequency: daily
name: Daily at 1pm
recurrence: 1
startTs: '2021-01-01T13:00:00Z'
weekdays:
- Monday
- Wednesday
- Friday
scheduleId: string
- name: Delete by id
cisco.meraki.organizations_devices_packet_capture_schedules:
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
organizationId: string
scheduleId: string
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meraki_response dictionary | Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_module.html