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

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.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 строка			Идентификатор управляемого объекта (Managed Object ID) экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Это необходимо, если не указаны `name` или `uuid`.
name строка			Имя виртуальной машины для настройки автоматического включения или выключения. Это не обязательно, если нужно изменить только системные значения по умолчанию для конфигурации автозапуска.
password строка			Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число		Значение по умолчанию: 443	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `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 string	Выбори: none guestShutdown powerOff ← suspend	Действие останова по умолчанию, выполняемое на виртуальной машине при остановке системы.
	stop_delay integer	По умолчанию: 120	Задержка автоматического останова по умолчанию в секундах.
	wait_for_heartbeat boolean	Выбори: нет ← да	Продолжить обработку включения при запуске VMware Tools. Если этот параметр включен, следующая виртуальная машина включится без ожидания задержки. Однако, на виртуальной машине должна быть установлена VMware Tools.
use_instance_uuid boolean		Выбори: нет ← да	Использовать UUID экземпляра VMware вместо UUID BIOS.
username string			Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
uuid string			VM uuid для автоматического включения или выключения, это уникальный идентификатор VMware. Требуется, если `name` не предоставлен. Не требуется, если изменяются только системные параметры VM по умолчанию для конфигурации autoStart.
validate_certs boolean		Выбори: нет да ←	Разрешает подключение, когда сертификаты 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 dictionary	изменено	Параметр возвращается при изменении конфигурации информации о состоянии питания виртуальной машины. Пример: { "start_action": "powerOn", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault" }
system_defaults_config dictionary	изменено	Параметр возвращается при изменении конфигурации системных значений по умолчанию. Пример: { "enabled": true, "start_delay": 120, "stop_action": "powerOff", "stop_delay": 120, "wait_for_heartbeat": false }

Авторы

sky-joker (@sky-joker)

© 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_auto_start_module.html