Модуль theforeman.foreman.operatingsystem — управление операционными системами

Примечание

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

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

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

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

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

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

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

Управление операционными системами

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

Требования

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

requests

Параметры

Параметр	Комментарии
architectures list / elements=string	Архитектуры, на которых можно установить операционную систему
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
description string	Описание операционной системы
major string	Основная версия операционной системы
media list / elements=string	Список установочных носителей
minor string	Дополнительная версия операционной системы
name string / обязательный	Название операционной системы
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
os_family псевдонимы: family string	Семейство дистрибутивов операционной системы Варианты: `"AIX"` `"Altlinux"` `"Archlinux"` `"Coreos"` `"Debian"` `"Fcos"` `"Freebsd"` `"Gentoo"` `"Junos"` `"NXOS"` `"Rancheros"` `"Redhat"` `"Rhcos"` `"Solaris"` `"Suse"` `"VRP"` `"Windows"` `"Xenserver"`
parameters list / elements=dictionary	Параметры узла, относящиеся к операционной системе
hidden_value boolean	Следует ли скрывать значение Варианты: `false` `true`
name string / обязательный	Название параметра
parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательный	Значение параметра
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
password_hash string	Алгоритм хеширования для passwd Варианты: `"MD5"` `"SHA256"` `"SHA512"` `"Base64"` `"Base64-Windows"`
provisioning_templates list / elements=string	Список шаблонов подготовки, связанных с операционной системой. Укажите полный список названий шаблонов, которые требуется связать с операционной системой. Например: [“Kickstart default”, “Kickstart default finish”, “Kickstart default iPXE”, “custom”]. После указания связей с шаблонами можно задать шаблон по умолчанию в модуле theforeman.foreman.os_default_template.
ptables list / elements=string	Список таблиц разделов
release_name string	Название выпуска операционной системы (рекомендуется для Debian)
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности `present_with_defaults` гарантирует существование сущности, но не обновляет существующие сущности Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
updated_name string	Новое название операционной системы. Если задан этот параметр, модуль не будет идемпотентным.
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	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз изменений, не изменяя сущность
diff_mode	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примеры

- name: "Create an Operating System"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian
    release_name: stretch
    family: Debian
    major: 9
    parameters:
      - name: additional-packages
        value: python vim
    state: present

- name: "Ensure existence of an Operating System (provide default values)"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Centos
    family: Redhat
    major: 7
    password_hash: SHA256
    state: present_with_defaults

- name: "Delete an Operating System"
  theforeman.foreman.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian
    family: Debian
    major: 9
    state: absent

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

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

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

Авторы

Matthias M Dellweg (@mdellweg) ATIX AG
Bernhard Hopfenmüller (@Fobhep) ATIX AG

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

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