theforeman.foreman.domain 模块 – 管理域

注意

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

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

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

要在 playbook 中使用它，请指定： theforeman.foreman.domain。

theforeman.foreman 1.0.0 中的新功能

概要 

创建、更新和删除域

别名：foreman_domain

要求 

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

请求

参数 

参数	注释
description 别名：fullname 字符串	描述域的全名
dns_proxy 别名：dns 字符串	在此域中用于管理 A 记录的 DNS 代理
位置列表 / 元素=字符串	实体应分配到的位置列表
名称字符串 / 必需	完整的 DNS 域名
组织列表 / 元素=字符串	实体应分配到的组织列表
参数列表 / 元素=字典	特定于域的主机参数
名称字符串 / 必需	参数名称
parameter_type 字符串	参数类型选择 `"string"` ← (默认) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
值任意 / 必需	参数的值
密码字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
服务器_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
状态字符串	实体的状态选择 `"present"` ← (默认) `"absent"`
updated_name 字符串	新的域名。设置此参数后，模块将不是幂等的。
用户名字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
验证_证书布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选择 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完整	可以在 check_mode 下运行，并返回更改的状态预测，而无需修改实体
diff_mode	支持：完整	当处于 diff 模式时，将返回有关已更改的内容的详细信息（或可能需要在 check_mode 下更改的内容）

示例 

- name: domain
  theforeman.foreman.domain:
    name: "example.org"
    description: "Example Domain"
    locations:
      - "Munich"
    organizations:
      - "ACME"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

返回值 

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

键	描述
实体字典	受影响实体的最终状态，按其类型分组。已返回：成功
域列表 / 元素=字典	域列表。已返回：成功

作者

Markus Bucher (@m-bucher) ATIX AG