.. Document meta :orphan: .. Anchors .. _ansible_collections.theforeman.foreman.sync_plan_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.sync_plan -- Manage Sync Plans +++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `theforeman.foreman collection `_ (version 2.1.2). To install it use: :code:`ansible-galaxy collection install theforeman.foreman`. To use it in a playbook, specify: :code:`theforeman.foreman.sync_plan`. .. version_added .. versionadded:: 1.0.0 of theforeman.foreman .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage sync plans .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
cron_expression
string
A cron expression as found in crontab files
This must be provided together with interval='custom cron'.
description
string
Description of the sync plan
enabled
boolean / required
    Choices:
  • no
  • yes
Whether the sync plan is active
interval
string / required
    Choices:
  • hourly
  • daily
  • weekly
  • custom cron
How often synchronization should run
name
string / required
Name of the sync plan
organization
string / required
Organization that the entity is in
password
string / required
Password of the user accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
products
list / elements=string
List of products to include in the sync plan
server_url
string / required
URL of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity
present_with_defaults will ensure the entity exists, but won't update existing ones
sync_date
string / required
Start date and time of the first synchronization
username
string / required
Username accessing the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to verify the TLS certificates of the Foreman server.
If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead.

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.

 
sync_plans
list / elements=dictionary
success
List of sync plans.



.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Andrew Kofink (@akofink) - Matthis Dellweg (@mdellweg) ATIX-AG .. Parsing errors