redhat.satellite.product – Manage Products

Note

This plugin is part of the redhat.satellite collection (version 3.1.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 redhat.satellite.

To use it in a playbook, specify: redhat.satellite.product.

New in version 1.0.0: of redhat.satellite

Synopsis

• Create and manage products

Requirements

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

• requests

Parameters

Parameter	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 SATELLITE_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 SATELLITE_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	State of the entity present_with_defaults will ensure the entity exists, but won’t update existing ones Choices: present ← (default) present_with_defaults absent
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 SATELLITE_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 SATELLITE_VALIDATE_CERTS will be used instead. Choices: no yes ← (default)

Examples

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

- name: "Create CentOS 7 product with content credentials"
  redhat.satellite.product:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.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	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
products list / elements=dictionary	List of products. Returned: success

Authors

• Eric D Helms (@ehelms)

• Matthias Dellweg (@mdellweg) ATIX AG