cisco.ise.duo_mfa 模块 – Duo MFA 资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您使用的是 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 - 删除 connectionName 中指定的 Duo-MFA 配置。
Duo-MFA - 更新 connectionName 中指定的 Duo-MFA 配置。

注意

此模块具有相应的动作插件。

需求 

执行此模块的主机需要以下要求。

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
accountConfigurations 字典	Duo MFA 的 accountConfigurations。
adminApi 字典	API 类型。
ikey 字符串	集成密钥。
sKey 字符串	密钥。
apiHostName 字符串	Duo API 主机名。
authenticationApi 字典	API 类型。
ikey 字符串	集成密钥。
sKey 字符串	密钥。
connectionName 字符串	Duo-MFA 配置的名称。
description 字符串	Duo-MFA 配置的描述。
identitySync 字符串	身份同步配置的名称。
ise_debug 布尔值	用于启用 Identity Services Engine SDK 调试的标志。选项 `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 是否使用 Identity Services Engine 的 API 网关发送请求的标志。如果为 true，则使用 ISE 的 API 网关并将请求发送到 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 令牌发送到 ISE 的 ERS API 的标志。如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。如果为 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"`

作者

Rafael Campos (@racampos)