Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_meraki_auth_users – Модуль ресурсов для сетей _merakiauthusers

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.networks_meraki_auth_users.

Новое в cisco.meraki 2.16.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурсов сетей _merakiauthusers.
  • Авторизация пользователя, настроенного с помощью Meraki Authentication для сети, в настоящее время поддерживает пользователей 802.1X, гостевых пользователей Splash и пользователей VPN-клиентов, а организации пока поддерживают 50 000 пользователей.
  • Удаление пользователя RADIUS 802.1X или отмена авторизации и, по желанию, удаление гостевого пользователя Splash или пользователя VPN-клиента.
  • Обновление пользователя, настроенного с помощью Meraki Authentication, в настоящее время могут быть обновлены пользователи 802.1X RADIUS, гостевые пользователи Splash и пользователи VPN-клиентов.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

accountType

строка

Тип авторизации для пользователя. Может быть ‘Гость’ или ‘802.1X’ для беспроводных сетей или ‘Клиентский VPN’ для сетей MX. По умолчанию установлено значение ‘802.1X’.

authorizations

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

Зоны авторизации и даты истечения срока действия для пользователя.

expiresAt

строка

Дата истечения срока действия авторизации. Установите значение ‘Никогда’, чтобы срок действия авторизации не истекал, что является значением по умолчанию.

ssidNumber

целое число

Требуется для беспроводных сетей. SSID, для которого пользователь авторизован, который должен быть настроен для заданного accountType пользователя.

delete

булево

Параметр запроса удаления. Если предоставленный идентификатор относится к пользователю гостевой сети или клиентского VPN, и этот пользователь не авторизован ни для какой другой сети в организации, то также удалите пользователя. Пользователи RADIUS 802.1X всегда удаляются независимо от этого необязательного атрибута.

Варианты:

  • false
  • true

email

строка

Электронный адрес пользователя.

emailPasswordToUser

булево

Выводить ли Meraki пароль пользователю по электронной почте. Значение по умолчанию — false.

Варианты:

  • false
  • true

isAdmin

булево

Является ли пользователь администратором панели управления.

Варианты:

  • false
  • true

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"

meraki_be_geo_id

строка

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная окружения BE_GEO_ID

Значение по умолчанию: ""

meraki_caller

строка

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

Значение по умолчанию: ""

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

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 ← (по умолчанию)

merakiAuthUserId

string

Параметр пути merakiAuthUserId. Идентификатор пользователя авторизации Meraki.

name

string

Имя пользователя. Требуется только если пользователь не является администратором панели управления.

networkId

string

Параметр пути networkId. Идентификатор сети.

password

string

Пароль для этой учетной записи пользователя. Требуется только если пользователь не является администратором панели управления.

Примечания

Примечание

  • Используемые методы SDK: networks.Networks.create_network_meraki_auth_user, networks.Networks.delete_network_meraki_auth_user, networks.Networks.update_network_meraki_auth_user,
  • Используемые пути: post /networks/{networkId}/merakiAuthUsers, delete /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId}, put /networks/{networkId}/merakiAuthUsers/{merakiAuthUserId},
  • Не поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины соединения ansible, а вместо этого использует встроенный менеджер соединений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

См. также

Документация Cisco Meraki по networks createNetworkMerakiAuthUser

Полное описание API createNetworkMerakiAuthUser.

Документация Cisco Meraki по networks deleteNetworkMerakiAuthUser

Полное описание API deleteNetworkMerakiAuthUser.

Документация Cisco Meraki по networks updateNetworkMerakiAuthUser

Полное описание API updateNetworkMerakiAuthUser.

Примеры

- name: Create
  cisco.meraki.networks_meraki_auth_users:
    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}}"
    state: present
    accountType: 802.1X
    authorizations:
    - expiresAt: '2018-03-13T00:00:00.090210Z'
      ssidNumber: 1
    email: miles@meraki.com
    emailPasswordToUser: false
    isAdmin: false
    name: Miles Meraki
    networkId: string
    password: secret

- name: Delete by id
  cisco.meraki.networks_meraki_auth_users:
    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}}"
    state: absent
    delete: true
    merakiAuthUserId: string
    networkId: string

- name: Update by id
  cisco.meraki.networks_meraki_auth_users:
    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}}"
    state: present
    authorizations:
    - expiresAt: '2018-03-13T00:00:00.090210Z'
      ssidNumber: 1
    emailPasswordToUser: false
    merakiAuthUserId: string
    name: Miles Meraki
    networkId: string
    password: secret

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

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

Ключ

Описание

meraki_response

словарь

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

Возвращаемое значение: всегда

Пример: {"accountType": "string", "authorizations": [{"authorizedByEmail": "string", "authorizedByName": "string", "authorizedZone": "string", "expiresAt": "string", "ssidNumber": 0}], "createdAt": "string", "email": "string", "id": "string", "isAdmin": true, "name": "string"}

Авторы

  • 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_meraki_auth_users_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API