Модуль theforeman.foreman.activation_key — Управление ключами активации
Примечание
Этот модуль входит в коллекцию theforeman.foreman (версия 4.2.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 | Включить или выключить Автоподключение Варианты:
|
content_overrides list / elements=dictionary | Список переопределений контента, включающих метку и состояние переопределения Метка относится к репозиторию Состояние переопределения (‘enabled’, ‘disabled’, или ‘default’) устанавливает начальное состояние репозитория для вновь зарегистрированных хостов |
|
label string / обязательно |
Репозиторий |
|
override string / обязательно |
Значение переопределения для использования для репозитория при регистрации хостов с ключом активации Варианты:
|
content_view string | Имя представления контента |
description string | Описание ключа активации |
host_collections list / elements=string | Список коллекций хостов для добавления к ключу активации |
lifecycle_environment string | Имя среды жизненного цикла |
max_hosts integer | Максимальное количество зарегистрированных хостов контента. Обязательно, если unlimited_hosts=false |
name string / обязательно | Имя ключа активации |
new_name string | Имя нового ключа активации, когда состояние == copied |
organization string / обязательно | Организация, в которой находится сущность |
password string / обязательно | Пароль пользователя, который обращается к серверу Foreman. Если значение не указано в задаче, будет использоваться значение переменной среды |
purpose_addons list / elements=string | Устанавливает системные целевые дополнения |
purpose_role string | Устанавливает системную целевую роль |
purpose_usage string | Устанавливает системное целевое использование |
release_version string | Установить версию выпуска контента |
server_url string / обязательно | URL сервера Foreman. Если значение не указано в задаче, будет использоваться значение переменной среды |
service_level string | Установить уровень сервиса Варианты:
|
state string | Состояние ключа активации Если
Варианты:
|
subscriptions list / elements=dictionary | Список подписок, которые включают имя, идентификатор пула или идентификатор пула предка. Идентификаторы пулов предпочтительнее, поскольку имена и идентификаторы пулов предков не гарантируют уникальность. Модуль завершится ошибкой, если найдет более одной совпадения. Этот параметр не поддерживается в режиме SCA. |
|
name string |
Имя подписки для добавления. Взаимоисключающее с pool_id и upstream_pool_id. |
|
pool_id string |
Идентификатор пула подписки, который необходимо добавить. Взаимоисключающее с параметрами name и upstream_pool_id. Также называется и также является значением |
|
upstream_pool_id string |
Идентификатор пула подписки вышестоящего уровня, который необходимо добавить. Взаимоисключающее с параметрами name и pool_id. Также называется |
unlimited_hosts boolean | Может ли ключ активации иметь неограниченное количество хостов Выбор:
|
username string / обязательно | Имя пользователя, использующееся для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
validate_certs boolean | Требовать проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Выбор:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Возможность работы в режиме check_mode и возврата прогноза изменений состояния без модификации сущности |
diff_mode | Поддержка: полная | Возвращает детали о внесенных изменениях (или, возможно, необходимых изменениях в режиме check_mode) при использовании diff-режима |
Примеры
- 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-optional-rpms
override: enabled
auto_attach: false
release_version: 7Server
service_level: Standard
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
entity словарь | Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращается: успех |
|
activation_keys список / элементы=словарь |
Список ключей активации. Возвращается: успех |
Ссылки на коллекцию
© 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/theforeman/foreman/activation_key_module.html