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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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	Тип регистрируемого устройства, по умолчанию — system
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 string	Укажите имя пула подписок для использования. Поддерживаются регулярные выражения. Взаимоисключающий параметр с `pool_ids`. Пожалуйста, используйте `pool_ids` вместо этого: указание идентификаторов пулов намного быстрее, и это позволяет избежать сопоставления новых пулов, которые становятся доступными для системы и не являются явно необходимыми. Кроме того, этот параметр не поддерживает количества. Этот параметр устарел по вышеуказанным причинам и будет удален в community.general 10.0.0. По умолчанию: `"^$"`
pool_ids list / elements=any	Укажите идентификаторы пулов подписок для использования. Предпочтительнее, чем `pool`, так как работает значительно быстрее. Идентификатор пула может быть указан как `string` — только идентификатор пула (например, `0123456789abcdef0123456789abcdef`), или как `dict` с идентификатором пула в качестве ключа и количеством в качестве значения (например, `0123456789abcdef0123456789abcdef: 2`. Если указано количество, оно используется для потребления нескольких прав на использование из пула (пул должен это поддерживать). Взаимоисключающий параметр с `pool`. По умолчанию: `[]`
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 added in 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 / elements=string	Атрибут 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 added in 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`).

Примечания

Примечание

Модуль пытается использовать службу D-Bus rhsm (часть subscription-manager) для регистрации, начиная с версии community.general 6.5.0: это делается для того, чтобы учетные данные (имя пользователя, пароль, ключи активации) могли передаваться службе 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, или 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 with activationkey and consume subscriptions matching Red Hat Enterprise Server or Red Hat Virtualization
  community.general.redhat_subscription:
    state: present
    activationkey: 1-222333444
    org_id: 222333444
    pool: '^(Red Hat Enterprise Server|Red Hat Virtualization)$'

- name: Update the consumed subscriptions from the previous example (remove Red Hat Virtualization subscription)
  community.general.redhat_subscription:
    state: present
    activationkey: 1-222333444
    org_id: 222333444
    pool: '^Red Hat Enterprise Server$'

- 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 словарь	Список идентификаторов пулов, к которым система сейчас подключена Возвращается: успех Пример: `{"8a85f9815ab905d3015ab928c7005de4": "1"}`

Авторы

Барнаби Коут (@barnabycourt)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/redhat_subscription_module.html