cisco.ise.sxp_local_bindings 模块 – SXP 本地绑定的资源模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.ise.sxp_local_bindings

cisco.ise 1.0.0 中的新增功能

概要

  • 管理资源 SXP 本地绑定的创建、更新和删除操作。

  • 此 API 创建 SXP 本地绑定。

  • 此 API 删除 SXP 本地绑定。

  • 此 API 允许客户端更新 SXP 本地绑定。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

bindingName

字符串

此字段从 Cisco ISE 3.0 开始已弃用。

description

字符串

SXP 本地绑定的描述。

id

字符串

SXP 本地绑定的 ID。

ipAddressOrHost

字符串

静态映射的 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 ← (默认)

sgt

字符串

SGT 名称或 ID。

sxpVpn

字符串

SXP 域列表,用逗号分隔。应该定义至少一个 sxpVpn 或 vns。

vns

字符串

虚拟网络列表,用逗号分隔。应该定义至少一个 sxpVpn 或 vns。

注释

注意

  • 使用的 SDK 方法是 sxp_local_bindings.SxpLocalBindings.create_sxp_local_bindings、sxp_local_bindings.SxpLocalBindings.delete_sxp_local_bindings_by_id、sxp_local_bindings.SxpLocalBindings.update_sxp_local_bindings_by_id。

  • 使用的路径是 post /ers/config/sxplocalbindings、delete /ers/config/sxplocalbindings/{id}、put /ers/config/sxplocalbindings/{id}。

  • 不支持 check_mode

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

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

示例

- name: Update by id
  cisco.ise.sxp_local_bindings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    bindingName: string
    description: string
    id: string
    ipAddressOrHost: string
    sgt: string
    sxpVpn: string
    vns: string

- name: Delete by id
  cisco.ise.sxp_local_bindings:
    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_local_bindings:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    bindingName: string
    description: string
    id: string
    ipAddressOrHost: string
    sgt: string
    sxpVpn: string
    vns: string

返回值

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

描述

ise_response

字典

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

返回值: 始终

示例: {"bindingName": "string", "description": "string", "id": "string", "ipAddressOrHost": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "sgt": "string", "sxpVpn": "string", "vns": "string"}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回值: 始终

示例: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

作者

  • Rafael Campos (@racampos)