cisco.ise.endpoint_group 模块 – 用于端点组的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新功能

概要 

管理资源端点组的创建、更新和删除操作。
此 API 创建一个端点标识组。
此 API 删除一个端点标识组。
此 API 允许客户端更新端点标识组。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	端点组的描述。
id 字符串	端点组的 ID。
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` ← (默认)
name 字符串	端点组的名称。
parentID 字符串	端点组的父级。
systemDefined 布尔值	SystemDefined 标志。选项 `false` `true`

注释 

注意

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

另请参阅 

另请参阅

有关 EndpointIdentityGroup 的 Cisco ISE 文档: EndpointIdentityGroup API 的完整参考。

示例 

- name: Update by id
  cisco.ise.endpoint_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    systemDefined: true
    parentID: string

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

- name: Create
  cisco.ise.endpoint_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    name: string
    systemDefined: true
    parentID: string

返回值 

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

键	描述
ise_response 字典	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应返回: 总是示例: `{"description": "字符串", "id": "字符串", "link": {"href": "字符串", "rel": "字符串", "type": "字符串"}, "name": "字符串", "parentId": "字符串", "systemDefined": true}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应返回: 总是示例: `{"UpdatedFieldsList": {"field": "字符串", "newValue": "字符串", "oldValue": "字符串", "updatedField": [{"field": "字符串", "newValue": "字符串", "oldValue": "字符串"}]}}`

作者

Rafael Campos (@racampos)