cisco.ise.sxp_connections 模块 – SXP 连接资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅要求以了解详情。

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

cisco.ise 1.0.0 中的新增功能

概要 

管理 SXP 连接资源的创建、更新和删除操作。
此 API 创建 SXP 连接。
此 API 删除 SXP 连接。
此 API 允许客户端更新 SXP 连接。

注意

此模块具有相应的 action 插件。

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	SXP 连接的描述。
enabled 布尔值	启用标志。选项 `false` `true`
id 字符串	SXP 连接的 ID。
ipAddress 字符串	SXP 连接的 IP 地址。
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` ← (默认)
sxpMode 字符串	SXP 连接的 sxpMode。
sxpNode 字符串	SXP 连接的 sxpNode。
sxpPeer 字符串	SXP 连接的 sxpPeer。
sxpVersion 字符串	SXP 连接的 sxpVersion。
sxpVpn 字符串	SXP 连接的 sxpVpn。

备注 

注意

使用的 SDK 方法为 sxp_connections.SxpConnections.create_sxp_connections、sxp_connections.SxpConnections.delete_sxp_connections_by_id、sxp_connections.SxpConnections.update_sxp_connections_by_id。
使用的路径为 post /ers/config/sxpconnections、delete /ers/config/sxpconnections/{id}、put /ers/config/sxpconnections/{id}。
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

示例 

- name: Update by id
  cisco.ise.sxp_connections:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    enabled: true
    id: string
    ipAddress: string
    sxpMode: string
    sxpNode: string
    sxpPeer: string
    sxpVersion: string
    sxpVpn: string

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

- name: Create
  cisco.ise.sxp_connections:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    enabled: true
    ipAddress: string
    sxpMode: string
    sxpNode: string
    sxpPeer: string
    sxpVersion: string
    sxpVpn: string

返回值 

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

键	描述
ise_response 字典	Cisco ISE Python SDK返回的响应字典或列表。返回值：始终返回示例： `{"description": "字符串", "enabled": true, "id": "字符串", "ipAddress": "字符串", "link": {"href": "字符串", "rel": "字符串", "type": "字符串"}, "sxpMode": "字符串", "sxpNode": "字符串", "sxpPeer": "字符串", "sxpVersion": "字符串", "sxpVpn": "字符串"}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	Cisco ISE Python SDK返回的响应字典或列表。返回值：始终返回示例： `{"UpdatedFieldsList": {"field": "字符串", "newValue": "字符串", "oldValue": "字符串", "updatedField": [{"field": "字符串", "newValue": "字符串", "oldValue": "字符串"}]}}`

作者

Rafael Campos (@racampos)