Модуль 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 string	Выражение cron, как в файлах crontab Должно быть указано вместе с interval=’custom cron’.
description string	Описание плана синхронизации
enabled boolean / required	Включен ли план синхронизации Варианты: `false` `true`
interval string / required	Как часто должна выполняться синхронизация Варианты: `"hourly"` `"daily"` `"weekly"` `"custom cron"`
name string / required	Имя плана синхронизации
organization string / required	Организация, к которой принадлежит сущность
password string / required	Пароль пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
products list / elements=string	Список продуктов, которые следует включить в план синхронизации
server_url string / required	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state string	Состояние сущности `present_with_defaults` гарантирует существование сущности, но не будет обновлять существующие. Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
sync_date string / required	Дата и время начала первой синхронизации. Поддерживается несколько форматов, но только `YYYY-mm-dd HH:MM:SS +z` (например, `2024-08-01 00:00:00 +0000`) будет идемпотентным.
username string / required	Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз состояния changed без изменения сущности
diff_mode	Поддержка: полная	В режиме diff_mode возвращает информацию о том, что изменилось (или что может потребовать изменения в режиме 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 список / элементы=словарь	Список планов синхронизации. Возвращено: успех

Авторы

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

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/sync_plan_module.html