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

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.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

Параметры

Параметр	Комментарии
name aliases: hostname строка / обязательно	Имя (FQDN) хоста
password строка / обязательно	Пароль пользователя, который обращается к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_PASSWORD`.
server_url строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Желаемое состояние питания Варианты: `"on"` `"start"` `"off"` `"stop"` `"soft"` `"reboot"` `"cycle"` `"reset"` `"state"` ← (по умолчанию) `"status"`
username строка / обязательно	Имя пользователя, имеющий доступ к серверу Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_USERNAME`.
validate_certs булево	Требовать проверку сертификатов TLS сервера Foreman. Если значение не указано в задаче, используется значение переменной среды `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Можно запускать в режиме check_mode и возвращать прогноз состояния изменения без модификации сущности
diff_mode	Поддержка: полная	Возвращает подробности о том, что изменилось (или, возможно, нуждается в изменении в режиме check_mode), когда используется diff_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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/host_power_module.html