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

Примечание

Этот плагин входит в состав коллекции community.vmware (версия 1.7.0).

Для его установки используйте: ansible-galaxy collection install community.vmware.

Для использования в книге задач укажите: community.vmware.vmware_host_powerstate.

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

Обзор

Этот модуль можно использовать для управления состояниями питания систем хостов в заданной инфраструктуре vCenter.
Пользователь может установить состояние питания на ‘power-down-to-standby’, ‘power-up-from-standby’, ‘shutdown-host’ и ‘reboot-host’.
Состояния ‘reboot-host’, ‘shutdown-host’ и ‘power-down-to-standby’ не поддерживаются всеми системами хостов.

Требования

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

python >= 2.6
PyVmomi

Параметры

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

Примеры

- name: Set the state of a host system to reboot
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    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
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    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
  community.vmware.vmware_host_powerstate:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    state: reboot-host
  delegate_to: localhost
  register: reboot_host

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

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

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

Авторы

Abhijeet Kasurde (@Akasurde)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_host_powerstate_module.html