Модуль community.general.redhat_subscription — управление регистрацией и подписками RHSM с помощью subscription-manager

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

Для установки используйте: ansible-galaxy collection install community.general. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.redhat_subscription.

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

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

Управление регистрацией и подпиской на платформу Red Hat Subscription Management с помощью команды subscription-manager; при возможности регистрация выполняется через D-Bus.

Требования

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

subscription-manager
При необходимости — библиотека Python dbus; обычно она включена в ОС, поскольку используется subscription-manager.

Параметры

Параметр	Комментарии
activationkey string	Укажите ключ активации для регистрации.
auto_attach boolean	После успешной регистрации автоматически использовать доступные подписки. Обратите внимание: псевдоним `autosubscribe` удалён в community.general 9.0.0. Варианты: `false` `true`
consumer_id string	Указывает идентификатор существующего потребителя, чтобы возобновить использование предыдущей регистрации этой системы. Если сертификат идентификации системы утерян или повреждён, этот параметр позволяет возобновить использование прежней идентификации и подписок. По умолчанию идентификатор потребителя не указывается, и создаётся новый идентификатор.
consumer_name string	Имя регистрируемой системы; по умолчанию используется имя узла.
consumer_type string	Тип регистрируемого объекта; по умолчанию — система.
environment string	Зарегистрировать систему в определённой среде целевой организации. Используется с Red Hat Satellite или Katello.
force_register boolean	Зарегистрировать систему, даже если она уже зарегистрирована. Варианты: `false` ← (по умолчанию) `true`
org_id string	Идентификатор организации, используемый вместе с activationkey.
password string	Пароль для Access.redhat.com, Red Hat Satellite или Katello.
pool_ids list / элементы=любые	Укажите идентификаторы пулов подписок, которые нужно использовать. Идентификатор пула можно указать как `string` — только идентификатор пула (например, `0123456789abcdef0123456789abcdef`) — или как `dict`, где ключом является идентификатор пула, а значением — количество (например, `0123456789abcdef0123456789abcdef: 2`. Если указано количество, оно используется для потребления нескольких прав из пула (пул должен это поддерживать). По умолчанию: `[]`
release string	Задать версию выпуска.
rhsm_baseurl string	Указать базовый URL CDN.
rhsm_repo_ca_cert string	Указать альтернативное расположение сертификата CA для CDN.
server_hostname string	Указать альтернативный сервер Red Hat Subscription Management, Red Hat Satellite или Katello.
server_insecure string	Включить или отключить проверку сертификата HTTPS-сервера при подключении к `server_hostname`.
server_port string добавлено в community.general 3.3.0	Указать порт для регистрации на сервере Red Hat Subscription Management, Red Hat Satellite или Katello.
server_prefix string добавлено в community.general 3.3.0	Указать префикс для регистрации на сервере Red Hat Subscription Management, Red Hat Satellite или Katello.
server_proxy_hostname string	Указать имя узла HTTP-прокси.
server_proxy_password string	Указать пароль для HTTP-прокси с базовой аутентификацией.
server_proxy_port string	Указать порт HTTP-прокси.
server_proxy_scheme string добавлено в community.general 6.2.0	Указать схему HTTP-прокси, например `http` или `https`.
server_proxy_user string	Указать имя пользователя для HTTP-прокси с базовой аутентификацией.
state string	Определяет, следует ли зарегистрировать систему и оформить подписку (`present`) или отменить регистрацию (`absent`). Варианты: `"present"` ← (по умолчанию) `"absent"`
syspurpose dictionary	Задать атрибуты syspurpose в файле `/etc/rhsm/syspurpose/syspurpose.json` и синхронизировать их с сервером RHSM. Атрибуты syspurpose помогают автоматически подключать к системе наиболее подходящие подписки. Если файл `syspurpose.json` уже содержит атрибуты, новые атрибуты заменят существующие. Если атрибут не указан в новом списке атрибутов, существующий атрибут удаляется из файла `syspurpose.json`. Неизвестные атрибуты игнорируются.
addons list / элементы=строки	Атрибут syspurpose addons.
role string	Атрибут syspurpose role.
service_level_agreement string	Атрибут syspurpose service_level_agreement.
sync boolean	Если для этого параметра задано значение `true`, атрибуты syspurpose немедленно синхронизируются с сервером RHSM. Если задано значение `false`, атрибуты syspurpose синхронизируются с сервером RHSM службой rhsmcertd. Варианты: `false` ← (по умолчанию) `true`
usage string	Атрибут syspurpose usage.
token string добавлено в community.general 6.3.0	Токен доступа к API Sso.redhat.com.
username string	Имя пользователя для Access.redhat.com, Red Hat Satellite или Katello.

Атрибуты

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

Примечания

Примечание

Начиная с community.general 6.5.0, модуль пытается использовать для регистрации службу D-Bus rhsm (часть subscription-manager): это позволяет безопасно передавать учётные данные (имя пользователя, пароль, ключи активации) в rhsm. Сама команда subscription-manager получает учётные данные только в качестве аргументов командной строки, что небезопасно, поскольку их легко похитить, просмотрев список процессов в системе. Из-за ограничений интерфейса D-Bus в rhsm модуль не использует D-Bus для регистрации, если предпринимается попытка зарегистрироваться с помощью token, указан параметр environment или используется старая система (обычно RHEL 7 старше 7.4, RHEL 6 и более ранние версии).
Для регистрации системы subscription-manager требует либо имя пользователя и пароль, либо ключ активации и идентификатор организации.
Начиная с версии 2.5, значения server_hostname, server_insecure, rhsm_baseurl, server_proxy_hostname, server_proxy_port, server_proxy_user и server_proxy_password больше не берутся из файла конфигурации /etc/rhsm/rhsm.conf; по умолчанию используется значение null.
Взаимодействовать с subscription-manager может только пользователь root, поэтому для успешного выполнения этого модуля необходимы права root.
Начиная с community.general 6.5.0, учётные данные (то есть username и password, activationkey или token) требуются только в том случае, если система не зарегистрирована или указан параметр force_register. Это позволяет использовать модуль для настройки уже зарегистрированной системы, например для подключения пулов (с помощью pool_ids) и изменения атрибутов syspurpose (с помощью syspurpose).

Примеры

- name: Register as user (joe_user) with password (somepass) and auto-subscribe to available content.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    auto_attach: true

- name: Same as above but subscribe to a specific pool by ID.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    pool_ids: 0123456789abcdef0123456789abcdef

- name: Register and subscribe to multiple pools.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    pool_ids:
      - 0123456789abcdef0123456789abcdef
      - 1123456789abcdef0123456789abcdef

- name: Same as above but consume multiple entitlements.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    pool_ids:
      - 0123456789abcdef0123456789abcdef: 2
      - 1123456789abcdef0123456789abcdef: 4

- name: Register and pull existing system data.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    consumer_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

- name: Register as user credentials into given environment (against Red Hat Satellite or Katello), and auto-subscribe.
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    environment: Library
    auto_attach: true

- name: Register as user (joe_user) with password (somepass) and a specific release
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    release: 7.4

- name: Register as user (joe_user) with password (somepass), set syspurpose attributes and synchronize them with server
  community.general.redhat_subscription:
    state: present
    username: joe_user
    password: somepass
    auto_attach: true
    syspurpose:
      usage: "Production"
      role: "Red Hat Enterprise Server"
      service_level_agreement: "Premium"
      addons:
        - addon1
        - addon2
      sync: true

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

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

Ключ	Описание
subscribed_pool_ids dictionary	Список идентификаторов пулов, на которые теперь подписана система. Возвращается: при успешном выполнении Пример: `{"8a85f9815ab905d3015ab928c7005de4": "1"}`

Авторы

Barnaby Court (@barnabycourt)

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

© 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/community/general/redhat_subscription_module.html