Модуль cisco.meraki.networks_traffic_analysis — модуль ресурсов для networks _trafficanalysis

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса networks _trafficanalysis.
Обновление параметров анализа трафика для сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
customPieChartItems list / elements=dictionary	Список элементов, составляющих пользовательскую круговую диаграмму для отчетов о трафике.
name string	Имя элемента пользовательской круговой диаграммы.
type string	Тип сигнатуры элемента пользовательской круговой диаграммы. Допустимые значения: ‘host’, ‘port’ или ‘ipRange’.
value 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` ← (по умолчанию)
mode string	Режим анализа трафика для сети. Допустимые значения: ‘disabled’ (не собирать сведения о типах трафика), ‘basic’ (собирать общие категории трафика) или ‘detailed’ (собирать имена хостов назначения).
networkId string	Параметр пути NetworkId. Идентификатор сети.

Примечания

Примечание

Используемый метод SDK: networks.Networks.update_network_traffic_analysis,
Используемые пути: put /networks/{networkId}/trafficAnalysis,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_traffic_analysis:
    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
    customPieChartItems:
      - name: Item from hostname
        type: host
        value: example.com
    mode: disabled
    networkId: string

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"customPieChartItems": [{"name": "string", "type": "string", "value": "string"}], "mode": "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/networks_traffic_analysis_module.html