theforeman.foreman.domain_info 模块 – 获取域信息

注意

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

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

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

要在剧本中使用它，请指定：theforeman.foreman.domain_info。

theforeman.foreman 2.1.0 中的新增功能

概要 

获取域信息

要求 

以下是执行此模块的主机所需的条件。

requests

参数 

参数	注释
location 字符串	用于限定搜索范围的位置标签。
name 字符串	要获取信息的资源名称。与 search 互斥。
organization 字符串	用于限定搜索范围的组织名称。
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果任务中未指定值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
search 字符串	要使用的搜索查询如果为 None，并且未设置 name，则返回所有资源。与 name 互斥。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果任务中未指定值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果任务中未指定值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: "Show a domain"
  theforeman.foreman.domain_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "example.com"

- name: "Show all domains with domain example.com"
  theforeman.foreman.domain_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: "name = example.com"

返回值 

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

键	描述
domain 字典	关于找到的域的详细信息返回：成功且传递了 name
domains 列表 / 元素=字典	所有找到的域及其详细信息的列表返回：成功且传递了 search

作者

Eric Helms (@ehelms)