theforeman.foreman.sync_plan – Manage Sync Plans
theforeman.foreman.sync_plan – Manage Sync Plans
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.sync_plan
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Manage sync plans
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
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 |
|
Whether the sync plan is active |
interval string / required |
|
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 | |
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 | |
state string |
|
State of the entity
|
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 | |
validate_certs boolean |
|
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 |
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
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.
|
Authors
- Andrew Kofink (@akofink)
- Matthis Dellweg (@mdellweg) ATIX-AG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/sync_plan_module.html