Модуль cisco.meraki.networks_pii_sm_devices_for_key_info – Модуль информации о сетях _pii _smdevicesforkey

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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 2.16.0

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

Описание

Получить все сети _pii _smdevicesforkey.
Учитывая фрагмент персональной идентификационной информации (PII), возвращает идентификаторы устройств Systems Manager, связанные с этим идентификатором. Эти идентификаторы устройств могут быть использованы с конечными точками API Systems Manager для получения данных о устройствах. Будет принято ровно один идентификатор.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
bluetoothMac string	Параметр запроса BluetoothMac. MAC-адрес Bluetooth-клиента.
email string	Параметр запроса Email. Электронная почта учетной записи пользователя сети или устройства Systems Manager.
headers dictionary	Дополнительные заголовки.
imei string	Параметр запроса Imei. IMEI устройства Systems Manager.
mac string	Параметр запроса Mac. MAC-адрес клиентского устройства сети или устройства Systems Manager.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки пакета действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (string), API-ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`

meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить при обнаружении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), симулировать вызовы POST/PUT/DELETE для предотвращения изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить всю запись в логах? Тогда на вас вся ответственность! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты:* `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить при ошибке ограничения скорости 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Параметр пути networkId. Идентификатор сети.
serial string	Параметр запроса serial. Серийный номер устройства Systems Manager.
username string	Параметр запроса 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_, используются Cisco meraki Python SDK для установления подключения

См. также

Документация 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_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 list / elements=string	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `["[\n \"string\"\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_pii_sm_devices_for_key_info_module.html