theforeman / theforeman.foreman / 4.0.0 / module / sync_plan Manage Sync Plans | "added in version" 1.0.0 of theforeman.foreman" Authors: Andrew Kofink (@akofink), Matthis Dellweg (@mdellweg) ATIX-AGtheforeman.foreman.sync_plan (4.0.0) — module
Install with ansible-galaxy collection install theforeman.foreman:==4.0.0
collections: - name: theforeman.foreman version: 4.0.0
Manage sync plans
- 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
name: description: - Name of the sync plan required: true type: str state: choices: - present - present_with_defaults - absent default: present description: - State of the entity - C(present_with_defaults) will ensure the entity exists, but won't update existing ones type: str enabled: description: - Whether the sync plan is active required: true type: bool interval: choices: - hourly - daily - weekly - custom cron description: - How often synchronization should run required: true type: str password: description: - Password of the user accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD) will be used instead. required: true type: str products: description: - List of products to include in the sync plan elements: str required: false type: list username: description: - Username accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME) will be used instead. required: true type: str sync_date: description: - Start date and time of the first synchronization required: true type: str server_url: description: - URL of the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL) will be used instead. required: true type: str description: description: - Description of the sync plan type: str organization: description: - Organization that the entity is in required: true type: str validate_certs: default: true description: - 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 C(FOREMAN_VALIDATE_CERTS) will be used instead. type: bool cron_expression: description: - A cron expression as found in crontab files - This must be provided together with I(interval='custom cron'). type: str
entity: contains: sync_plans: description: List of sync plans. elements: dict type: list description: Final state of the affected entities grouped by their type. returned: success type: dict