Модуль theforeman.foreman.registration_command — Управление командой регистрации

Примечание

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

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

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

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

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

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

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

Управление командой регистрации

Требования

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

requests

Параметры

Параметр	Комментарии
activation_keys list / elements=string	Ключи активации для клиента subscription-manager; необходимы для CentOS и Red Hat Enterprise Linux. Обязательны, только если для группы узлов не заданы ключи активации.
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_CA_PATH`.
force boolean	Очистить все предыдущие регистрации и выполнить `subscription-manager` с `--force`. Варианты: `false` `true`
hostgroup string	Группа узлов, в которой нужно зарегистрировать узел.
ignore_subman_errors boolean	Игнорировать ошибки `subscription-manager` для команды `subscription-manager register`. Варианты: `false` `true`
insecure boolean	Включить аргумент insecure для первоначального `curl`. Варианты: `false` `true`
jwt_expiration integer	Срок действия токена авторизации (в часах).
lifecycle_environment string	Среда жизненного цикла для узла. Устарело: среда жизненного цикла узла должна задаваться ключом активации. Удалено из API начиная с Katello 4.12.
location string	Местоположение, в котором нужно зарегистрировать узел.
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
operatingsystem string	Операционная система, для которой нужно зарегистрировать узел. Для операционной системы должен быть назначен шаблон `host_init_config`.
organization string	Организация, в которой нужно зарегистрировать узел.
packages string	Пакеты, которые нужно установить на узел при регистрации. Несколько пакетов указываются в виде строки, разделённой пробелами.
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_PASSWORD`.
remote_execution_interface string	Идентификатор интерфейса узла для удалённого выполнения.
repo string	URL-адрес репозитория (yum/dnf) или полная запись sources.list (apt). Устарело: используйте параметр repo_data. Этот параметр объявлен устаревшим в Foreman 3.11.
repo_data list / elements=dictionary	Массив с URL-адресом репозитория и соответствующим URL-адресом ключа GPG. Каждый элемент — это словарь с ключами `repo` и `repo_gpg_key_url`.
repo string / обязательно	URL-адрес или описание репозитория (например, «deb http://deb.example.com/ buster 1.0» для Debian, «https://yum.example.com/el8/x86_64/ » для Red Hat/SUSE).
repo_gpg_key_url string	URL-адрес ключа GPG для репозитория.
repo_gpg_key_url string	URL-адрес ключа GPG для репозитория. Устарело: используйте параметр repo_data. Этот параметр объявлен устаревшим в Foreman 3.11.
server_url string / обязательно	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `FOREMAN_SERVER_URL`.
setup_container_registry_certs boolean добавлено в theforeman.foreman 5.11.0	Если задано значение `true`, на узле будут установлены сертификаты реестра контейнеров. Варианты: `false` `true`
setup_insights boolean	Если задано значение `true`, на операционных системах семейства Red Hat будет установлен и зарегистрирован `insights-client`. Варианты: `false` `true`
setup_remote_execution boolean	Если задано значение true, на узле будут установлены ключи SSH. Варианты: `false` `true`
setup_remote_execution_pull boolean	Если задано значение true, на узле будет развернут клиент провайдера pull. Варианты: `false` `true`
smart_proxy string	Имя Smart Proxy. Для этого прокси должны быть включены функции `Templates` и `Registration`.
update_packages 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).

Примеры

# This needs to run on a host with API access
- name: "Generate registration command"
  theforeman.foreman.registration_command:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
  register: command
  delegate_to: localhost

# This needs to run on the host being registered
- name: "Perform registration"
  ansible.builtin.shell:
    cmd: "{{ command.registration_command }}"

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

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

Ключ	Описание
registration_command string	Сгенерированная команда регистрации. Возвращается: при успехе

Авторы

Evgeni Golov (@evgeni)

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

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