theforeman.foreman.product – Manage Products

Note

This plugin is part of the theforeman.foreman collection (version 1.5.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

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

New in version 1.0.0: of theforeman.foreman

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

Create and manage products

Requirements

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

requests

Parameters

Parameter	Choices/Defaults	Comments
description string		Possibly long description to show the user in detail view
gpg_key string		Content GPG key name attached to this product
label string		Label to show the user
name string / required		Name of the product
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.
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.
ssl_ca_cert string		Content SSL CA certificate name attached to this product
ssl_client_cert string		Content SSL client certificate name attached to this product
ssl_client_key string		Content SSL client private key name attached to this product
state string	present ← present_with_defaults absent	State of the entity `present_with_defaults` will ensure the entity exists, but won't update existing ones
sync_plan string		Sync plan name attached to this product
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	no yes ←	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.

Examples

- name: "Create Fedora product with a sync plan"
  theforeman.foreman.product:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Fedora"
    organization: "My Cool new Organization"
    sync_plan: "Fedora repos sync"
    state: present

- name: "Create CentOS 7 product with content credentials"
  theforeman.foreman.product:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "CentOS 7"
    gpg_key: "RPM-GPG-KEY-CentOS7"
    organization: "My Cool new Organization"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
entity dictionary		success	Final state of the affected entities grouped by their type.
	products list / elements=dictionary	success	List of products.

Authors

Eric D Helms (@ehelms)
Matthias Dellweg (@mdellweg) ATIX AG

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/product_module.html