cisco.ise.duo_identity_sync_status 模块 – Duo 身份同步状态的资源模块

注意

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

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.ise。要使用此模块，您需要满足其他要求，请参阅要求了解更多详情。

要在 playbook 中使用它，请指定： cisco.ise.duo_identity_sync_status。

cisco.ise 1.0.0 中的新增功能

概要 

管理 Duo 身份同步状态资源的操作更新。
Duo-identitysync - 更新同步状态。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
errorList 列表 / 元素=字典	Duo 身份同步状态的 errorList。
reason 字符串	用户同步失败的原因。
user 字典	要同步到 Duo 的用户。
directoryname 字符串	包含 Duo 用户的活动目录。
email 字符串	Duo 用户的邮箱。
firstname 字符串	Duo 用户的姓名。
groupname 字符串	Duo 用户所属的活动目录组。
lastname 字符串	Duo 用户的姓氏。
notes 字符串	Duo 用户的备注。
realname 字符串	Duo 用户的真实姓名。
status 字符串	Duo 用户的状态。
username 字符串	Duo 用户的用户名。
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` ← (默认)
status 字符串	同步状态。
syncName 字符串	SyncName 路径参数。要更新的同步连接。

注释 

注意

使用的 SDK 方法为 duo_identity_sync.DuoIdentitySync.update_status，
使用的路径为 put /api/v1/duo-identitysync/identitysync/status/{syncName}，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update by name
  cisco.ise.duo_identity_sync_status:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    errorList:
    - reason: string
      user:
        directoryname: string
        email: string
        firstname: string
        groupname: string
        lastname: string
        notes: string
        realname: string
        status: string
        username: string
    status: string
    syncName: string

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
ise_response 字符串	包含 Cisco ISE Python SDK 返回的响应的字典或列表返回：始终示例： `"\"'string'\"\n"`

作者

Rafael Campos (@racampos)