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

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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	Удалить дублирующие значения (только для массивов) Варианты: `false` `true`
default_value any	Значение по умолчанию.
description string	Описание параметра Smart Class.
hidden_value boolean	При включении параметр скрывается в пользовательском интерфейсе. Варианты: `false` `true`
merge_default boolean	Включать значение по умолчанию при объединении всех совпадающих значений. Варианты: `false` `true`
merge_overrides boolean	Объединить все совпадающие значения (только для типов массив/словарь). Варианты: `false` `true`
omit boolean	Не отправлять этот параметр в выходные данные классификации. Puppet будет использовать значение, определённое в манифесте Puppet для этого параметра. Варианты: `false` `true`
override boolean	Управляется ли значение параметра Smart Class 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 ложно
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 / обязательно	Имя puppetclass, к которому принадлежит параметр
required boolean	Если истинно, выведет ошибку, если нет значения по умолчанию и ни один из матчеров не предоставил значения. Варианты: `false` `true`
server_url string / обязательно	URL сервера Foreman. Если значение не указано в задании, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.

END_OF_DOCUMENT_MARKER

состояние строка	Состояние сущности. Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"`
имя_пользователя строка / обязательно	Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs булево	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
validator_rule строка	Используется для принудительного применения определенных значений для значений параметров.
validator_type строка	Типы значений проверки. Варианты: `"regexp"` `"list"`

Атрибуты

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

Примеры

- 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

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

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

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

Авторы

Baptiste Agasse (@bagasse)

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

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