theforeman.foreman.katello_sync_plan (0.8.1) — module

Manage Katello sync plans

Authors: Andrew Kofink (@akofink), Matthis Dellweg (@mdellweg) ATIX-AG

preview | supported by community

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1


Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Manage Katello sync plans


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Create or update weekly RHEL sync plan"
  katello_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

Inputs

    
name:
    description:
    - Name of the Katello sync plan
    required: true
    type: str

state:
    choices:
    - present
    - present_with_defaults
    - absent
    default: present
    description:
    - State of the entity in Foreman
    - 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
    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
    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
    required: true
    type: str

description:
    description:
    - Description of the Katello sync plan
    type: str

organization:
    description:
    - Organization that the entity is in
    required: true
    type: str

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    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