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

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Описание
boot_delay integer	Задержка в миллисекундах перед началом последовательности загрузки.
boot_firmware string	Выберите прошивку, которая будет использоваться для загрузки виртуальной машины. Варианты: `"bios"` `"efi"`
boot_hdd_name string добавлено в community.vmware 3.2.0	Этот параметр необязателен. Если он не задан, будет использоваться первый виртуальный диск в списке устройств виртуальной машины.
boot_order list / elements=string	Список загрузочных устройств. По умолчанию: `[]`
boot_retry_delay integer	Укажите время в миллисекундах между сбоем загрузки виртуальной машины и следующей попыткой загрузки. Если задано, параметр `boot_retry_enabled=true` будет автоматически установлен, так как он требуется.
boot_retry_enabled boolean	Если задано значение `true`, виртуальная машина, которой не удалось загрузиться, повторит попытку после истечения `boot_retry_delay`. Если задано значение `false`, виртуальная машина будет бесконечно ожидать вмешательства пользователя. Варианты: `false` `true`
enter_bios_setup boolean	Если задано значение `true`, при следующей загрузке виртуальная машина автоматически откроет настройки BIOS. Виртуальная машина сбрасывает этот флаг, чтобы продолжить обычную загрузку. Варианты: `false` `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
moid string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не указаны `name` или `uuid`.
name string	Имя виртуальной машины, с которой нужно работать. Этот параметр обязателен, если не указан параметр `uuid` или `moid`.
name_match string	Если найдено несколько виртуальных машин с таким именем, выберите первую или последнюю найденную. Варианты: `"first"` ← (по умолчанию) `"last"`
password aliases: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет получать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
secure_boot_enabled boolean	Выберите, следует ли включить безопасную загрузку EFI. Безопасную загрузку EFI можно включить только при boot_firmware = efi Варианты: `false` `true`
use_instance_uuid boolean	Использовать ли UUID экземпляра VMware вместо UUID BIOS. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра, которым нужно управлять, если он известен; по умолчанию это UUID BIOS VMware. Этот параметр обязателен, если не указан параметр `name` или `moid`.
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: Change virtual machine's boot order and related parameters
  community.vmware.vmware_guest_boot_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: testvm
    boot_delay: 2000
    enter_bios_setup: true
    boot_retry_enabled: true
    boot_retry_delay: 22300
    boot_firmware: bios
    secure_boot_enabled: false
    boot_order:
      - floppy
      - cdrom
      - ethernet
      - disk
  delegate_to: localhost
  register: vm_boot_order

- name: Change virtual machine's boot order using Virtual Machine MoID
  community.vmware.vmware_guest_boot_manager:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: vm-42
    boot_delay: 2000
    enter_bios_setup: true
    boot_retry_enabled: true
    boot_retry_delay: 22300
    boot_firmware: bios
    secure_boot_enabled: false
    boot_order:
      - floppy
      - cdrom
      - ethernet
      - disk
  delegate_to: localhost
  register: vm_boot_order

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

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

Ключ	Описание
vm_boot_status dictionary	метаданные о порядке загрузки виртуальной машины Возвращается: всегда Пример: {"current_boot_delay": 2000, "current_boot_firmware": "bios", "current_boot_order": ["floppy", "disk", "ethernet", "cdrom"], "current_boot_retry_delay": 22300, "current_boot_retry_enabled": true, "current_enter_bios_setup": true, "current_secure_boot_enabled": false, "previous_boot_delay": 10, "previous_boot_firmware": "efi", "previous_boot_order": ["ethernet", "cdrom", "floppy", "disk"], "previous_boot_retry_delay": 10000, "previous_boot_retry_enabled": true, "previous_enter_bios_setup": false, "previous_secure_boot_enabled": true}

Ключ

Описание

vm_boot_status

dictionary

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

Возвращается: всегда

Пример: {"current_boot_delay": 2000, "current_boot_firmware": "bios", "current_boot_order": ["floppy", "disk", "ethernet", "cdrom"], "current_boot_retry_delay": 22300, "current_boot_retry_enabled": true, "current_enter_bios_setup": true, "current_secure_boot_enabled": false, "previous_boot_delay": 10, "previous_boot_firmware": "efi", "previous_boot_order": ["ethernet", "cdrom", "floppy", "disk"], "previous_boot_retry_delay": 10000, "previous_boot_retry_enabled": true, "previous_enter_bios_setup": false, "previous_secure_boot_enabled": true}

Авторы

Abhijeet Kasurde (@Akasurde)

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

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