Модуль cisco.dnac.users_external_authentication – Модуль ресурсов для внешней аутентификации пользователей

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.users_external_authentication.

Новое в cisco.dnac 6.14.0

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

Обзор

Управление операцией создания ресурса Внешняя аутентификация пользователей.
Включение или выключение внешней аутентификации в системе Cisco DNA Center.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для включения отладки в Cisco DNA Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
enable boolean	Включение/выключение внешней аутентификации. Варианты: `false` `true`
validate_response_schema boolean	Флаг для включения проверки ответов Cisco DNA Center SDK на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: user_and_roles.UserandRoles.manage_external_authentication_setting_api,
Используемые пути: post /dna/system/api/v1/users/external-authentication,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center по управлению параметрами внешней аутентификации пользователей и ролей: Полное описание API ManageExternalAuthenticationSettingAPI.

Примеры

- name: Create
  cisco.dnac.users_external_authentication:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    enable: true

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"message": "string"}`

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 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/dnac/users_external_authentication_module.html