Модуль cisco.meraki.organizations_wireless_controller_availabilities_change_history_info — информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций.
Получение всех данных об истории изменений доступности беспроводных контроллеров организаций.
Вывод данных о подключении беспроводных LAN-контроллеров в организации. Если настроена высокая доступность (HA), возвращаются только данные активного WLC, начиная с момента переключения.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса endingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
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 (строка), базовый 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` ← (по умолчанию)
organizationId string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 1000.
serials list / элементы=string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса Serials. Необязательный параметр для фильтрации беспроводных LAN-контроллеров по их облачному идентификатору. Фильтр поддерживает несколько точных совпадений.
startingAfter string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
t0 string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса T0. Начало временного интервала для данных. Максимальный период выборки — 31 день до текущей даты.
t1 string	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может быть не более чем на 31 день позже t0.
timespan float	Информационный модуль для получения сведений об истории изменений доступности беспроводных контроллеров организаций. Параметр запроса Timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 31 день. Значение по умолчанию — 7 дней.
total_pages string / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить не более total_pages*perPage результатов; значение -1 означает все страницы

Примечания

Примечание

Используемые методы SDK: wireless_controller.WirelessController.get_organization_wireless_controller_availabilities_change_history,
Используемые пути: get /organizations/{organizationId}/wirelessController/availabilities/changeHistory,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а использует встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки подключения

См. также

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

Примеры

- name: Get all organizations _wireless _controller _availabilities _change _history
  cisco.meraki.organizations_wireless_controller_availabilities_change_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 }}"
    serials: []
    t0: string
    t1: string
    timespan: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"changes": [{"endTs": "string", "startTs": "string", "status": "string"}], "serial": "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_wireless_controller_availabilities_change_history_info_module.html