модуль theforeman.foreman.activation_key — управление ключами активации

Примечание

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

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

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

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

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

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

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

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

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

Требования

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

requests

Параметры

Параметр	Комментарии
auto_attach boolean	Включает или отключает автоматическое присоединение Параметр `auto_attach` объявлен устаревшим начиная с Katello 4.13 и недоступен начиная с Katello 4.19 Варианты: `false` `true`
ca_path path	Файл в формате PEM, содержащий сертификат CA, который будет использоваться для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
content_overrides list / elements=dictionary	Список переопределений содержимого, включающий метку и состояние переопределения Метка обозначает репозиторий `content_label`. Например, для продуктов Red Hat это `rhel-7-server-rpms`. Для пользовательских продуктов используется формат `<organization_label>_<product_label>_<repository_label>`, например `ExampleOrg_ExampleProduct_ExampleRepository`. Состояние переопределения (‘enabled’, ‘disabled’ или ‘default’) задаёт начальное состояние репозитория для вновь зарегистрированных хостов
label string / обязательный	Метка репозитория `content_label`, состояние которого нужно переопределить при регистрации хостов с помощью ключа активации
override string / обязательный	Значение переопределения, которое будет использоваться для репозитория при регистрации хостов с помощью ключа активации Варианты: `"enabled"` `"disabled"` `"default"`
content_view string	Имя представления содержимого
content_view_environments list / elements=string добавлено в theforeman.foreman 5.8.0	Список сред представлений содержимого, которые нужно добавить в ключ активации. Несовместим с `content_view` и `lifecycle_environment`.
description string	Описание ключа активации
host_collections list / elements=string	Список коллекций хостов, которые нужно добавить в ключ активации
lifecycle_environment string	Имя среды жизненного цикла
max_hosts integer	Максимальное количество зарегистрированных хостов содержимого. Обязателен, если unlimited_hosts=false
name string / обязательный	Имя ключа активации
new_name string	Имя нового ключа активации, если state == copied
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`.
purpose_addons list / elements=string	Задаёт дополнения назначения системы
purpose_role string	Задаёт роль назначения системы
purpose_usage string	Задаёт назначение использования системы
release_version string	Задаёт версию выпуска содержимого
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
service_level string	Задаёт уровень обслуживания Варианты: `"Self-Support"` `"Standard"` `"Premium"`
state string	Состояние ключа активации Если `copied`, ключ будет скопирован в новый; в качестве имени будет использовано new_name, остальные поля останутся без изменений `present_with_defaults` гарантирует существование объекта, но не обновляет уже существующие объекты Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"` `"copied"`
subscriptions list / elements=dictionary	Список подписок, содержащих имя, идентификатор пула или идентификатор вышестоящего пула. Предпочтительно использовать идентификаторы пулов, поскольку уникальность имён и идентификаторов вышестоящих пулов не гарантируется. Модуль завершится с ошибкой, если найдёт более одного совпадения. Этот параметр не поддерживается в режиме SCA.
name string	Имя добавляемой подписки. Несовместим с pool_id и upstream_pool_id.
pool_id string	Идентификатор пула добавляемой подписки. Несовместим с name и upstream_pool_id. Также называется `Candlepin Id` в CSV-экспорте подписок, а также является `UUID` в выводе команды `hammer subscription list`.
upstream_pool_id string	Идентификатор вышестоящего пула добавляемой подписки. Несовместим с name и pool_id. Также называется `Master Pools` на портале Red Hat.
unlimited_hosts boolean	Может ли ключ активации использоваться для неограниченного количества хостов Варианты: `false` `true`
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 client activation key"
  theforeman.foreman.activation_key:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Clients"
    organization: "Default Organization"
    lifecycle_environment: "Library"
    content_view: 'client content view'
    host_collections:
      - rhel7-servers
      - rhel7-production
    content_overrides:
      - label: rhel-7-server-rpms
        override: enabled
      - label: ExampleOrganization_ExampleCustomProduct_ExampleRepository
        override: enabled
    release_version: 7Server
    service_level: Standard

- name: "Create client activation key with multiple content views"
  theforeman.foreman.activation_key:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Clients"
    organization: "Default Organization"
    content_view_environments:
      - prod/base_rhel_9
      - test/third_party
    host_collections:
      - rhel9-servers
      - rhel9-production
      - rhel9-third-party-test
    auto_attach: false
    release_version: 9
    service_level: Standard

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

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

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

Авторы

Andrew Kofink (@akofink)

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

© 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/activation_key_module.html