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 vSphere или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в версии 2.6.
password строка		Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd
port целое число добавлен в 2.5	Значение по умолчанию: 443	Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в версии 2.6.
state -	Варианты: выключение в режим ожидания включение из режима ожидания выключение хоста ← перезагрузка хоста	Установите состояние хост-системы.
timeout -	Значение по умолчанию: 600	Этот параметр определяет тайм-аут для `state` установленного на `power-down-to-standby` или `power-up-from-standby`. Игнорируется, если `state` установлено на `reboot-host` или `shutdown-host`. Этот параметр определен в секундах.
username строка		Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user
validate_certs boolean	Варианты: нет да ←	Позволяет подключиться, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты не доверяются. Если значение не указано в задании, будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в версии 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.7/modules/vmware_host_powerstate_module.html