cisco.ise.device_administration_authentication_rules 模块 – 设备管理身份验证规则的资源模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。
要在 playbook 中使用它，请指定：cisco.ise.device_administration_authentication_rules。
cisco.ise 1.0.0 中的新增功能
概要
管理设备管理身份验证规则资源的创建、更新和删除操作。
设备管理员 - 创建身份验证规则。
设备管理员 - 删除规则。
设备管理员 - 更新规则。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
Id 路径参数。规则 ID。 |
|
身份存储中的身份源 ID。 |
|
身份存储中的身份源名称。 |
|
身份验证失败时要执行的操作，例如错误的凭据、用户被禁用等。 |
|
ISE 无法访问身份数据库时要执行的操作。 |
|
在任何身份存储中都找不到用户时要执行的操作。 |
|
用于 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 的标志，用于启用自动速率限制处理。 选项
|
|
设备管理身份验证规则的链接。 |
|
设备管理身份验证规则的 href。 |
|
设备管理身份验证规则的 rel。 |
|
设备管理身份验证规则的 type。 |
|
PolicyId 路径参数。策略 ID。 |
|
规则身份验证/授权中的公共属性。 |
|
设备管理身份验证规则的条件。 |
|
字典属性 ID（可选），用于附加验证。 |
|
字典属性名称。 |
|
<ul><li>条件的属性值</li> <li>值类型在字典对象中指定</li> <li>如果允许多个值，则在字典对象中指定</li></ul>。 |
|
如果类型为 andBlock 或 orBlock，则附加条件将在此逻辑（OR/AND）条件下聚合。 |
|
<ul><li>指示记录本身是条件（数据）还是逻辑（或、与）聚合</li> <li>数据类型枚举（reference、single）指示“conditonId”或“ConditionAttrs”字段应包含条件数据，但不能同时包含两者</li> <li>逻辑聚合（and、or）枚举指示子级字段中存在其他条件</li></ul>。 |
|
指示此条件是否处于否定模式。 选项
|
|
设备管理身份验证规则的链接。 |
|
设备管理身份验证规则的 href。 |
|
设备管理身份验证规则的 rel。 |
|
设备管理身份验证规则的 type。 |
|
<ul><li>指示记录本身是条件（数据）还是逻辑（或、与）聚合</li> <li>数据类型枚举（reference、single）指示“conditonId”或“ConditionAttrs”字段应包含条件数据，但不能同时包含两者</li> <li>逻辑聚合（and、or）枚举指示子级字段中存在其他条件</li></ul>。 |
|
<p>定义 TimeAndDate 条件将在哪些日期匹配或不匹配（如果用于 exceptionDates 属性）<br>选项包括 - 日期范围，对于特定日期，应使用相同的日期作为开始/结束日期 <br> 默认 - 没有特定日期 <br> 为了将日期重置为没有特定日期，日期格式为 yyyy-mm-dd（MM = 月，dd = 日，yyyy = 年）</p>。 |
|
设备管理身份验证规则的 endDate。 |
|
设备管理身份验证规则的 startDate。 |
|
<p>定义 TimeAndDate 条件将在哪些日期匹配或不匹配（如果用于 exceptionDates 属性）<br>选项包括 - 日期范围，对于特定日期，应使用相同的日期作为开始/结束日期 <br> 默认 - 没有特定日期 <br> 为了将日期重置为没有特定日期，日期格式为 yyyy-mm-dd（MM = 月，dd = 日，yyyy = 年）</p>。 |
|
设备管理身份验证规则的 endDate。 |
|
设备管理身份验证规则的 startDate。 |
|
条件描述。 |
|
字典名称。 |
|
字典值。 |
|
<p>定义 TimeAndDate 条件将在哪些小时匹配或不匹配（如果用于 exceptionHours 属性）<br>时间格式 - hh mm (h = 小时，mm = 分钟) <br> 默认 - 全天 </p>。 |
|
设备管理身份验证规则的 endTime。 |
|
设备管理身份验证规则的 startTime。 |
|
<p>定义 TimeAndDate 条件将在哪些小时匹配或不匹配（如果用于 exceptionHours 属性）<br>时间格式 - hh mm (h = 小时，mm = 分钟) <br> 默认 - 全天 </p>。 |
|
设备管理身份验证规则的 endTime。 |
|
设备管理身份验证规则的 startTime。 |
|
设备管理身份验证规则的 ID。 |
|
指示此条件是否处于否定模式。 选项
|
|
设备管理身份验证规则的链接。 |
|
设备管理身份验证规则的 href。 |
|
设备管理身份验证规则的 rel。 |
|
设备管理身份验证规则的 type。 |
|
条件名称。 |
|
等号运算符。 |
|
<p>定义此条件将在哪些日期匹配<br>日期格式 - 星期几枚举的数组 <br> 默认 - 所有星期的列表</p>。 |
|
<p>定义此条件将在哪些日期不匹配<br>日期格式 - 星期几枚举的数组 <br> 默认 - 未启用</p>。 |
|
指示此规则是否为默认规则。 选项
|
|
规则匹配的次数。 |
|
规则的标识符。 |
|
规则名称，有效字符为字母数字、下划线、连字符、空格、句点、括号。 |
|
相对于其他规则的等级（优先级）。等级越低，优先级越高。 |
|
规则所处的状态。禁用的规则无法匹配。 |
注释
注意
使用的 SDK 方法为 device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.create_device_admin_authentication_rule、device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.delete_device_admin_authentication_rule_by_id、device_administration_authentication_rules.DeviceAdministrationAuthenticationRules.update_device_admin_authentication_rule_by_id。
使用的路径为 post /device-admin/policy-set/{policyId}/authentication、delete /device-admin/policy-set/{policyId}/authentication/{id}、put /device-admin/policy-set/{policyId}/authentication/{id}。
不支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco ISE 设备管理 - 身份验证规则文档。
设备管理 - 身份验证规则 API 的完整参考。
示例
- name: Create
cisco.ise.device_administration_authentication_rules:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
identitySourceId: string
identitySourceName: string
ifAuthFail: string
ifProcessFail: string
ifUserNotFound: string
link:
href: string
rel: string
type: string
policyId: string
rule:
condition:
attributeId: string
attributeName: string
attributeValue: string
children:
- conditionType: string
isNegate: true
link:
href: string
rel: string
type: string
conditionType: string
datesRange:
endDate: string
startDate: string
datesRangeException:
endDate: string
startDate: string
description: string
dictionaryName: string
dictionaryValue: string
hoursRange:
endTime: string
startTime: string
hoursRangeException:
endTime: string
startTime: string
id: string
isNegate: true
link:
href: string
rel: string
type: string
name: string
operator: string
weekDays:
- string
weekDaysException:
- string
default: true
hitCounts: 0
id: string
name: string
rank: 0
state: string
- name: Update by id
cisco.ise.device_administration_authentication_rules:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
id: string
identitySourceId: string
identitySourceName: string
ifAuthFail: string
ifProcessFail: string
ifUserNotFound: string
link:
href: string
rel: string
type: string
policyId: string
rule:
condition:
attributeId: string
attributeName: string
attributeValue: string
children:
- conditionType: string
isNegate: true
link:
href: string
rel: string
type: string
conditionType: string
datesRange:
endDate: string
startDate: string
datesRangeException:
endDate: string
startDate: string
description: string
dictionaryName: string
dictionaryValue: string
hoursRange:
endTime: string
startTime: string
hoursRangeException:
endTime: string
startTime: string
id: string
isNegate: true
link:
href: string
rel: string
type: string
name: string
operator: string
weekDays:
- string
weekDaysException:
- string
default: true
hitCounts: 0
id: string
name: string
rank: 0
state: string
- name: Delete by id
cisco.ise.device_administration_authentication_rules:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
policyId: string
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终 示例： |
|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终 示例： |