community.general.keycloak_component_info 模块 – 在 Keycloak 中检索组件信息

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.keycloak_component_info。

community.general 8.2.0 中的新增功能

概要

  • 此模块从 Keycloak 中检索组件信息。

参数

参数

注释

auth_client_id

字符串

OpenID Connect client_id 用于向 API 进行身份验证。

默认值： "admin-cli"

auth_client_secret

字符串

与 auth_client_id（如果需要）一起使用的客户端密钥。

auth_keycloak_url

别名：url

字符串 / 必需

Keycloak 实例的 URL。

auth_password

别名：password

字符串

用于 API 访问身份验证的密码。

auth_realm

字符串

用于 API 访问身份验证的 Keycloak realm 名称。

auth_username

别名：username

字符串

用于 API 访问身份验证的用户名。

connection_timeout

整数

community.general 4.5.0 中新增

控制对 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。

默认值： 10

http_agent

字符串

community.general 5.4.0 中新增

配置 HTTP User-Agent 标头。

默认值： "Ansible"

name

字符串

组件名称。

parent_id

字符串

组件的容器 ID。

provider_type

字符串

组件的提供程序类型。

示例：org.keycloak.storage.UserStorageProvider，org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy，org.keycloak.keys.KeyProvider，org.keycloak.userprofile.UserProfileProvider，org.keycloak.storage.ldap.mappers.LDAPStorageMapper。

realm

字符串 / 必需

realm 的名称。

token

字符串

community.general 3.0.0 中新增

Keycloak API 的身份验证令牌。

validate_certs

布尔值

验证 TLS 证书（不要在生产环境中禁用此选项）。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

此操作不会修改状态。

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

diff_mode

支持： N/A

此操作不会修改状态。

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- name: Retrive info of a UserStorageProvider named myldap
  community.general.keycloak_component_info:
    auth_keycloak_url: https://127.0.0.1:8080/auth
    auth_sername: admin
    auth_password: password
    auth_realm: master
    realm: myrealm
    name: myldap
    provider_type: org.keycloak.storage.UserStorageProvider

- name: Retrive key info component
  community.general.keycloak_component_info:
    auth_keycloak_url: https://127.0.0.1:8080/auth
    auth_sername: admin
    auth_password: password
    auth_realm: master
    realm: myrealm
    name: rsa-enc-generated
    provider_type: org.keycloak.keys.KeyProvider

- name: Retrive all component from realm master
  community.general.keycloak_component_info:
    auth_keycloak_url: https://127.0.0.1:8080/auth
    auth_sername: admin
    auth_password: password
    auth_realm: master
    realm: myrealm

- name: Retrive all sub components of parent component filter by type
  community.general.keycloak_component_info:
    auth_keycloak_url: https://127.0.0.1:8080/auth
    auth_sername: admin
    auth_password: password
    auth_realm: master
    realm: myrealm
    parent_id: "075ef2fa-19fc-4a6d-bf4c-249f57365fd2"
    provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"

返回值

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

键

描述

components

列表 / 元素=字典

组件的 JSON 表示形式。

返回：始终

作者

  • Andre Desrosiers (@desand01)