cisco.ise.node_group 模块 – 节点组资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

管理资源节点组的创建、更新和删除操作。
此 API 在集群中创建一个节点组。节点组是一组 PSN。
删除集群中现有的节点组。删除节点组不会删除节点，但节点之间不再执行故障转移。
更新现有的节点组。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	节点组的描述。
forceDelete 布尔值	ForceDelete 查询参数。即使节点组包含一个或多个节点，也强制删除该组。选项 `false` `true`
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` ← (默认)
marCache 字典	节点组的 marCache。
query-attempts 整数	Cisco ISE 尝试执行缓存条目查询的次数。(0 - 5)。
query-timeout 整数	缓存条目查询超时的时间（以秒为单位）。(1 - 10)。
replication-attempts 整数	Cisco ISE 尝试执行 MAR 缓存条目复制的次数。(0 - 5)。
replication-timeout 整数	缓存条目复制超时的时间（以秒为单位）。(1 - 10)。
name 字符串	节点组的名称。
nodeGroupName 字符串	NodeGroupName 路径参数。现有节点组的名称。

注释 

注意

使用的 SDK 方法为 node_group.NodeGroup.create_node_group、node_group.NodeGroup.delete_node_group、node_group.NodeGroup.update_node_group。
使用的路径为 post /api/v1/deployment/node-group、delete /api/v1/deployment/node-group/{nodeGroupName}、put /api/v1/deployment/node-group/{nodeGroupName}。
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参见 

另请参见

Cisco ISE 节点组文档: 节点组 API 的完整参考。

示例 

- name: Create
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string

- name: Update by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    marCache:
      query-attempts: 0
      query-timeout: 0
      replication-attempts: 0
      replication-timeout: 0
    name: string
    nodeGroupName: string

- name: Delete by name
  cisco.ise.node_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    forceDelete: true
    nodeGroupName: string

返回值 

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回：始终示例： `{"description": "string", "marCache": {"query-attempts": 0, "query-timeout": 0, "replication-attempts": 0, "replication-timeout": 0}, "name": "string"}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回：始终示例： `{"success": {"message": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)