cisco.ise.active_directory_add_groups 模块 – 用于 Active Directory 添加组的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

管理 Active Directory 添加组资源的更新操作。
此 API 将 Active Directory 中的域组配置加载到 Cisco 中。

注意

此模块具有相应的 action 插件。

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
adAttributes 字典	保存 AD 属性列表。
attributes 列表 / 元素=字典	属性列表。
defaultValue 字符串	属性列表中每个属性的必需项。可以包含空字符串。除 <%” 之外，允许所有字符。
internalName 字符串	属性列表中每个属性的必需项。除 <%” 之外，允许所有字符。
name 字符串	属性列表中每个属性的必需项，属性之间不能重复。除 <%” 之外，允许所有字符。
type 字符串	组列表中每个组的必需项。允许值 STRING、IP、BOOLEAN、INT、OCTET_STRING。
adgroups 字典	保存 AD 组列表。
groups 列表 / 元素=字典	组列表。
name 字符串	组列表中每个组的必需项，组之间不能重复。除 % 之外，允许所有字符。
sid 字符串	Cisco ISE 使用安全标识符 (SID) 来优化组成员资格评估。当评估组时，SID 对于效率（速度）很有用。除 % 之外，允许所有字符。
type 字符串	没有字符限制。
adScopesNames 字符串	包含 Active Directory 所属作用域名称的字符串。名称以逗号分隔。允许使用字母数字和下划线 (_) 字符。
advancedSettings 字典	Active Directory 添加组的高级设置。
agingTime 整数	范围为 1-8760 小时。
authProtectionType 字符串	启用防止 AD 帐户锁定。允许的值 - WIRELESS, - WIRED, - BOTH。
country 字符串	用户信息属性。除 % 之外，允许所有字符。
department 字符串	用户信息属性。除 % 之外，允许所有字符。
email 字符串	用户信息属性。除 % 之外，允许所有字符。
enableCallbackForDialinClient 布尔值	EnableCallbackForDialinClient 标志。选项 `false` `true`
enableDialinPermissionCheck 布尔值	EnableDialinPermissionCheck 标志。选项 `false` `true`
enableFailedAuthProtection 布尔值	启用防止因密码尝试错误次数过多而导致的 AD 帐户锁定。选项 `false` `true`
enableMachineAccess 布尔值	EnableMachineAccess 标志。选项 `false` `true`
enableMachineAuth 布尔值	EnableMachineAuth 标志。选项 `false` `true`
enablePassChange 布尔值	EnablePassChange 标志。选项 `false` `true`
enableRewrites 布尔值	EnableRewrites 标志。选项 `false` `true`
failedAuthThreshold 整数	密码尝试错误次数。
firstName 字符串	用户信息属性。除 % 之外，允许所有字符。
identityNotInAdBehaviour 字符串	允许值 REJECT、SEARCH_JOINED_FOREST、SEARCH_ALL。
jobTitle 字符串	用户信息属性。除 % 之外，允许所有字符。
lastName 字符串	用户信息属性。除 % 之外，允许所有字符。
locality 字符串	用户信息属性。除 % 之外，允许所有字符。
organizationalUnit 字符串	用户信息属性。除 % 之外，允许所有字符。
plaintextAuth 布尔值	PlaintextAuth 标志。选项 `false` `true`
rewriteRules 列表 / 元素=字典	身份重写是一项高级功能，它指示 Cisco ISE 在将身份传递给外部 Active Directory 系统之前对其进行操作。您可以创建规则来将身份更改为所需的格式，包括或排除域前缀和/或后缀或您选择的其他标记。
rewriteMatch 字符串	列表中每个规则的必需项，规则之间不能重复。除 %” 之外，允许所有字符。
rewriteResult 字符串	列表中每个规则的必需项。除 %” 之外，允许所有字符。
rowId 整数	列表中每个规则按顺序的必需项。
schema 字符串	允许值 ACTIVE_DIRECTORY、CUSTOM。当 AD 中定义的 AD 属性可以复制到 Cisco ISE 中的相关属性时，请选择 ACTIVE_DIRECTORY 架构。如果需要自定义，请选择 CUSTOM 架构。如果 schema 为 ACTIVE_DIRECTORY，则所有用户信息属性始终设置为默认值。只能为 CUSTOM 架构更改值。
stateOrProvince 字符串	用户信息属性。除 % 之外，允许所有字符。
streetAddress 字符串	用户信息属性。除 % 之外，允许所有字符。
telephone 字符串	用户信息属性。除 % 之外，允许所有字符。
unreachableDomainsBehaviour 字符串	允许值 PROCEED、DROP。
description 字符串	没有字符限制。
domain 字符串	AD 域。允许使用字母数字、连字符 (-) 和点 (.) 字符。
enableDomainWhiteList 布尔值	EnableDomainWhiteList 标志。选项 `false` `true`
id 字符串	资源 UUID 值。
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` ← (默认)
name 字符串	资源名称。允许的最大字符数为 32 个。允许的字符为字母数字字符和 .-_/\\ 字符。

注释 

注意

使用的 SDK 方法是 active_directory.ActiveDirectory.load_groups_from_domain，
使用的路径是 put /ers/config/activedirectory/{id}/addGroups，
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update all
  cisco.ise.active_directory_add_groups:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    adAttributes:
      attributes:
      - defaultValue: string
        internalName: string
        name: string
        type: string
    adScopesNames: string
    adgroups:
      groups:
      - name: string
        sid: string
        type: string
    advancedSettings:
      agingTime: 0
      authProtectionType: string
      country: string
      department: string
      email: string
      enableCallbackForDialinClient: true
      enableDialinPermissionCheck: true
      enableFailedAuthProtection: true
      enableMachineAccess: true
      enableMachineAuth: true
      enablePassChange: true
      enableRewrites: true
      failedAuthThreshold: 0
      firstName: string
      identityNotInAdBehaviour: string
      jobTitle: string
      lastName: string
      locality: string
      organizationalUnit: string
      plaintextAuth: true
      rewriteRules:
      - rewriteMatch: string
        rewriteResult: string
        rowId: 0
      schema: string
      stateOrProvince: string
      streetAddress: string
      telephone: string
      unreachableDomainsBehaviour: string
    description: string
    domain: string
    enableDomainWhiteList: true
    id: string
    name: string

返回值 

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

键	描述
ise_response 字典	由 Cisco ISE Python SDK 返回的响应的字典或列表返回: 始终示例: `{}`

作者

Rafael Campos (@racampos)