cisco.ise.sxp_vpns_bulk_request 模块 – SXP VPN 批量请求的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

  • 管理 SXP VPN 批量请求资源的操作更新。

  • 此 API 允许客户端提交批量请求。

注意

此模块有一个对应的 action 插件

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

ise_debug

boolean

用于启用调试的 Identity Services Engine SDK 标志。

选项

  • false ←(默认)

  • true

ise_hostname

string / 必填

Identity Services Engine 主机名。

ise_password

string / 必填

用于身份验证的 Identity Services Engine 密码。

ise_single_request_timeout

integer

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时时间(以秒为单位)。

默认值: 60

ise_username

string / 必填

用于身份验证的 Identity Services Engine 用户名。

ise_uses_api_gateway

boolean

在 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

boolean

在 cisco.ise 3.0.0 中添加

一个标志,通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API。

如果为 True,则 SDK 假定您的 ISE CSRF 检查已启用。

如果为 True,则假定您需要 SDK 为您自动管理 CSRF 令牌。

选项

  • false ←(默认)

  • true

ise_verify

boolean

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ←(默认)

ise_version

string

通知 SDK 使用哪个版本的 Identity Services Engine。

默认值: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

用于启用 Identity Services Engine SDK 自动速率限制处理的标志。

选项

  • false

  • true ←(默认)

operationType

string

SXP VPN 批量请求的 operationType。

resourceMediaType

string

SXP VPN 批量请求的 resourceMediaType。

备注

注意

  • 使用的 SDK 方法是 sxp_vpns.SxpVpns.bulk_request_for_sxp_vpns,

  • 使用的路径是 put /ers/config/sxpvpns/bulk/submit,

  • 不支持 check_mode

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

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

示例

- name: Update all
  cisco.ise.sxp_vpns_bulk_request:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    operationType: string
    resourceMediaType: string

返回值

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

描述

ise_response

dictionary

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

返回: 始终

示例: {}

作者

  • Rafael Campos (@racampos)