theforeman.foreman.content_upload module – Upload content to a repository

Note

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

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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.content_upload.

New in theforeman.foreman 1.0.0

Synopsis

  • Allows the upload of content to a repository

Aliases: katello_upload

Requirements

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

  • python-debian (For deb Package upload)

  • requests

  • rpm (For rpm upload)

Parameters

Parameter

Comments

ca_path

path

PEM formatted file that contains a CA certificate to be used for validation.

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

organization

string / required

Organization that the entity is in

ostree_repository_name

string

Name of repository within the OSTree archive.

Required for OSTree uploads.

password

string

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 / required

Repository to upload file in to

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.

src

aliases: file

path / required

File (on the remote/target machine) to upload

use_gssapi

boolean

Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.

Requires the Python library requests-gssapi to be installed.

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

Choices:

  • false ← (default)

  • true

username

string

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

Notes

Note

  • Currently only uploading to deb, RPM, OSTree & file repositories is supported

  • For anything but file repositories, a supporting library must be installed. See Requirements.

  • OSTree content upload is not idempotent - running mutliple times will attempt to upload the content unit.

Examples

- name: "Upload my.rpm"
  theforeman.foreman.content_upload:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    src: "my.rpm"
    repository: "Build RPMs"
    product: "My Product"
    organization: "Default Organization"

- name: "Upload ostree-archive.tar"
  theforeman.foreman.content_upload:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    src: "ostree_archive.tar"
    repository: "My OStree Repository"
    product: "My Product"
    organization: "Default Organization"
    ostree_repository_name: "small"

Authors

  • Eric D Helms (@ehelms)