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。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在剧本中使用它，请指定：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 添加组的 advancedSettings。
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 模式。如果模式为 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 字符串 / 必填	身份服务引擎主机名。
ise_password 字符串 / 必填	用于身份验证的身份服务引擎密码。
ise_single_request_timeout 整数在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认值： `60`
ise_username 字符串 / 必填	用于身份验证的身份服务引擎用户名。
ise_uses_api_gateway 布尔值在 cisco.ise 1.1.0 中添加	告知 SDK 是否使用身份服务引擎的 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)