Модуль theforeman.foreman.host_power — управление состоянием питания узлов

Примечание

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

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

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

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

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

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

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

Управление состоянием питания узла
Эта бета-версия может запускать и останавливать существующий узел Foreman, а также запрашивать его текущее состояние питания.

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

Требования

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

requests

Параметры

Параметр	Комментарии
ca_path путь	Файл в формате PEM, содержащий сертификат ЦС для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_CA_PATH`.
name псевдонимы: hostname строка / обязательный	Имя узла (FQDN)
oauth1_consumer_key строка	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret строка	Секретный ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_OAUTH1_CONSUMER_SECRET`.
password строка	Пароль пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Желаемое состояние питания Варианты: `"on"` `"start"` `"off"` `"stop"` `"soft"` `"reboot"` `"cycle"` `"reset"` `"state"` ← (по умолчанию) `"status"`
use_gssapi логический	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos с аутентификацией Negotiate. Для этого необходимо установить библиотеку Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, подключающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логический	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: "Switch a host on"
  theforeman.foreman.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    hostname: "test-host.domain.test"
    state: 'on'

- name: "Switch a host off"
  theforeman.foreman.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    hostname: "test-host.domain.test"
    state: 'off'

- name: "Query host power state"
  theforeman.foreman.host_power:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    hostname: "test-host.domain.test"
    state: state
    register: result
- debug:
    msg: "Host power state is {{ result.power_state }}"

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

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

Ключ	Описание
power_state строка	текущее состояние питания узла Возвращается: всегда Пример: `"off"`

Авторы

Bernhard Hopfenmueller (@Fobhep) ATIX AG
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/host_power_module.html