theforeman.foreman.sync_plan 模块 – 管理同步计划

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要 

管理同步计划

别名：katello_sync_plan

要求 

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

requests

参数 

参数	注释
cron_expression 字符串	在 crontab 文件中找到的 cron 表达式这必须与 interval='custom cron' 一起提供。
description 字符串	同步计划的描述
enabled 布尔值 / 必需	同步计划是否处于活动状态选项 `false` `true`
interval 字符串 / 必需	同步应运行的频率选项 `"hourly"` `"daily"` `"weekly"` `"custom cron"`
name 字符串 / 必需	同步计划的名称
organization 字符串 / 必需	实体所在的组织
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将改用环境变量 `FOREMAN_PASSWORD` 的值。
products 列表 / elements=string	要包含在同步计划中的产品列表
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将改用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态 `present_with_defaults` 将确保实体存在，但不会更新现有实体选项 `"present"` ← (默认) `"present_with_defaults"` `"absent"`
sync_date 字符串 / 必需	第一次同步的开始日期和时间。接受多种格式，但只有 `YYYY-mm-dd HH:MM:SS +z`（例如 `2024-08-01 00:00:00 +0000`）将是幂等的。
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将改用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将改用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: "Create or update weekly RHEL sync plan"
  theforeman.foreman.sync_plan:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Weekly RHEL Sync"
    organization: "Default Organization"
    interval: "weekly"
    enabled: false
    sync_date: "2017-01-01 00:00:00 UTC"
    products:
      - 'Red Hat Enterprise Linux Server'
    state: present

返回值 

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

键	描述
entity 字典	受影响实体的最终状态，按其类型分组。返回：成功
sync_plans 列表 / elements=dictionary	同步计划列表。返回：成功

作者

Andrew Kofink (@akofink)
Matthis Dellweg (@mdellweg) ATIX-AG