cisco.ise.network_access_local_exception_rules 模块 – 网络访问本地例外规则的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定: cisco.ise.network_access_local_exception_rules

cisco.ise 1.0.0 中的新增功能

概要

  • 管理资源网络访问本地例外规则的创建、更新和删除操作。

  • 网络访问 - 创建本地授权例外规则。

  • 网络访问 - 删除本地例外规则。

  • 网络访问 - 更新本地例外规则。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

id

字符串

Id 路径参数。规则 id。

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 ← (默认)

字典

网络访问本地例外规则的链接。

字符串

网络访问本地例外规则的 href。

字符串

网络访问本地例外规则的 rel。

字符串

网络访问本地例外规则的类型。

policyId

字符串

PolicyId 路径参数。策略 id。

profile

列表 / 元素=字符串

授权配置文件。

rule

字典

规则身份验证/授权中的常见属性。

condition

字典

网络访问本地例外规则的条件。

attributeId

字符串

字典属性 id(可选),用于其他验证。

attributeName

字符串

字典属性名称。

attributeValue

字符串

<ul><li>条件的属性值</li> <li>值类型在字典对象中指定</li> <li>如果允许在字典对象中指定多个值</li></ul>。

children

列表 / 元素=字典

如果类型为 andBlock 或 orBlock,则其他条件将在此逻辑(OR/AND)条件下聚合。

conditionType

字符串

<ul><li>指示记录是条件本身(数据)还是逻辑(or,and)聚合</li> <li>数据类型枚举(reference、single)指示“conditonId”或“ConditionAttrs”字段应包含条件数据,但不能两者都包含</li> <li>逻辑聚合(and、or)枚举指示子字段下存在其他条件</li></ul>。

isNegate

布尔值

指示此条件是否处于否定模式。

选项

  • false

  • true

字典

网络访问本地例外规则的链接。

字符串

网络访问本地例外规则的 href。

字符串

网络访问本地例外规则的 rel。

字符串

网络访问本地例外规则的类型。

conditionType

字符串

<ul><li>指示记录是条件本身(数据)还是逻辑(or,and)聚合</li> <li>数据类型枚举(reference、single)指示“conditonId”或“ConditionAttrs”字段应包含条件数据,但不能两者都包含</li> <li>逻辑聚合(and、or)枚举指示子字段下存在其他条件</li></ul>。

datesRange

字典

<p>定义如果 TimeAndDate 条件在 exceptionDates 属性中使用时,哪些日期将被匹配或不匹配<br> 选项包括 - 日期范围,特定日期,开始/结束日期应使用同一日期 <br> 默认值 - 无特定日期<br> 为了将日期重置为无特定日期,日期格式 - yyyy-mm-dd (MM = 月份, dd = 日, yyyy = 年)</p>。

endDate

字符串

网络访问本地异常规则的结束日期。

startDate

字符串

网络访问本地异常规则的开始日期。

datesRangeException

字典

<p>定义如果 TimeAndDate 条件在 exceptionDates 属性中使用时,哪些日期将被匹配或不匹配<br> 选项包括 - 日期范围,特定日期,开始/结束日期应使用同一日期 <br> 默认值 - 无特定日期<br> 为了将日期重置为无特定日期,日期格式 - yyyy-mm-dd (MM = 月份, dd = 日, yyyy = 年)</p>。

endDate

字符串

网络访问本地异常规则的结束日期。

startDate

字符串

网络访问本地异常规则的开始日期。

description

字符串

条件描述。

dictionaryName

字符串

字典名称。

dictionaryValue

字符串

字典值。

hoursRange

字典

<p>定义如果 TimeAndDate 条件在 exceptionHours 属性中使用时,哪些小时将被匹配或不匹配<br> 时间格式 - hh mm (h = 小时, mm = 分钟) <br> 默认值 - 全天 </p>。

endTime

字符串

网络访问本地异常规则的结束时间。

startTime

字符串

网络访问本地异常规则的开始时间。

hoursRangeException

字典

<p>定义如果 TimeAndDate 条件在 exceptionHours 属性中使用时,哪些小时将被匹配或不匹配<br> 时间格式 - hh mm (h = 小时, mm = 分钟) <br> 默认值 - 全天 </p>。

endTime

字符串

网络访问本地异常规则的结束时间。

startTime

字符串

网络访问本地异常规则的开始时间。

id

字符串

网络访问本地异常规则的 ID。

isNegate

布尔值

指示此条件是否处于否定模式。

选项

  • false

  • true

字典

网络访问本地例外规则的链接。

字符串

网络访问本地例外规则的 href。

字符串

网络访问本地例外规则的 rel。

字符串

网络访问本地例外规则的类型。

name

字符串

条件名称。

operator

字符串

相等运算符。

weekDays

列表 / 元素=字符串

<p>定义此条件将匹配哪些天<br> 天格式 - WeekDay 枚举的数组 <br> 默认值 - 所有星期的列表 </p>。

weekDaysException

列表 / 元素=字符串

<p>定义此条件将不匹配哪些天<br> 天格式 - WeekDay 枚举的数组 <br> 默认值 - 未启用</p>。

default

布尔值

指示此规则是否为默认规则。

选项

  • false

  • true

hitCounts

整数

规则被匹配的次数。

id

字符串

规则的标识符。

name

字符串

规则名称,有效字符为字母数字、下划线、连字符、空格、句点、括号。

rank

整数

相对于其他规则的等级(优先级)。等级越低,优先级越高。

state

字符串

规则所处的状态。禁用的规则不能被匹配。

securityGroup

字符串

授权策略中使用的安全组。

注释

注意

  • 使用的 SDK 方法是 network_access_authorization_exception_rules.NetworkAccessAuthorizationExceptionRules.create_network_access_local_exception_rule, network_access_authorization_exception_rules.NetworkAccessAuthorizationExceptionRules.delete_network_access_local_exception_rule_by_id, network_access_authorization_exception_rules.NetworkAccessAuthorizationExceptionRules.update_network_access_local_exception_rule_by_id,

  • 使用的路径是 post /network-access/policy-set/{policyId}/exception, delete /network-access/policy-set/{policyId}/exception/{id}, put /network-access/policy-set/{policyId}/exception/{id},

  • 不支持 check_mode

  • 该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco ISE SDK 中嵌入的连接管理器。

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参阅

另请参阅

Cisco ISE 网络访问 - 授权异常规则文档

网络访问 - 授权异常规则 API 的完整参考。

示例

- name: Create
  cisco.ise.network_access_local_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    link:
      href: string
      rel: string
      type: string
    policyId: string
    profile:
    - 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
    securityGroup: string

- name: Update by id
  cisco.ise.network_access_local_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    link:
      href: string
      rel: string
      type: string
    policyId: string
    profile:
    - 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
    securityGroup: string

- name: Delete by id
  cisco.ise.network_access_local_exception_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string
    policyId: string

返回值

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

描述

ise_response

字典

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

返回: 始终

示例: {"link": {"href": "string", "rel": "string", "type": "string"}, "profile": ["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"}, "securityGroup": "string"}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回: 始终

示例: {"response": {"link": {"href": "string", "rel": "string", "type": "string"}, "profile": ["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"}, "securityGroup": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)