theforeman.foreman.sync_plans¶
This role defines Sync Plans.
Role Variables¶
This role supports the Common Role Variables.
foreman_sync_plans
: List of sync plans to create. Each sync plan is represented as a dictionary which specifies thename
of the sync plan and theproducts
assigned to the sync plan. It also specifies theinterval
which can be ‘hourly’, ‘daily’, ‘weekly’, or ‘custom cron’. In case the ‘custom cron’interval
is used, it should also specify thecron_expression
. Finally the sync plan should have async_date
which specifies the first time that the sync plan will run.
foreman_sync_plans:
- name: Weekly Sync
interval: weekly
sync_date: 2020-11-07 00:00:00 UTC
products:
- Red Hat Enterprise Linux Server
- Red Hat Software Collectiions (for RHEL Server)
- Red Hat Enterprise Linux for x86_64
- CentOS 8
- Debian 10
- name: Monthly Foreman Client Sync
interval: custom cron
cron_expression: 0 6 8 * *
sync_date: 2020-11-08 00:06:00 UTC
products:
- Foreman Client
Example Playbooks¶
Create two sync plans:
- hosts: localhost
roles:
- role: theforeman.foreman.sync_plans
vars:
foreman_server_url: https://foreman.example.com
foreman_username: "admin"
foreman_password: "changeme"
foreman_organization: "Default Organization"
foreman_sync_plans:
- name: Weekly Sync
interval: weekly
sync_date: 2020-11-07 00:00:00 UTC
products:
- Red Hat Enterprise Linux Server
- Red Hat Enterprise Linux for x86_64
- name: Daily Sync
interval: daily
sync_date: 2020-11-08 00:00:00 UTC
products:
- Red Hat Software Collections (for RHEL Server)
Create a single sync plan which has all defined products (those defined in the foreman_products
dictionary in ansible vars, for example as defined in the role documentation for theforeman.foreman.repositories) assigned to it:
- hosts: localhost
roles:
- role: theforeman.foreman.sync_plans
vars:
foreman_server_url: https://foreman.example.com
foreman_username: "admin"
foreman_password: "changeme"
foreman_organization: "Default Organization"
foreman_sync_plans:
- name: Weekly Sync
interval: weekly
sync_date: 2020-11-07 00:00:00 UTC
products: "{{ foreman_products | map(attribute='name') | list }}"
The above example assumes that a yaml dictionary foreman_products
is already defined in Ansible variables. It uses yaml methods to select the name of each product from that dictionary, convert them all to a list, and pass that list to the definition of the sync plan.