community.vmware.vmware_host_auto_start – Управление автоматическим включением или выключением виртуальных машин на хосте ESXi

Примечание

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

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

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

Описание
Требования
Параметры
Примеры
Значения возврата

Описание

В этом модуле можно настроить автоматический запуск и выключение виртуальных машин в соответствии с запуском или выключением хоста.

Требования

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

python >= 2.7
PyVmomi

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
esxi_hostname строка / обязательный			Имя хоста ESXi, на котором находится виртуальная машина для настройки автоматического включения или выключения.
hostname строка			Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
moid строка			Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в рамках одного экземпляра vCenter. Требуется, если `name` или `uuid` не указаны.
name строка			Имя виртуальной машины для настройки автоматического включения или выключения. Не требуется, если изменяются только системные параметры виртуальных машин для настройки автозапуска.
password строка			Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число		По умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
power_info словарь		По умолчанию: {"start_action": "none", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault"}	Настройки запуска или выключения виртуальной машины. Эта настройка переопределяет системные значения по умолчанию.
	start_action строка	Варианты: none ← powerOn	Выполняется ли запуск виртуальной машины при запуске хоста.
	start_delay целое число	По умолчанию: -1	Задержка автоматического запуска виртуальной машины в секундах.
	start_order целое число	По умолчанию: -1	Приоритет автозапуска виртуальной машины. Виртуальные машины с меньшим номером запускаются первыми. При выключении хоста виртуальные машины выключаются в обратном порядке, то есть те, у которых больший номер, отключаются первыми.
	stop_action строка	Варианты: none systemDefault ← powerOff suspend	Действие остановки, выполняемое на виртуальной машине при остановке системы.
	stop_delay целое число	По умолчанию: -1	Задержка автоматического выключения виртуальной машины в секундах.
	wait_for_heartbeat строка	Варианты: no yes systemDefault ←	Продолжать процесс включения, когда VMware Tools запущен.
proxy_host строка			Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port целое число			Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PROXY_PORT`.
system_defaults словарь			Системные значения по умолчанию для настройки автозапуска или автовыключения виртуальной машины.
	enabled булево	Варианты: no ← yes	Включить автоматический запуск или остановку виртуальных машин.
	start_delay целое число	По умолчанию: 120	Задержка автоматического запуска по умолчанию в секундах.
	stop_action строка	Варианты: none guestShutdown powerOff ← suspend	Действие остановки по умолчанию, выполняемое на виртуальной машине при остановке системы.
	stop_delay целое число	По умолчанию: 120	Задержка автоматического выключения по умолчанию в секундах.
	wait_for_heartbeat булево	Варианты: no ← yes	Продолжать процесс включения, когда VMware Tools запущен. Если этот параметр включён, следующий виртуальная машина включается без ожидания задержки. Однако виртуальная машина должна иметь установленные VMware Tools.
use_instance_uuid булево		Варианты: no ← yes	Использовать UUID экземпляра VMware вместо UUID BIOS.
username строка			Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
uuid строка			UUID виртуальной машины для настройки автоматического включения или выключения. Это уникальный идентификатор VMware. Требуется, если `name` не указан. Не требуется, если изменяются только системные параметры виртуальных машин для настройки автозапуска.
validate_certs булево		Варианты: no yes ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите в `false`, если сертификаты не доверяются. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено `true`, убедитесь, что Python >= 2.7.9 установлен на указанном компьютере.

Примеры

---
- name: Update for system defaults config.
  community.vmware.vmware_host_auto_start:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    system_defaults:
      enabled: true
      start_delay: 100
      stop_action: guestShutdown

- name: Update for powerInfo config of virtual machine.
  community.vmware.vmware_host_auto_start:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    name: "{{ vm_name }}"
    power_info:
      start_action: powerOn
      start_delay: 10
      start_order: 1
      stop_action: powerOff
      wait_for_heartbeat: true

Значения возврата

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

Ключ	Возвращаемое значение	Описание
power_info_config словарь	changed	Возвращаемый параметр, когда конфигурация информации о питании виртуальной машины изменена. Пример: { "start_action": "powerOn", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault" }
system_defaults_config словарь	changed	Возвращаемый параметр, когда конфигурация системных значений по умолчанию изменена. Пример: { "enabled": true, "start_delay": 120, "stop_action": "powerOff", "stop_delay": 120, "wait_for_heartbeat": false }

Авторы

sky-joker (@sky-joker)

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