Модуль theforeman.foreman.sync_plan — управление планами синхронизации

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.sync_plan.

Добавлено в theforeman.foreman 1.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Управление планами синхронизации

Псевдонимы: katello_sync_plan

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path путь	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_CA_PATH`.
cron_expression строка	Выражение cron в формате файлов crontab Этот параметр необходимо указать вместе с interval=’custom cron’.
description строка	Описание плана синхронизации
enabled логическое значение / обязательно	Активен ли план синхронизации Варианты: `false` `true`
interval строка / обязательно	Частота выполнения синхронизации Варианты: `"hourly"` `"daily"` `"weekly"` `"custom cron"`
name строка / обязательно	Имя плана синхронизации
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization строка / обязательно	Организация, к которой относится объект
password строка	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
products список / элементы=строка	Список продуктов, включаемых в план синхронизации
server_url строка / обязательно	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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`).
use_gssapi логическое значение	Использовать GSSAPI для аутентификации; обычно это применяется для Kerberos или Kerberos с аутентификацией Negotiate. Для этого необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логическое значение	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 список / элементы=словарь	Список планов синхронизации. Возвращается: при успешном выполнении

Авторы

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

Ссылки на коллекцию

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