vmware_host_powerstate – Управляет состояниями питания систем хостов в vCenter

Новая версия 2.6.

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

Обзор

Этот модуль можно использовать для управления состояниями питания систем хостов в заданной инфраструктуре vCenter.
Пользователь может установить состояние питания на «выключение в режим ожидания», «включение из режима ожидания», «выключение хоста» и «перезагрузка хоста».
Состояния «перезагрузка хоста», «выключение хоста» и «выключение в режим ожидания» не поддерживаются всеми системами хостов.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cluster_name -		Имя кластера, из которого будут использоваться все системы хостов. Этот параметр обязателен, если `esxi_hostname` не указан.
esxi_hostname -		Имя системы хоста для работы. Этот параметр обязателен, если `cluster_name` не указан.
force boolean	Варианты: нет ← да	Этот параметр указывает, должен ли хост продолжать выполнять пользовательское состояние питания независимо от того, находится ли он в режиме технического обслуживания. Если `state` установлено на `reboot-host`, а `force` как `true`, то хост перезагружается независимо от того, находится ли он в режиме технического обслуживания. Если `state` установлено на `shutdown-host`, а `force` как `true`, то хост выключается независимо от того, находится ли он в режиме технического обслуживания. Если `state` установлено на `power-down-to-standby`, а `force` на `true`, то все выключенные виртуальные машины будут эвакуированы. Не применимо, если `state` установлено на `power-up-from-standby`.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
password строка		Пароль сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: pass, pwd
port целое число добавлено в 2.5	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
state -	Варианты: выключение в режим ожидания включение из режима ожидания выключение хоста ← перезагрузка хоста	Установите состояние системы хоста.
timeout -	Значение по умолчанию: 600	Этот параметр определяет таймаут для `state` установлен на `power-down-to-standby` или `power-up-from-standby`. Игнорируется, если `state` установлен на `reboot-host` или `shutdown-host`. Этот параметр задан в секундах.
username строка		Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: admin, user
validate_certs boolean	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено `yes`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примеры

- name: Set the state of a host system to reboot
  vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    esxi_hostname: '{{ esxi_hostname }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

- name: Set the state of a host system to power down to standby
  vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    esxi_hostname: '{{ esxi_hostname }}'
    state: power-down-to-standby
  delegate_to: localhost
  register: power_down

- name: Set the state of all host systems from cluster to reboot
  vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    cluster_name: '{{ cluster_name }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

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

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

Ключ	Возвращаемое значение	Описание
result словарь	всегда	метаданные о состоянии системы хоста Пример: {'esxi01': {'msg': "выключение 'esxi01' в режим ожидания", 'error': ''}}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vmware_host_powerstate_module.html