Модуль vmware.vmware_rest.vcenter_vm_hardware_boot — обновляет параметры загрузки виртуальной машины.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля также нужны дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: vmware.vmware_rest.vcenter_vm_hardware_boot.

Добавлено в vmware.vmware_rest 0.1.0

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

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

Обновляет параметры загрузки виртуальной машины.

Требования

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

vSphere 7.0.3 или новее
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
delay целое число	Задержка в миллисекундах перед началом загрузки прошивки при включении виртуальной машины. Эта задержка позволяет предоставить пользователям время для подключения к консоли виртуальной машины и входа в режим настройки BIOS. Если значение не задано, оно не изменяется.
efi_legacy_boot логическое значение	Флаг, указывающий, следует ли использовать устаревший режим загрузки EFI. Если значение не задано, оно не изменяется. Варианты: `false` `true`
enter_setup_mode логическое значение	Флаг, указывающий, должен ли процесс загрузки прошивки автоматически перейти в режим настройки при следующей загрузке виртуальной машины. Обратите внимание: значение этого флага автоматически сбрасывается на false после перехода виртуальной машины в режим настройки. Если значение не задано, оно не изменяется. Варианты: `false` `true`
network_protocol строка	Перечисление network_protocol определяет допустимые сетевые протоколы загрузки, поддерживаемые при загрузке виртуальной машины по сети с прошивкой EFI. Варианты: `"IPV4"` `"IPV6"`
retry логическое значение	Флаг, указывающий, должна ли виртуальная машина автоматически повторять процесс загрузки после сбоя. Если значение не задано, оно не изменяется. Варианты: `false` `true`
retry_delay целое число	Задержка в миллисекундах перед повторной попыткой загрузки после сбоя; применяется только при значении true для параметра retry. Если значение не задано, оно не изменяется.
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state строка	Варианты: `"present"` ← (по умолчанию)
type строка	Перечисление type определяет допустимые типы прошивки для виртуальной машины. Варианты: `"BIOS"` `"EFI"`
vcenter_hostname строка / обязательный	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password строка / обязательный	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file строка	Этот необязательный параметр позволяет указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет храниться на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username строка / обязательный	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs логическое значение	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm строка / обязательный	Идентификатор виртуальной машины. Параметр должен содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

Проверено на vSphere 7.0.3

Примеры

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Change a VM boot parameters
  vmware.vmware_rest.vcenter_vm_hardware_boot:
    vm: '{{ test_vm1_info.id }}'
    efi_legacy_boot: true
    type: EFI
  register: _result

Возвращаемые значения

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

Ключ	Описание
id словарь	moid ресурса Возвращается: При успешном выполнении
value словарь	Изменение параметров загрузки виртуальной машины Возвращается: При успешном выполнении Пример: `{}`

Авторы

Команда Ansible Cloud (@ansible-collections)

Ссылки на коллекцию

© 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/vmware/vmware_rest/vcenter_vm_hardware_boot_module.html