Модуль cisco.meraki.networks_pii_sm_devices_for_key_info — информационный модуль для networks _pii _smdevicesforkey

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для получения сведений о Networks Pii Smdevicesforkey.
Получение всех networks _pii _smdevicesforkey.
По заданным персональным данным (PII) возвращает идентификаторы устройств Systems Manager, связанные с этими данными. Эти идентификаторы устройств можно использовать с конечными точками API Systems Manager для получения сведений об устройствах. Можно указать только один идентификатор.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
bluetoothMac строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса BluetoothMac. MAC-адрес клиента Bluetooth.
email строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса Email. Адрес электронной почты учётной записи пользователя сети или устройства Systems Manager.
headers словарь	Дополнительные заголовки.
imei строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса Imei. IMEI устройства Systems Manager.
mac строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса Mac. MAC-адрес сетевого клиентского устройства или устройства Systems Manager.
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 строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр пути NetworkId. Идентификатор сети.
serial строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса Serial. Серийный номер устройства Systems Manager.
username строка	Информационный модуль для получения сведений о Networks Pii Smdevicesforkey. Параметр запроса Username. Имя пользователя Systems Manager.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по networks getNetworkPiiSmDevicesForKey: Полный справочник по API getNetworkPiiSmDevicesForKey.

Примеры

- name: Get all networks _pii _smdevicesforkey
  cisco.meraki.networks_pii_sm_devices_for_key_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 }}"
    username: string
    email: string
    mac: string
    serial: string
    imei: string
    bluetoothMac: string
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `[{}]`

Авторы

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