cisco.ise.reservation 模块 – 预留资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.ise.reservation。

cisco.ise 1.0.0 中的新增功能

概要

  • 管理资源预留的创建、更新和删除操作。

  • 为给定客户端预留连续范围内的给定 SGT 数量。

  • 删除给定客户端的预留 SGT 范围。

  • 通过给定自定义起始和结束索引来更新特定客户端的预留范围。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

clientID

字符串

ClientID 路径参数。客户端的唯一名称。

clientName

字符串

给定客户端的名称。

endIndex

整数

预留范围的结束索引。

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}}，其中 port 值取决于使用的服务（ERS、Mnt、UI、PxGrid）。

选项

  • false

  • true ←（默认）

ise_uses_csrf_token

布尔值

在 cisco.ise 3.0.0 中添加

通知 SDK 是否向 ISE 的 ERS API 发送 CSRF 令牌的标志。

如果为 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 ←（默认）

numberOfTags

整数

需要在 ISE 中预留的标签数量。

startIndex

整数

预留范围的起始索引。

说明

注意

  • 使用的 SDK 方法是 sgt_range_reservation.SgtRangeReservation.delete_sgt_reserve_range、sgt_range_reservation.SgtRangeReservation.reserve_sgt_range、sgt_range_reservation.SgtRangeReservation.update_reserved_range

  • 使用的路径是 post /api/v1/sgt/reservation/reserveRange、delete /api/v1/sgt/reservation/{clientID}、put /api/v1/sgt/reservation/{clientID}

  • 不支持 check_mode

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

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

示例

- name: Create
  cisco.ise.reservation:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    clientName: string
    numberOfTags: 0

- name: Update by id
  cisco.ise.reservation:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    clientID: string
    endIndex: 0
    startIndex: 0

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

返回值

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

键

描述

ise_response

字典

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

返回： 始终

示例： {"clientID": "string", "clientName": "string", "endIndex": 0, "startIndex": 0}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回： 始终

示例： {"success": {"message": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)