cisco.ise.active_directory 模块 – 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。
cisco.ise 1.0.0 中的新增功能
概要
管理资源 Active Directory 的创建和删除操作。
此 API 在 Cisco ISE 中创建一个 AD 加入点。
此 API 从 Cisco ISE 删除一个 AD 加入点。
注意
此模块具有相应的 操作插件。
要求
在执行此模块的主机上需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
保存 AD 属性列表。 |
|
属性列表。 |
|
属性列表中每个属性都必需。可以包含空字符串。允许除 <%” 之外的所有字符。 |
|
属性列表中每个属性都必需。允许除 <%” 之外的所有字符。 |
|
属性列表中每个属性都必需，属性之间不能重复。允许除 <%” 之外的所有字符。 |
|
组列表中每个组都必需。允许的值 STRING、IP、BOOLEAN、INT、OCTET_STRING。 |
|
保存 AD 组列表。 |
|
组列表。 |
|
组列表中每个组都必需，组之间不能重复。允许除 % 之外的所有字符。 |
|
Cisco ISE 使用安全标识符 (SID) 来优化组成员资格评估。当评估组时，SID 对于效率（速度）很有用。允许除 % 之外的所有字符。 |
|
无字符限制。 |
|
包含活动目录所属范围名称的字符串。名称用逗号分隔。允许使用字母数字和下划线 (_) 字符。 |
|
Active Directory 的 advancedSettings。 |
|
范围 1-8760 小时。 |
|
启用防止 AD 帐户锁定。允许的值 - WIRELESS、- WIRED、- BOTH。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
EnableCallbackForDialinClient 标志。 选择
|
|
EnableDialinPermissionCheck 标志。 选择
|
|
启用防止因密码尝试错误次数过多而导致的 AD 帐户锁定。 选择
|
|
EnableMachineAccess 标志。 选择
|
|
EnableMachineAuth 标志。 选择
|
|
EnablePassChange 标志。 选择
|
|
EnableRewrites 标志。 选择
|
|
密码尝试错误次数。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
允许的值 REJECT、SEARCH_JOINED_FOREST、SEARCH_ALL。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
PlaintextAuth 标志。 选择
|
|
身份重写是一项高级功能，它指示 Cisco ISE 在将身份传递到外部 Active Directory 系统之前对其进行操作。您可以创建规则来将身份更改为所需的格式，该格式包括或排除域前缀和/或后缀或您选择的其他附加标记。 |
|
列表中每个规则都必需，规则之间不能重复。允许除 %” 之外的所有字符。 |
|
列表中每个规则都必需。允许除 %” 之外的所有字符。 |
|
列表中每个规则都必需，按顺序排列。 |
|
允许的值 ACTIVE_DIRECTORY、CUSTOM。当 AD 中定义的 AD 属性可以复制到 Cisco ISE 中的相关属性时，选择 ACTIVE_DIRECTORY 模式。如果需要自定义，请选择 CUSTOM 模式。如果模式为 ACTIVE_DIRECTORY，则所有用户信息属性始终设置为默认值。只能为 CUSTOM 模式更改值。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
用户信息属性。允许除 % 之外的所有字符。 |
|
允许的值 PROCEED、DROP。 |
|
无字符限制。 |
|
AD 域。允许使用字母数字、连字符 (-) 和点 (.) 字符。 |
|
EnableDomainWhiteList 标志。 选择
|
|
Id 路径参数。 |
|
用于 Identity Services Engine SDK 以启用调试的标志。 选择
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时时间（以秒为单位）。 默认值： |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。 如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选择
|
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用的 Identity Services Engine 版本。 默认值: |
|
用于 Identity Services Engine SDK 启用自动速率限制处理的标志。 选择
|
|
资源名称。允许的最大字符数为 32 个。允许的字符为字母数字字符和 .-_/\ 字符。 |
备注
注意
使用的 SDK 方法是 active_directory.ActiveDirectory.create_active_directory, active_directory.ActiveDirectory.delete_active_directory_by_id,
使用的路径是 post /ers/config/activedirectory, delete /ers/config/activedirectory/{id},
不支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Delete by id
cisco.ise.active_directory:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.active_directory:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
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
返回值
常用返回值在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco ISE Python SDK 返回的响应 返回: 始终 示例: |