cisco.ise.proxy_connection_settings 模块 – 代理连接设置资源模块

注意

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

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

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

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

cisco.ise 2.1.0 中的新增功能

概要

  • 管理对资源“代理连接设置”的操作更新。

  • 以下功能受代理设置的影响。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

bypassHosts

字符串

代理连接的旁路主机。

fqdn

字符串

代理 IP 地址或可解析的 DNS 主机名。

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

password

字符串

代理连接的密码。

passwordRequired

布尔值

指示代理是否需要密码配置。

选项

  • false

  • true

port

整数

代理连接的端口。应在 1 到 65535 之间。

userName

字符串

代理连接的用户名。

备注

注意

  • 使用的 SDK 方法为 proxy.Proxy.update_proxy_connection，

  • 使用的路径为 put /api/v1/system-settings/proxy，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco ISE 代理文档

代理 API 的完整参考。

示例

- name: Update all
  cisco.ise.proxy_connection_settings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    bypassHosts: string
    fqdn: string
    password: string
    passwordRequired: true
    port: 0
    userName: string

返回值

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

键

描述

ise_response

字典

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

返回： 始终

示例： {"bypassHosts": "string", "fqdn": "string", "password": "string", "passwordRequired": true, "port": 0, "userName": "string"}

ise_update_response

字典

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

返回： 始终

示例： {"response": {"bypassHosts": "string", "fqdn": "string", "password": "string", "passwordRequired": true, "port": 0, "userName": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)