theforeman.foreman.subscription_manifest module – Manage Subscription Manifests

Note

This module is part of the theforeman.foreman collection (version 4.2.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.subscription_manifest.

New in theforeman.foreman 1.0.0

Synopsis

  • Upload, refresh and delete Subscription Manifests

Aliases: katello_manifest

Requirements

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

  • requests

Parameters

Parameter

Comments

manifest_path

path

Path to the manifest zip file

This parameter will be ignored if state=absent or state=refreshed

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.

repository_url

aliases: redhat_repository_url

string

URL to retrieve content from

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.

state

string

The state of the manifest

Choices:

  • "absent"

  • "present" ← (default)

  • "refreshed"

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: none

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

diff_mode

Support: partial

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

Examples

- name: "Upload the RHEL developer edition manifest"
  theforeman.foreman.subscription_manifest:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    state: present
    manifest_path: "/tmp/manifest.zip"

Authors

  • Andrew Kofink (@akofink)