Модуль cisco.meraki.networks_sm_user_access_devices_info – Модуль информации для сетей _sm _useraccessdevices

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.networks_sm_user_access_devices_info.

Новый в cisco.meraki 2.16.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение всех сетей _sm _useraccessdevices.
Список устройств доступа пользователей и подключений к доверенному доступу.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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 (строка), предшествующий всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
… (остальные строки)	… (остальные строки)

END_OF_DOCUMENT_MARKER

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` ← (по умолчанию)
networkId строка	Параметр пути NetworkId. Идентификатор сети.
perPage целое число	Параметр запроса PerPage. Количество записей на странице, возвращаемых. Допустимый диапазон 3 - 1000. По умолчанию 100.
startingAfter строка	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылку на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link следует определить.
total_pages строка / обязательно	total_pages(целое число), использовать с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

Используемый метод SDK: sm.Sm.get_network_sm_user_access_devices,
Используемые пути: get /networks/{networkId}/sm/userAccessDevices,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует какие-либо плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления подключения

См. также

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

Примеры

- name: Get all networks _sm _useraccessdevices
  cisco.meraki.networks_sm_user_access_devices_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

Значения возврата

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"email\": \"string\",\n \"id\": \"string\",\n \"mac\": \"string\",\n \"name\": \"string\",\n \"systemType\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"trustedAccessConnections\": [\n {\n \"downloadedAt\": \"string\",\n \"lastConnectedAt\": \"string\",\n \"scepCompletedAt\": \"string\",\n \"trustedAccessConfigId\": \"string\"\n }\n ],\n \"username\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"email\": \"string\",\n \"id\": \"string\",\n \"mac\": \"string\",\n \"name\": \"string\",\n \"systemType\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"trustedAccessConnections\": [\n {\n \"downloadedAt\": \"string\",\n \"lastConnectedAt\": \"string\",\n \"scepCompletedAt\": \"string\",\n \"trustedAccessConfigId\": \"string\"\n }\n ],\n \"username\": \"string\"\n }\n]\n"

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_sm_user_access_devices_info_module.html