cisco.ise.device_administration_policy_set 模块 – 设备管理策略集的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

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

cisco.ise 1.0.0 中新增

概要

  • 管理资源设备管理策略集的创建、更新和删除操作。

  • 设备管理 - 创建新的策略集。

  • 设备管理 - 删除策略集。

  • 设备管理 - 更新策略集。

注意

此模块有一个相应的 操作插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

condition

字典

设备管理策略集的条件。

attributeId

字符串

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

attributeName

字符串

字典属性名称。

attributeValue

字符串

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

children

列表 / elements=字典

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

conditionType

字符串

<ul><li>指示记录是条件本身(数据)还是逻辑(或,和)聚合</li> <li>数据类型枚举(引用,单个)指示“conditonId”或“ConditionAttrs”字段应包含条件数据,但不能同时包含两者</li> <li>逻辑聚合(和,或)枚举指示 children 字段下存在其他条件</li></ul>。

isNegate

布尔值

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

选择

  • false

  • true

字典

设备管理策略集的链接。

字符串

设备管理策略集的 href。

字符串

设备管理策略集的 rel。

字符串

设备管理策略集的类型。

conditionType

字符串

<ul><li>指示记录是条件本身(数据)还是逻辑(或,和)聚合</li> <li>数据类型枚举(引用,单个)指示“conditonId”或“ConditionAttrs”字段应包含条件数据,但不能同时包含两者</li> <li>逻辑聚合(和,或)枚举指示 children 字段下存在其他条件</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

列表 / elements=字符串

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

weekDaysException

列表 / elements=字符串

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

default

布尔值

一个标志,指示此策略集是否为默认策略集。

选择

  • false

  • true

description

字符串

策略集的描述。

hitCounts

整数

策略匹配的次数。

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 网关发送请求。

如果为真,它将使用 ISE 的 API 网关并向 https://{{ise_hostname}} 发送请求。

如果为假,它将向 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 ←(默认)

isProxy

布尔值

一个标志,指示策略集服务是否为“代理序列”或“允许协议”类型。

选择

  • false

  • true

字典

设备管理策略集的链接。

字符串

设备管理策略集的 href。

字符串

设备管理策略集的 rel。

字符串

设备管理策略集的类型。

name

字符串

策略集的给定名称。有效字符为字母数字、下划线、连字符、空格、句点和圆括号。

rank

整数

相对于其他策略集的排名(优先级)。排名越低,优先级越高。

serviceName

字符串

策略集服务标识符 - 允许的协议、服务器序列等。

state_

字符串

策略集所处的状态。禁用的策略集无法匹配。

备注

注意

  • 使用的 SDK 方法是 device_administration_policy_set.DeviceAdministrationPolicySet.create_device_admin_policy_set、device_administration_policy_set.DeviceAdministrationPolicySet.delete_device_admin_policy_set_by_id、device_administration_policy_set.DeviceAdministrationPolicySet.update_device_admin_policy_set_by_id。

  • 使用的路径是 post /device-admin/policy-set,delete /device-admin/policy-set/{id},put /device-admin/policy-set/{id}。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关设备管理的 Cisco ISE 文档 - 策略集

设备管理 - 策略集 API 的完整参考。

示例

- name: Create
  cisco.ise.device_administration_policy_set:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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
    description: string
    hitCounts: 0
    id: string
    isProxy: true
    link:
      href: string
      rel: string
      type: string
    name: string
    rank: 0
    serviceName: string
    state_: string

- name: Update by id
  cisco.ise.device_administration_policy_set:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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
    description: string
    hitCounts: 0
    id: string
    isProxy: true
    link:
      href: string
      rel: string
      type: string
    name: string
    rank: 0
    serviceName: string
    state_: string

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

返回值

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

描述

ise_response

字典

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

返回: 始终

示例: {"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, "description": "string", "hitCounts": 0, "id": "string", "isProxy": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "rank": 0, "serviceName": "string", "state": "string"}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回: 始终

示例: {"response": {"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, "description": "string", "hitCounts": 0, "id": "string", "isProxy": true, "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "rank": 0, "serviceName": "string", "state": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)