vmware_host_powerstate – Управление состояниями питания систем хостов в vCenter
Новая версия 2.6.
Обзор
- Этот модуль может использоваться для управления состояниями питания систем хостов в заданной инфраструктуре vCenter.
- Пользователь может установить состояние питания на «выключение в режим ожидания», «включение из режима ожидания», «выключение хоста» и «перезагрузка хоста».
- Состояния «перезагрузка хоста», «выключение хоста» и «выключение в режим ожидания» не поддерживаются всеми системами хостов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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-адрес сервера 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. |
| proxy_host строка добавлено в 2.9 | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задании, вместо него используется значение переменной среды VMWARE_PROXY_PORT. | |
| 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 логическое |
| Позволяет подключиться, когда сертификаты 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)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_host_powerstate_module.html
