theforeman.foreman.templates_import 模块 – 从仓库同步模板

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要 

从外部 git 仓库或文件系统同步配置模板、报表模板、分区表和作业模板。
基于 foreman_templates 插件 https://github.com/theforeman/foreman_templates。

别名：foreman_templates_import

要求 

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

requests

参数 

参数	注释
associate 字符串	根据元数据关联到操作系统、位置和组织。选项 `"always"` `"new"` `"never"`
branch 字符串	repo 的分支。仅适用于基于 git 的仓库。
dirname 字符串	Git 仓库中包含模板的目录。
filter 字符串	在应用 prefix 之后，仅同步名称与此正则表达式匹配的模板。不区分大小写，不筛选代码片段。
force 布尔值	更新已锁定的模板。选项 `false` `true`
locations 列表 / 元素=字符串	实体应分配到的位置列表
lock 布尔值	锁定导入的模板。选项 `false` `true`
negate 布尔值	否定筛选条件。选项 `false` `true`
organizations 列表 / 元素=字符串	实体应分配到的组织列表
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
prefix 字符串	将指定的字符串添加到所有尚未具有该前缀的导入模板的开头。
repo 字符串	文件系统路径或仓库（带有协议），例如 /tmp/dir 或 git://example.com/repo.git 或 https://example.com/repo.git。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)
verbose 布尔值	将模板报告添加到输出。选项 `false` `true`

属性 

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

注释 

注意

由于 foreman_templates 插件中的错误，当唯一更改是导入模板的组织/位置关联时，此模块不会报告 changed=true。有关详细信息，请参阅 https://projects.theforeman.org/issues/29534。
所有模块选项的默认值可以使用 theforeman.foreman.setting 为 TemplateSync 类别设置，或者在 WebUI 中的设置页面上设置。

示例 

- name: Sync templates from git repo
  theforeman.foreman.templates_import:
    repo: https://github.com/theforeman/community-templates.git
    branch: 1.24-stable
    associate: new
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"

返回值 

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

键	描述
message 字典	有关导入的信息。返回: 成功
branch 字符串	仓库中使用的分支。返回: 成功
repo 字符串	从中导入模板的仓库。返回: 成功
report 字典	导入的报告。返回: 成功
changed 列表 / 元素=字符串	已更新的模板列表。返回: 成功
new 列表 / 元素=字符串	已创建的模板列表。返回: 成功
templates 字典	模板的最终状态。返回: 成功

作者

Anton Nesterov (@nesanton)