Модуль cisco.ise.duo_mfa — Модуль ресурсов для Duo Mfa

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.duo_mfa.

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

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

Описание

Управление операциями создания, обновления и удаления ресурса Duo Mfa.
Duo-MFA — Создание новой конфигурации Duo-MFA.
Duo-MFA — Удаление конфигурации Duo-MFA, указанной в connectionName.
Duo-MFA — Обновление конфигурации Duo-MFA, указанной в connectionName.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
accountConfigurations словарь	Настройки учетных записей Duo MFA.
adminApi словарь	Тип API.
ikey строка	Ключ интеграции.
sKey строка	Секретный ключ.
apiHostName строка	Имя хоста API Duo.
authenticationApi словарь	Тип API.
ikey строка	Ключ интеграции.
sKey строка	Секретный ключ.
connectionName строка	Имя конфигурации Duo-MFA.
description строка	Описание конфигурации Duo-MFA.
identitySync строка	Имя конфигурации синхронизации идентификаторов.
ise_debug логическое	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway логическое добавлен в cisco.ise 1.1.0	Флаг, указывающий SDK, использовать ли шлюз API Identity Services Engine для отправки запросов. Если true, используется шлюз API ISE и запросы отправляются по адресу https://{{ise_hostname}}. Если false, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлен в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли токен CSRF в API ERS ISE. Если true, SDK предполагает, что проверка CSRF ISE включена. Если true, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для включения автоматической обработки лимитов запросов в Identity Services Engine SDK. Варианты: `false` `true` ← (по умолчанию)
type строка	Тип протокола, для которого можно использовать Duo-MFA.

Примечания

Примечание

Используемые методы SDK: duo_mfa.DuoMfa.create_mfa, duo_mfa.DuoMfa.delete_mfa_by_connection_name, duo_mfa.DuoMfa.update_m_fa_by_connection_name,
Используемые пути: post /api/v1/duo-mfa/mfa, delete /api/v1/duo-mfa/mfa/{connectionName}, put /api/v1/duo-mfa/mfa/{connectionName},
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Create
  cisco.ise.duo_mfa:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountConfigurations:
      adminApi:
        ikey: string
        sKey: string
      apiHostName: string
      authenticationApi:
        ikey: string
        sKey: string
    connectionName: string
    description: string
    identitySync: string
    type: string

- name: Update by name
  cisco.ise.duo_mfa:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountConfigurations:
      adminApi:
        ikey: string
        sKey: string
      apiHostName: string
      authenticationApi:
        ikey: string
        sKey: string
    connectionName: string
    description: string
    identitySync: string
    type: string

- name: Delete by name
  cisco.ise.duo_mfa:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    connectionName: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список, содержащий ответ, возвращенный Cisco ISE Python SDK Возвращается: всегда Пример: `{"mfa": {"accountConfigurations": {"adminApi": {"ikey": "string", "sKey": "string"}, "apiHostName": "string", "authenticationApi": {"ikey": "string", "sKey": "string"}}, "connectionName": "string", "description": "string", "identitySync": "string", "type": "string"}}`
ise_update_response строка добавлено в cisco.ise 1.1.0	Словарь или список, содержащий ответ, возвращенный Cisco ISE Python SDK Возвращается: всегда Пример: `"\"'string'\"\n"`

Ключ

Описание

ise_response

словарь

Словарь или список, содержащий ответ, возвращенный Cisco ISE Python SDK

Возвращается: всегда

Пример: {"mfa": {"accountConfigurations": {"adminApi": {"ikey": "string", "sKey": "string"}, "apiHostName": "string", "authenticationApi": {"ikey": "string", "sKey": "string"}}, "connectionName": "string", "description": "string", "identitySync": "string", "type": "string"}}

ise_update_response

строка

добавлено в cisco.ise 1.1.0

Словарь или список, содержащий ответ, возвращенный Cisco ISE Python SDK

Возвращается: всегда

Пример: "\"'string'\"\n"

Авторы

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/ise/duo_mfa_module.html