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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
boot_delay целое число	Задержка в миллисекундах перед началом процесса загрузки.
boot_firmware строка	Выберите, какая прошива должна быть использована для загрузки виртуальной машины. Варианты: `"bios"` `"efi"`
boot_hdd_name строка добавлен в community.vmware 3.2.0	Этот параметр необязателен. Если не указан, будет использован первый виртуальный диск, найденный в списке устройств ВМ.
boot_order список / элементы=строка	Список загрузочных устройств. По умолчанию: `[]`
boot_retry_delay целое число	Укажите время в миллисекундах между сбоем загрузки виртуальной машины и последующей попыткой загрузки. Если установлено, автоматически установит `boot_retry_enabled=true`, так как этот параметр обязателен.
boot_retry_enabled логическое значение	Если установлено в `true`, виртуальная машина, которая не загружается, попробует загрузиться снова после истечения `boot_retry_delay`. Если установлено в `false`, виртуальная машина ожидает неопределенное время вмешательства пользователя. Варианты: `false` `true`
enter_bios_setup логическое значение	Если установлено в `true`, виртуальная машина автоматически входит в настройки BIOS при следующей загрузке. Виртуальная машина сбрасывает этот флаг, чтобы загрузка машины происходила нормально. Варианты: `false` `true`
hostname строка	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`.
moid строка	Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Это необходимо, если `name` или `uuid` не указаны.
name строка	Имя виртуальной машины для работы. Это необходимо, если параметр `uuid` или `moid` не указан.
name_match строка	Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная. Варианты: `"first"` ← (по умолчанию) `"last"`
password псевдонимы: pass, pwd строка	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
... (rest of the translated table)

END_OF_DOCUMENT_MARKER

имя_пользователя псевдонимы: admin, user строка	Имя пользователя сервера vCenter vSphere или сервера ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
uuid строка	UUID экземпляра для управления, если он известен, по умолчанию это UUID BIOS VMware. Это требуется, если параметр `name` или `moid` не задан.
validate_certs логическое	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в `false` при недоверенных сертификатах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют доступа к API для записи и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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 словарь	метаданные о порядке загрузки виртуальной машины Возвращаемое значение: всегда Пример: {"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

словарь

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

Возвращаемое значение: всегда

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_boot_manager_module.html