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

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_host_auto_start.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настроить автоматический запуск и завершение работы виртуальных машин в соответствии с запуском или завершением работы хоста.

Параметры

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

Примечания

Примечание

Для всех модулей необходим доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Можно указать хранилище сертификатов, задав переменную среды REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может в некоторых случаях привести к тому, что значение ‘false’ для параметра ‘validate_certs’ будет проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

---
- 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	Возвращаемый параметр, если конфигурация сведений о питании виртуальной машины была изменена. Возвращается: changed Пример: `{"start_action": "powerOn", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault"}`
system_defaults_config dictionary	Возвращаемый параметр, если конфигурация системных значений по умолчанию была изменена. Возвращается: 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_host_auto_start_module.html