cisco.meraki.organizations_clients_bandwidth_usage_history_info module – Информационный модуль для organizations _clients _bandwidthusagehistory

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceTag string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса DeviceTag. Сопоставляет результат с точным тегом устройства.
headers dictionary	Дополнительные заголовки.
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` ← (по умолчанию)
networkTag string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса NetworkTag. Сопоставляет результат с точным тегом сети.
organizationId string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр пути OrganizationId. Идентификатор организации.
ssidName string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса SsidName. Фильтрация результатов по имени SSID.
t0 string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса T0. Начало временного интервала для данных.
t1 string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может быть не более чем на 186 дней позже t0.
timespan float	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса Timespan. Временной интервал, за который будут получены сведения. Если задан timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 186 дней. Значение по умолчанию — 1 день.
usageUplink string	Информационный модуль для получения сведений об истории использования полосы пропускания клиентами организации. Параметр запроса UsageUplink. Фильтрация результатов по используемому каналу восходящей связи.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу organizations getOrganizationClientsBandwidthUsageHistory: Полное описание API getOrganizationClientsBandwidthUsageHistory.

Примеры

- name: Get all organizations _clients _bandwidthusagehistory
  cisco.meraki.organizations_clients_bandwidth_usage_history_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 }}"
    networkTag: string
    deviceTag: string
    ssidName: string
    usageUplink: string
    t0: string
    t1: string
    timespan: 0
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki. Возвращается: всегда Пример: `"[\n {\n \"ts\": \"string\",\n \"total\": 0,\n \"upstream\": 0,\n \"downstream\": 0\n }\n]\n"`

Авторы

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