vmware_host_powerstate - Управляет состояниями питания систем хостов в vCenter
Новая версия 2.6.
Обзор
- Этот модуль можно использовать для управления состояниями питания систем хостов в данной инфраструктуре vCenter.
- Пользователь может установить состояние питания на «выключение до режима ожидания», «включение из режима ожидания», «выключение хоста» и «перезагрузка хоста».
- Состояния «перезагрузка хоста», «выключение хоста» и «выключение до режима ожидания» не поддерживаются всеми системами хостов.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cluster_name | Имя кластера, из которого будут использоваться все системы хостов. Этот параметр обязателен, если esxi_hostname не указан. | |
| esxi_hostname | Имя системы хоста, с которой нужно работать. Этот параметр обязателен, если cluster_name не указан. | |
| force bool |
| Этот параметр указывает, следует ли продолжать работу с заданным состоянием питания хоста независимо от того, находится ли он в режиме технического обслуживания. Если state установлено в reboot-host и force как true, то хост перезагружается независимо от того, находится ли он в режиме технического обслуживания.Если state установлено в shutdown-host и force как true, то хост выключается независимо от того, находится ли он в режиме технического обслуживания.Если state установлено в power-down-to-standby и force на true, то все виртуальные машины, выключенные питания, будут эвакуированы.Не применимо, если state установлено в power-up-from-standby. |
| hostname str | Имя хоста или IP-адрес сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST.Поддержка переменных среды добавлена в версии 2.6. | |
| password str | Пароль сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.Поддержка переменных среды добавлена в версии 2.6. псевдонимы: pass, pwd | |
| port int (добавлено в 2.5) | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в версии 2.6. |
| state |
| Установите состояние системы хоста. |
| timeout | Значение по умолчанию: 600 | Этот параметр определяет тайм-аут для state на power-down-to-standby или power-up-from-standby.Игнорируется, если state установлено в reboot-host или shutdown-host.Этот параметр задается в секундах. |
| username str | Имя пользователя сервера vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в версии 2.6. псевдонимы: admin, user | |
| validate_certs bool |
| Разрешает подключение, когда сертификаты 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: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
esxi_hostname: esxi01
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: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
esxi_hostname: power-down-to-standby
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: 192.0.2.44
username: administrator@vsphere.local
password: vmware
validate_certs: no
cluster_name: DC0_C0
state: reboot-host
delegate_to: localhost
register: reboot_host
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| result dict | всегда | метаданные о состоянии системы хоста Пример: {'esxi01': {'msg': "выключение 'esxi01' до режима ожидания", 'error': ''}} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Смотрите Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом 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.6/modules/vmware_host_powerstate_module.html
