cisco.ise.duo_identity_sync 模块 – 用于 Duo Identity Sync 的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅要求以了解详细信息。

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

cisco.ise 1.0.0 中的新增功能

概要 

管理资源 Duo Identity Sync 的创建、更新和删除操作。
Duo-IdentitySync - 创建新的 IdentitySync 配置。
Duo-Identitysync - 删除 syncName 中指定的 Identitysync 配置。
Duo-Identitysync - 更新 syncName 中指定的 Identitysync 配置。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
adGroups 列表 / 元素=字典	Duo Identity Sync 的 adGroups。
name 字符串	Active Directory 组 ID。
source 字符串	Active Directory 组的来源。
configurations 字典	Duo Identity Sync 的配置。
activeDirectories 列表 / 元素=字典	Duo Identity Sync 的 activeDirectories。
directoryID 字符串	Active Directory ID。
domain 字符串	Active Directory 域名。
name 字符串	Active Directory 的名称。
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}}，其中 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` ←（默认）
lastSync 字符串	上次同步的时间。
syncName 字符串	Identitysync 配置的名称。
syncSchedule 字典	Duo Identity Sync 的 syncSchedule。
interval 整数	同步计划的频率。
intervalUnit 字符串	时间间隔的单位。
schedulerSync 字符串	同步计划的类型 - 如果为“Recurring”，请指定计划详细信息。
startDate 字符串	同步计划的开始日期和开始时间。
syncStatus 字符串	Duo Identity Sync 的 syncStatus。

说明 

注意

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

示例 

- name: Create
  cisco.ise.duo_identity_sync:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    adGroups:
    - name: string
      source: string
    configurations:
      activeDirectories:
      - directoryID: string
        domain: string
        name: string
    lastSync: string
    syncName: string
    syncSchedule:
      interval: 0
      intervalUnit: string
      schedulerSync: string
      startDate: string
    syncStatus: string

- name: Update by name
  cisco.ise.duo_identity_sync:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    adGroups:
    - name: string
      source: string
    configurations:
      activeDirectories:
      - directoryID: string
        domain: string
        name: string
    lastSync: string
    syncName: string
    syncSchedule:
      interval: 0
      intervalUnit: string
      schedulerSync: string
      startDate: string
    syncStatus: string

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

返回值 

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

键

描述

ise_response

字典

包含 Cisco ISE Python SDK 返回的响应的字典或列表

返回值： 总是

示例： {"identitySync": {"adGroups": [{"name": "string", "sid": "string", "source": "string"}], "configurations": {"activeDirectories": [{"directoryID": "string", "domain": "string", "name": "string"}]}, "lastSync": "string", "syncName": "string", "syncSchedule": {"interval": 0, "intervalUnit": "string", "schedulerSync": "string", "startDate": "string"}, "syncStatus": "string"}}

ise_update_response

字符串

在 cisco.ise 1.1.0 中添加

包含 Cisco ISE Python SDK 返回的响应的字典或列表

返回值： 总是

示例： "\"'string'\"\n"

作者

Rafael Campos (@racampos)