Модуль cisco.meraki.organizations_sensor_gateways_connections_latest_info — информационный модуль для organizations _sensor _gateways _connections _latest

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций.
Получить все organizations _sensor _gateways _connections _latest.
Возвращает последние данные о подключении сенсорных шлюзов.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction строка	direction (строка): направление постраничной навигации — страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число): время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка): ключ API, созданный на панели управления; также его можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка): базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка): необязательный идентификатор партнера для отслеживания использования API; также его можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка): путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логический	meraki_inherit_logging_config (логический): использовать ваш экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка): к имени файла журнала добавляются дата и время По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка): путь для выходного журнала; если не задан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число): максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число): время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log логический	meraki_output_log (логический): создавать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логический	meraki_print_console (логический): выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка): адрес и порт прокси-сервера для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error логический	meraki_retry_4xx_error (логический): повторять запрос при других ошибках 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число): время ожидания перед повторной попыткой при другой ошибке 4XX По умолчанию: `60`
meraki_simulate логический	meraki_simulate (логический): имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число): максимальное время выполнения каждого вызова API в секундах По умолчанию: `60`
meraki_suppress_logging логический	meraki_suppress_logging (логический): отключить ведение журнала? В этом случае вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логический	meraki_use_iterator_for_get_pages (логический): методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логический	meraki_wait_on_rate_limit (логический): повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
organizationId строка	Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
sensorSerials список / элементы=строка	Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций. Параметр запроса SensorSerials. Список серийных номеров сенсоров, по которым фильтруются данные о подключении.
startingAfter строка	Информационный модуль для получения последних сведений о подключениях сенсорных шлюзов организаций. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages строка / обязательный	total_pages (целое число): используйте вместе с perPage, чтобы получить все результаты в количестве до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: sensor.Sensor.get_organization_sensor_gateways_connections_latest,
Используемые пути: get /organizations/{organizationId}/sensor/gateways/connections/latest,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а использует встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления соединения

См. также

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

Примеры

- name: Get all organizations _sensor _gateways _connections _latest
  cisco.meraki.organizations_sensor_gateways_connections_latest_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 }}"
    sensorSerials: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"gateway": {"mac": "string", "name": "string", "serial": "string"}, "lastConnectedAt": "string", "lastReportedAt": "string", "network": {"id": "string", "name": "string"}, "rssi": 0, "sensor": {"mac": "string", "name": "string", "serial": "string"}}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"items": [{"gateway": {"mac": "string", "name": "string", "serial": "string"}, "lastConnectedAt": "string", "lastReportedAt": "string", "network": {"id": "string", "name": "string"}, "rssi": 0, "sensor": {"mac": "string", "name": "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_sensor_gateways_connections_latest_info_module.html