Модуль community.general.ipmi_power — управление питанием машины

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.ipmi_power.

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

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

Используйте этот модуль для управления питанием.

Требования

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

pyghmi

Параметры

Параметр	Комментарии
key строка добавлено в community.general 4.1.0	Ключ шифрования для подключения к BMC в шестнадцатеричном формате.
machine список / элементы=словарь добавлено в community.general 4.3.0	Укажите список удалённых целевых адресов для запроса IPMI через мост и состояний питания. Необходимо указать этот параметр или `state`.
state строка	Следует ли обеспечить желаемое состояние машины, указанной в `machine[].targetAddress`. Если этот параметр не задан, состояние питания устанавливается с помощью `state`. Если заданы этот параметр и `state`, этот параметр имеет приоритет над `state`. Варианты: `"on"` `"off"` `"shutdown"` `"reset"` `"boot"`
targetAddress целое число / обязательный	Удалённый целевой адрес для запроса IPMI через мост.
name строка / обязательный	Имя хоста или IP-адрес BMC.
password строка / обязательный	Пароль для подключения к BMC.
port целое число	Удалённый порт RMCP. По умолчанию: `623`
state строка	Следует ли обеспечить желаемое состояние машины. Возможные значения параметра state: `on` — запросить включение системы. `off` — запросить выключение системы без ожидания завершения работы ОС. `shutdown` — запросить корректное завершение работы ОС. `reset` — запросить перезагрузку системы без ожидания завершения работы ОС. `boot` — если система выключена, выполнить `on`, иначе — `reset`. Необходимо указать этот параметр или `machine`. Варианты: `"on"` `"off"` `"shutdown"` `"reset"` `"boot"`
timeout целое число	Максимальное время в секундах до прерывания запроса. По умолчанию: `300`
user строка / обязательный	Имя пользователя для подключения к BMC.

Атрибуты

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

Примеры

- name: Ensure machine is powered on
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: 'on'

- name: Ensure machines of which remote target address is 48 and 50 are powered off
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    state: 'off'
    machine:
      - targetAddress: 48
      - targetAddress: 50

- name: Ensure machine of which remote target address is 48 is powered on, and 50 is powered off
  community.general.ipmi_power:
    name: test.testdomain.com
    user: admin
    password: password
    machine:
      - targetAddress: 48
        state: 'on'
      - targetAddress: 50
        state: 'off'

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

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

Ключ	Описание
powerstate строка	Текущее состояние питания машины. Возвращается: при успехе, если `machine` не задан Пример: `"on"`
status список / элементы=словарь добавлено в community.general 4.3.0	Текущее состояние питания машины, если задан параметр machine. Возвращается: при успехе, если задан `machine` Пример: `[{"powerstate": "on", "targetAddress": 48}, {"powerstate": "on", "targetAddress": 50}]`
powerstate строка	Текущее состояние питания машины, указанной в `status[].targetAddress`. Возвращается: при успехе
targetAddress целое число	Удалённый целевой адрес. Возвращается: при успехе

Авторы

Bulat Gaifullin (@bgaifullin)

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

© 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/community/general/ipmi_power_module.html