модуль theforeman.foreman.smart_class_parameter — управление параметрами интеллектуальных классов

Примечание

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

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

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

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

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

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

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

Обновляет параметры интеллектуальных классов.
Параметры интеллектуальных классов создаются и удаляются для классов Puppet во время импорта; в других случаях их нельзя создавать или удалять.

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

Требования

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

requests

Параметры

Параметр	Комментарии
avoid_duplicates boolean	Удалять повторяющиеся значения (только для типа array) Варианты: `false` `true`
ca_path path	Файл в формате PEM, содержащий сертификат центра сертификации для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
default_value any	Значение, используемое по умолчанию.
description string	Описание параметра интеллектуального класса
hidden_value boolean	Если параметр включен, он скрыт в пользовательском интерфейсе. Варианты: `false` `true`
merge_default boolean	Включать значение по умолчанию при объединении всех совпадающих значений. Варианты: `false` `true`
merge_overrides boolean	Объединять все совпадающие значения (только для типов array/hash). Варианты: `false` `true`
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
omit boolean	Не отправлять этот параметр в выводе классификации. Puppet будет использовать значение, определенное для этого параметра в манифесте Puppet. Варианты: `false` `true`
override boolean	Определяет, управляется ли значение параметра интеллектуального класса в Foreman Варианты: `false` `true`
override_value_order list / elements=string	Порядок разрешения значений.
override_values list / elements=dictionary	Переопределения значений
match string / обязательный	Условие соответствия для переопределения
omit boolean	Не отправлять этот параметр в выводе классификации; заменяет use_puppet_default. Варианты: `false` `true`
value any	Переопределяемое значение; обязательно, если omit равно false
parameter псевдонимы: smart_class_parameter string / обязательный	Имя параметра
parameter_type string	Типы значений переменной. Если `none`, задайте для типа параметра пустое значение. Варианты: `"string"` `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"` `"none"`
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
puppetclass_name псевдонимы: puppetclass string / обязательный	Имя класса Puppet, которому принадлежит параметр
required boolean	Если значение равно true, будет вызвана ошибка, когда значение по умолчанию отсутствует и ни одно правило сопоставления не предоставляет значение. Варианты: `false` `true`
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности. Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"`
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` ← (по умолчанию)
validator_rule string	Используется для ограничения допустимых значений параметра.
validator_type string	Типы проверяемых значений. Варианты: `"regexp"` `"list"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Можно выполнить в режиме check_mode и получить прогноз изменения состояния без изменения сущности
diff_mode	Поддержка: полная	В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в режиме check_mode)

Примеры

- name: "Update prometheus::server alertmanagers_config param default value"
  theforeman.foreman.smart_class_parameter:
    puppetclass_name: "prometheus::server"
    parameter: alertmanagers_config
    override: true
    required: true
    default_value: /etc/prometheus/alert.yml
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: "Update prometheus::server alertmanagers_config param default value"
  theforeman.foreman.smart_class_parameter:
    puppetclass_name: "prometheus::server"
    parameter: alertmanagers_config
    override: true
    override_value_order:
      - fqdn
      - hostgroup
      - domain
    required: true
    default_value: /etc/prometheus/alert.yml
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    override_values:
      - match: domain=example.com
        value: foo
      - match: domain=foo.example.com
        omit: true
    state: present

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

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

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

Авторы

Baptiste Agasse (@bagasse)

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

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