модуль cisco.meraki.networks_sm_users_softwares_info — информационный модуль для сетей _sm _users _softwares

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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` ← (по умолчанию)
networkId строка	Информационный модуль для сведений о программном обеспечении пользователей сетей. Параметр пути NetworkId. Идентификатор сети.
userId строка	Информационный модуль для сведений о программном обеспечении пользователей сетей. Параметр пути UserId. Идентификатор пользователя.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _sm _users _softwares
  cisco.meraki.networks_sm_users_softwares_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 }}"
    networkId: string
    userId: string
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"appId\": \"string\",\n \"bundleSize\": 0,\n \"createdAt\": \"string\",\n \"deviceId\": \"string\",\n \"dynamicSize\": 0,\n \"id\": \"string\",\n \"identifier\": \"string\",\n \"installedAt\": \"string\",\n \"toInstall\": true,\n \"iosRedemptionCode\": true,\n \"isManaged\": true,\n \"itunesId\": \"string\",\n \"licenseKey\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"redemptionCode\": 0,\n \"shortVersion\": \"string\",\n \"status\": \"string\",\n \"toUninstall\": true,\n \"uninstalledAt\": \"string\",\n \"updatedAt\": \"string\",\n \"vendor\": \"string\",\n \"version\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"appId\": \"string\",\n \"bundleSize\": 0,\n \"createdAt\": \"string\",\n \"deviceId\": \"string\",\n \"dynamicSize\": 0,\n \"id\": \"string\",\n \"identifier\": \"string\",\n \"installedAt\": \"string\",\n \"toInstall\": true,\n \"iosRedemptionCode\": true,\n \"isManaged\": true,\n \"itunesId\": \"string\",\n \"licenseKey\": \"string\",\n \"name\": \"string\",\n \"path\": \"string\",\n \"redemptionCode\": 0,\n \"shortVersion\": \"string\",\n \"status\": \"string\",\n \"toUninstall\": true,\n \"uninstalledAt\": \"string\",\n \"updatedAt\": \"string\",\n \"vendor\": \"string\",\n \"version\": \"string\"\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/networks_sm_users_softwares_info_module.html