community.vmware.vmware_host_auto_start модуль — Управление автоматическим включением или выключением виртуальных машин на хосте ESXi
Примечание
Этот модуль входит в коллекцию community.vmware (версия 4.7.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.vmware.
Чтобы использовать его в плейбуке, укажите: community.vmware.vmware_host_auto_start.
Обзор
- В этом модуле можно настроить автоматический запуск и выключение виртуальных машин в соответствии с запуском или выключением хоста.
Параметры
Параметр | Комментарии |
|---|---|
esxi_hostname строка / обязательно | Имя хоста ESXi, на котором находится виртуальная машина для установки автоматического включения или выключения. |
hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной окружения |
moid строка | |
name строка | Имя виртуальной машины для установки автоматического включения или выключения. Это не нужно, если изменяются только системные параметры VM по умолчанию для конфигурации autoStart. |
password псевдонимы: pass, pwd строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной окружения |
port целое число | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задании, будет использовано значение переменной окружения По умолчанию: |
power_info словарь | Настройки запуска или выключения виртуальной машины. Эта настройка переопределит системные значения по умолчанию. По умолчанию: |
|
start_action строка |
Следует ли запускать виртуальную машину при запуске хоста. Варианты:
|
|
start_delay целое число |
Задержка автоматического запуска виртуальной машины в секундах. По умолчанию: |
|
start_order целое число |
Приоритет автозапуска виртуальной машины. Виртуальные машины с меньшим числом запускаются первыми. При выключении хоста виртуальные машины выключаются в обратном порядке, то есть те, у которых большее число, выключаются первыми. По умолчанию: |
|
stop_action строка |
Действие остановки, выполняемое над виртуальной машиной при остановке системы виртуальной машины. Варианты:
|
|
stop_delay целое число |
Задержка автоматической остановки виртуальной машины в секундах. По умолчанию: |
|
wait_for_heartbeat строка |
Продолжить обработку включения при запуске VMware Tools. Варианты:
|
proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задании, будет использовано значение переменной окружения |
proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задании, будет использовано значение переменной окружения |
system_defaults словарь | Системные значения по умолчанию для автоматической конфигурации запуска или остановки виртуальной машины. |
|
enabled логическое |
Включить автоматический запуск или остановку виртуальных машин. Варианты:
|
|
start_delay целое число |
Задержка автоматического запуска по умолчанию в секундах. По умолчанию: |
|
stop_action string |
Действие по остановке, выполняемое по умолчанию для виртуальной машины при остановке системы. Выбор:
|
|
stop_delay integer |
Задержка автоматической остановки в секундах по умолчанию. По умолчанию: |
|
wait_for_heartbeat boolean |
Продолжить обработку включения, когда VMware Tools запущен. Если этот параметр включен, следующая виртуальная машина включится без ожидания задержки. Однако, виртуальная машина должна иметь установленные VMware Tools. Выбор:
|
use_instance_uuid boolean | Использовать UUID экземпляра VMware вместо UUID BIOS. Выбор:
|
username aliases: admin, user string | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения |
uuid string | UUID виртуальной машины для настройки автоматического включения или выключения. Это уникальный идентификатор VMware. Требуется, если Не требуется, если изменяются только системные параметры конфигурации автозапуска виртуальных машин. |
validate_certs boolean | Разрешает подключение, когда сертификаты SSL недействительны. Установите значение Если значение не указано в задаче, будет использовано значение переменной окружения Выбор:
|
Примечания
Примечание
- Все модули требуют доступа для записи в API и поэтому не поддерживаются на бесплатной лицензии ESXi.
- Все имена переменных и объектов VMware чувствительны к регистру.
Примеры
---
- 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 Пример: |
system_defaults_config словарь | Возвращаемый параметр при изменении конфигурации системных параметров по умолчанию. Возвращаемое значение: changed Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_auto_start_module.html
