cisco.ise.active_directory_groups_by_domain_info 模块 – 按域列出 Active Directory 组的信息模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.ise.active_directory_groups_by_domain_info。

cisco.ise 1.0.0 中的新增功能

概要 

获取按域划分的所有 Active Directory 组。
此 API 列出给定域的组。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
additionalData list / elements=dictionary	Active Directory 获取按域划分的组信息的 additionalData。
name string	Active Directory 获取按域划分的组信息的 name。
value string	Active Directory 获取按域划分的组信息的 value。
id string	ID 路径参数。
ise_debug boolean	用于 Identity Services Engine SDK 启用调试的标志。选项 `false` ← (默认) `true`
ise_hostname string / required	Identity Services Engine 主机名。
ise_password string / required	用于身份验证的 Identity Services Engine 密码。
ise_single_request_timeout integer 在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认： `60`
ise_username string / required	用于身份验证的 Identity Services Engine 用户名。
ise_uses_api_gateway boolean 在 cisco.ise 1.1.0 中添加	一个标志，通知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求。如果为 true，则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。如果为 false，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中 port 值取决于所使用的服务（ERS、Mnt、UI、PxGrid）。选项 `false` `true` ← (默认)
ise_uses_csrf_token boolean 在 cisco.ise 3.0.0 中添加	一个标志，通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API。如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。选项 `false` ← (默认) `true`
ise_verify boolean	启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
ise_version string	通知 SDK 要使用的 Identity Services Engine 版本。默认： `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	用于 Identity Services Engine SDK 启用自动速率限制处理的标志。选项 `false` `true` ← (默认)

说明 

注意

使用的 SDK 方法是 active_directory.ActiveDirectory.get_groups_by_domain，
使用的路径是 put /ers/config/activedirectory/{id}/getGroupsByDomain，
支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Get all Active Directory Groups By Domain
  cisco.ise.active_directory_groups_by_domain_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
    additionalData:
    - name: domain
      value: Required. The domain whose groups we want to fetch
    - name: filter
      value: Optional. Exact match filter on group's CN
    - name: sidFilter
      value: Optional. Exact match filter on group's SID, optionally specifying the domain
        as prefix. e.g. S-1-5-33-544 and R1.dom/S-1-5-33-544 are legal
    - name: typeFilter
      value: Optional. Can be exactly one of:BUILTIN, DOMAIN LOCAL, GLOBAL, UNIVERSAL
  register: result

返回值 

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

键	描述
ise_response dictionary	包含 Cisco ISE Python SDK 返回的响应的字典或列表返回：始终示例： `{"groups": [{"name": "string", "sid": "string", "type": "string"}]}`

作者

Rafael Campos (@racampos)