redhat.satellite.sync_plan – Manage Sync Plans

Note

This plugin is part of the redhat.satellite collection (version 2.1.0).

To install it use: ansible-galaxy collection install redhat.satellite.

To use it in a playbook, specify: redhat.satellite.sync_plan.

New in version 1.0.0: of redhat.satellite

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	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 SATELLITE_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 SATELLITE_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 SATELLITE_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 SATELLITE_VALIDATE_CERTS will be used instead.

Examples

- name: "Create or update weekly RHEL sync plan"
  redhat.satellite.sync_plan:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.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