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

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.0).

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

Для использования в playbook укажите: community.vmware.vmware_guest_boot_manager.

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

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
boot_delay целое число	Значение по умолчанию: 0	Задержка в миллисекундах перед началом последовательности загрузки.
boot_firmware строка	Варианты: bios efi	Выбор типа микропрограммы, которая должна использоваться для загрузки виртуальной машины.
boot_order список / элементы=строка	Значение по умолчанию: []	Список устройств загрузки.
boot_retry_delay целое число	Значение по умолчанию: 0	Указывает время в миллисекундах между сбоем загрузки виртуальной машины и последующей попыткой загрузки заново. Если установлено, автоматически установит `boot_retry_enabled` на `True`, так как этот параметр требуется.
boot_retry_enabled логический тип	Варианты: нет ← да	Если установлено значение `True`, виртуальная машина, которая не загрузилась, попытается загрузиться снова после истечения `boot_retry_delay`. Если установлено значение `False`, виртуальная машина ожидает неопределенно долго вмешательства пользователя.
enter_bios_setup логический тип	Варианты: нет ← да	Если установлено значение `True`, виртуальная машина автоматически переходит к настройкам BIOS при следующей загрузке. Виртуальная машина сбрасывает этот флаг, чтобы процесс загрузки машины продолжился нормально.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если он известен, это уникальный идентификатор только в рамках одного экземпляра vCenter. Это требуется, если `name` или `uuid` не указаны.
name строка		Имя виртуальной машины для работы. Это требуется, если параметр `uuid` или `moid` не указан.
name_match строка	Варианты: первый ← последний	Если несколько виртуальных машин соответствуют имени, используется первая или последняя найденная.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат – имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12
proxy_port целое число		Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_PROXY_PORT`.
secure_boot_enabled логический тип	Варианты: нет ← да	Выбор, нужно ли включить EFI secure boot. EFI secure boot можно включить только с boot_firmware = efi
use_instance_uuid логический тип	Варианты: нет ← да	Использовать ли UUID экземпляра VMware вместо UUID BIOS.
username строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. Псевдонимы: admin, user
uuid строка		UUID экземпляра для управления, если он известен, по умолчанию это BIOS UUID VMware. Это требуется, если `name` или `moid` параметр не указан.
validate_certs логический тип	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в `false`, когда сертификаты не доверяются. Если значение не указано в задаче, используется значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено значение `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.

Примечания

Примечание

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

Примеры

- 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}

Авторы

Abhijeet Kasurde (@Akasurde) <akasurde@redhat.com>

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_boot_manager_module.html