theforeman.foreman.content_export_library module – Manage library content exports

Note

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

You might already have this collection installed if you are using the ansible package. 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_export_library.

New in theforeman.foreman 3.5.0

Synopsis

  • Export library content to a directory.

Requirements

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

  • requests

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.

chunk_size_gb

integer

Split the exported content into archives no greater than the specified size in gigabytes.

Only applicable for format=importable. syncable exports can’t be split.

destination_server

string

Destination server name; optional parameter to differentiate between exports

fail_on_missing_content

boolean

Fails if any of the repositories belonging to this organization are unexportable.

Choices:

  • false

  • true

format

string

added in theforeman.foreman 3.10.0

Export format.

Choose syncable if the exported content needs to be in a yum format.

Choices:

  • "syncable"

  • "importable"

from_history_id

integer

Export history identifier used for incremental export. If not provided the most recent export history will be used.

incremental

boolean

Export only the content that has changed since the last export.

Choices:

  • false

  • true

organization

string / required

Organization that the entity is in

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.

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.

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

Examples

- name: "Export library content (full)"
  theforeman.foreman.content_export_library:
    username: "admin"
    password: "changeme"
    server_url: "http://foreman.example.com"
    organization: "Default Organization"
    destination_server: "airgapped.example.com"

- name: "Export library content (full) and fail if any repos are unexportable"
  theforeman.foreman.content_export_library:
    username: "admin"
    password: "changeme"
    server_url: "http://foreman.example.com"
    organization: "Default Organization"
    destination_server: "airgapped.example.com"
    fail_on_missing_content: true

- name: "Export library content (full) in chunks of 10 GB"
  theforeman.foreman.content_export_library:
    username: "admin"
    password: "changeme"
    server_url: "http://foreman.example.com"
    chunk_size_gb: 10
    organization: "Default Organization"
    destination_server: "airgapped.example.com"

- name: "Export library content (incremental) since the most recent export"
  theforeman.foreman.content_export_library:
    username: "admin"
    password: "changeme"
    server_url: "http://foreman.example.com"
    organization: "Default Organization"
    destination_server: "airgapped.example.com"
    incremental: true

- name: "Export library content (incremental) since a specific export"
  theforeman.foreman.content_export_library:
    username: "admin"
    password: "changeme"
    server_url: "http://foreman.example.com"
    organization: "Default Organization"
    destination_server: "airgapped.example.com"
    incremental: true
    from_history_id: 12345

Authors

  • Jeremy Lenz (@jeremylenz)