модуль theforeman.foreman.product — Управление продуктами

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.product.

Добавлено в theforeman.foreman 1.0.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Создание продуктов и управление ими

Псевдонимы: katello_product

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат CA для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
description string	Возможно, подробное описание для отображения пользователю в режиме подробного просмотра
gpg_key string	Имя ключа GPG содержимого, связанного с этим продуктом
label string	Метка для отображения пользователю
name string / обязательный	Имя продукта
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organization string / обязательный	Организация, к которой относится объект
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
server_url string / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
ssl_ca_cert string	Имя сертификата SSL CA содержимого, связанного с этим продуктом
ssl_client_cert string	Имя клиентского сертификата SSL содержимого, связанного с этим продуктом
ssl_client_key string	Имя закрытого ключа клиента SSL содержимого, связанного с этим продуктом
state string	Состояние объекта `present_with_defaults` гарантирует, что объект существует, но не обновляет уже существующие объекты Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
sync_plan string	Имя плана синхронизации, связанного с этим продуктом
use_gssapi boolean	Использовать GSSAPI для аутентификации. Обычно это применяется для Kerberos или Kerberos через аутентификацию Negotiate. Для этого необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Модуль может работать в режиме check_mode и возвращать прогноз изменения состояния без изменения объекта
diff_mode	Поддержка: full	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, потребуется изменить в режиме check_mode)

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
entity dictionary	Итоговое состояние затронутых объектов, сгруппированных по типу. Возвращается: при успешном выполнении
products list / elements=dictionary	Список продуктов. Возвращается: при успешном выполнении

Авторы

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

Ссылки на коллекцию

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