vmware.vmware_rest.vcenter_vm_hardware_boot модуль — Обновляет параметры загрузки виртуальной машины.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 3.2.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 legacy. Если не задано, значение не изменяется. Варианты:
|
enter_setup_mode логическое значение | Флаг, указывающий, следует ли автоматически войти в режим настройки во время следующей загрузки виртуальной машины. Обратите внимание, что этот флаг будет автоматически сброшен до false, как только виртуальная машина войдёт в режим настройки. Если не задано, значение не изменяется. Варианты:
|
network_protocol строка | Перечисление network_protocol определяет допустимые сетевые протоколы загрузки, поддерживаемые при загрузке виртуальной машины с микропрограммой EFI по сети. Варианты:
|
retry логическое значение | Флаг, указывающий, следует ли автоматически повторно пытаться загрузить виртуальную машину после неудачи. Если не задано, значение не изменяется. Варианты:
|
retry_delay целое число | Задержка в миллисекундах перед повторной попыткой загрузки после неудачи; применяется только в случае, если retry равно true. Если не задано, значение не изменяется. |
session_timeout вещественное число добавлен в vmware.vmware_rest 2.1.0 | Параметры таймаута для сессии клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
state строка | Варианты:
|
type строка | Перечисление type определяет допустимые типы микропрограмм для виртуальной машины. Варианты:
|
vcenter_hostname строка / обязательно | Имя хоста или IP-адрес vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды |
vcenter_password строка / обязательно | Пароль vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды |
vcenter_rest_log_file строка | Вы можете использовать этот необязательный параметр для указания расположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором выполняется модуль. Если значение не указано в задаче, будет использовано значение переменной среды |
vcenter_username строка / обязательно | Имя пользователя vCenter vSphere. Если значение не указано в задаче, будет использовано значение переменной среды |
vcenter_validate_certs логическое значение | Разрешает подключение, когда сертификаты SSL недействительны. Установите значение Если значение не указано в задаче, будет использовано значение переменной среды Варианты:
|
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vmware/vmware_rest/vcenter_vm_hardware_boot_module.html
