theforeman.foreman.repository_sync module – Sync a Repository or Product

Note

This module is part of the theforeman.foreman collection (version 3.14.0).

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.repository_sync.

New in theforeman.foreman 1.0.0

Synopsis

  • Sync a repository or product

Aliases: katello_sync

Requirements

The below requirements are needed on the host that executes this module.

  • requests

Parameters

Parameter

Comments

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

product

string / required

Product to which the repository lives in

repository

string
Name of the repository to sync

If omitted, all repositories in product are synched.

server_url

string / required

URL of the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.

username

string / required

Username accessing the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.

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

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "Sync repository"
  theforeman.foreman.repository_sync:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    repository: "My repository"
    product: "My Product"
    organization: "Default Organization"

Authors

  • Eric D Helms (@ehelms)

  • Matthias M Dellweg (@mdellweg) ATIX AG