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

Примечание

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

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

Для использования в плейбуке укажите: 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 вместо BIOS UUID.
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_boot_manager_module.html