theforeman.foreman.realm 模块 – 管理领域

注意

此模块是 theforeman.foreman 集合 (版本 4.2.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。

要在剧本中使用它,请指定:theforeman.foreman.realm

theforeman.foreman 1.0.0 中的新增功能

概要

  • 管理领域

别名:foreman_realm

要求

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

  • requests

参数

参数

注释

locations

列表 / 元素=字符串

应将实体分配到的位置列表

name

字符串 / 必需

领域的名称

organizations

列表 / 元素=字符串

应将实体分配到的组织列表

password

字符串 / 必需

访问 Foreman 服务器的用户密码。

如果任务中未指定此值,则将使用环境变量 FOREMAN_PASSWORD 的值。

realm_proxy

字符串 / 必需

此领域使用的代理

realm_type

字符串 / 必需

领域类型

选项

  • "Red Hat Identity Management"

  • "FreeIPA"

  • "Active Directory"

server_url

字符串 / 必需

Foreman 服务器的 URL。

如果任务中未指定此值,则将使用环境变量 FOREMAN_SERVER_URL 的值。

state

字符串

实体的状态

选项

  • "present" ← (默认)

  • "absent"

username

字符串 / 必需

访问 Foreman 服务器的用户名。

如果任务中未指定此值,则将使用环境变量 FOREMAN_USERNAME 的值。

validate_certs

布尔值

是否验证 Foreman 服务器的 TLS 证书。

如果任务中未指定此值,则将使用环境变量 FOREMAN_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持:完全支持

可以在检查模式下运行并返回已更改状态预测,而无需修改实体

diff_mode

支持:完全支持

在差异模式下,将返回有关已更改内容(或在检查模式下可能需要更改的内容)的详细信息

示例

- name: "Create EXAMPLE.LOCAL Realm"
  theforeman.foreman.realm:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "EXAMPLE.COM"
    realm_proxy: "foreman.example.com"
    realm_type: "Red Hat Identity Management"
    state: present

返回值

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

描述

entity

字典

按其类型分组的受影响实体的最终状态。

返回:成功

realms

列表 / 元素=字典

领域列表。

返回:成功

作者

  • Lester R Claudio (@claudiol1)