Модуль cisco.meraki.networks_meraki_auth_users — модуль ресурса для networks _merakiauthusers
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_meraki_auth_users.
Добавлено в cisco.meraki 1.0.0
Краткое описание
- Управление операциями создания, обновления и удаления ресурса networks _merakiauthusers.
- Авторизация пользователя, настроенного для аутентификации Meraki, в сети. В настоящее время поддерживаются пользователи 802.1X, гостевого портала и клиентского VPN; для организаций действует ограничение в 50 000 пользователей.
- Удаление пользователя RADIUS 802.1X либо отмена авторизации и, при необходимости, удаление гостя портала или пользователя клиентского VPN.
- Обновление пользователя, настроенного для аутентификации Meraki. В настоящее время можно обновлять пользователей RADIUS 802.1X, гостевого портала и клиентского VPN.
Примечание
Этому модулю соответствует плагин действий.
Требования
На узле, на котором выполняется этот модуль, необходимы следующие компоненты.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
accountType string | Тип авторизации пользователя. Для беспроводных сетей может иметь значение «Guest» или «802.1X», а для сетей MX — «Client VPN». По умолчанию используется «802.1X». |
authorizations list / elements=dictionary | Зоны авторизации и даты её окончания для пользователя. |
|
expiresAt string |
Дата окончания авторизации. Укажите «Never», чтобы авторизация не истекала; это значение используется по умолчанию. |
|
ssidNumber integer |
Обязательный параметр для беспроводных сетей. SSID, для которого авторизуется пользователь; он должен быть настроен для указанного типа accountType пользователя. |
delete boolean | Параметр запроса на удаление. Если указанный идентификатор относится к гостю портала или пользователю клиентского VPN, и этот пользователь не авторизован ни в одной другой сети организации, пользователь также будет удалён. Пользователи RADIUS 802.1X удаляются всегда, независимо от этого необязательного атрибута. Варианты:
|
string |
|
emailPasswordToUser boolean | Отправлять ли пароль пользователю по электронной почте. По умолчанию — false. Варианты:
|
isAdmin boolean | Является ли пользователь администратором Dashboard. Варианты:
|
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: |
meraki_api_key string / обязательный | meraki_api_key (string), API-ключ, созданный в Dashboard; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), базовый URL для всех конечных точек ресурсов По умолчанию: |
meraki_be_geo_id string | meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: |
meraki_certificate_path string | meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: |
meraki_inherit_logging_config boolean | meraki_inherit_logging_config (boolean), использовать собственный экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем По умолчанию: |
meraki_log_path string | log_path (string), путь для выходного файла журнала; если не указан, используется рабочий каталог скрипта По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой после ошибки Nginx 429 По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создавать файл выходного журнала? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить журнал в консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), при необходимости — прокси-сервер и порт для HTTPS По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторять попытку при получении другой ошибки 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой после другой ошибки 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное число секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить все журналы? В этом случае вы действуете на свой страх и риск! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторять попытку при ошибке ограничения частоты запросов 429? Варианты:
|
merakiAuthUserId string | Параметр пути MerakiAuthUserId. Идентификатор пользователя аутентификации Meraki. |
name string | Имя пользователя. Обязательно, только если пользователь не является администратором Dashboard. |
networkId string | Параметр пути NetworkId. Идентификатор сети. |
password string | Пароль учётной записи пользователя. Обязательно, только если пользователь не является администратором Dashboard. |
Примечания
Примечание
- Используются методы 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 Dashboard API Python(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_caller: "{{ meraki_caller }}"
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_caller: "{{ meraki_caller }}"
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_caller: "{{ meraki_caller }}"
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 dictionary | Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_meraki_auth_users_module.html