cisco.ise.node_deployment 模块 – 用于节点部署的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块,请参阅 要求 获取详细信息。

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

cisco.ise 1.0.0 中的新增功能

概要

  • 管理资源节点部署的创建、更新和删除操作。

  • 此 API 注册 Cisco ISE 节点以形成多节点部署。

  • 取消注册的节点将成为独立的 Cisco ISE 节点。

  • 此 API 使用 Cisco ISE 节点的配置更新。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

allowCertImport

布尔值

同意导入注册节点的自签名证书。

选择

  • false

  • true

fqdn

字符串

节点部署的 fqdn。

hostname

字符串

主机名路径参数。已部署节点的主机名。

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

字符串

节点部署的密码。

roles

列表 / elements=字符串

角色可以为空,也可以为一个节点具有多个值。

services

列表 / elements=字符串

服务可以为空,也可以为一个节点具有多个值。

userName

字符串

节点部署的用户名。

注释

注意

  • 使用的 SDK 方法是 node_deployment.NodeDeployment.delete_node、node_deployment.NodeDeployment.register_node、node_deployment.NodeDeployment.update_node

  • 使用的路径为 post /api/v1/deployment/node、delete /api/v1/deployment/node/{hostname}、put /api/v1/deployment/node/{hostname}

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关节点部署的 Cisco ISE 文档

节点部署 API 的完整参考。

示例

- name: Create
  cisco.ise.node_deployment:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowCertImport: true
    fqdn: string
    password: string
    roles:
    - string
    services:
    - string
    userName: string

- name: Update by name
  cisco.ise.node_deployment:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    hostname: string
    roles:
    - string
    services:
    - string

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

返回值

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

描述

ise_response

字典

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

返回: 始终

示例: {"fqdn": "字符串", "hostname": "字符串", "ipAddress": "字符串", "nodeStatus": "字符串", "roles": ["字符串"], "services": ["字符串"]}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

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

返回: 始终

示例: {"success": {"message": "字符串"}, "version": "字符串"}

作者

  • Rafael Campos (@racampos)