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

Примечание

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

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

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

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

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

Описание

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

Требования

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

pyghmi

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать предсказание состояния изменения без изменения целевого объекта.
diff_mode	Поддержка: нет	Возвращает подробную информацию о том, что изменилось (или, возможно, нужно изменить в `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` предоставлено Пример: `[{"powerstate": "on", "targetAddress": 48}, {"powerstate": "on", "targetAddress": 50}]`
powerstate строка	Текущее состояние питания машины, указанное `status[].targetAddress`. Возвращается: при успехе
targetAddress целое число	Удаленный целевой адрес. Возвращается: при успехе

Авторы

Булат Гаифуллин (@bgaifullin)

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

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