Модуль vmware.vmware_rest.vcenter_vm_hardware_boot_device – Задает виртуальные устройства, которые будут использоваться для загрузки виртуальной машины

Примечание

Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).

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

Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля необходимы дополнительные требования, подробности см. в разделе Требования.

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

Новое в vmware.vmware_rest 0.1.0

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

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

Задает виртуальные устройства, которые будут использоваться для загрузки виртуальной машины. Виртуальная машина будет проверять устройства по порядку, пытаясь загрузиться с каждого, пока не произойдет успешная загрузка. Если список пуст, виртуальная машина будет использовать последовательность загрузки по умолчанию. В списке не должно быть более одного экземпляра Device.Entry для данного типа устройства, за исключением ETHERNET.

Требования

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

vSphere 7.0.3 или выше
python >= 3.6
aiohttp

Параметры

Параметр	Комментарии
devices list / elements=dictionary / required	Упорядоченный список устройств загрузки. Этот параметр обязателен. Допустимые атрибуты: `type` (str): Этот параметр определяет допустимые типы устройств, которые могут использоваться в качестве загрузочных устройств. ([‘set’]) Этот ключ обязателен с [‘set’]. Допустимые значения: CDROM DISK ETHERNET FLOPPY `nic` (str): Виртуальное Ethernet-устройство. Ethernet-устройство, используемое в качестве загрузочного устройства для этой записи. Это поле является необязательным и актуально только тогда, когда значение type равно ETHERNET. Когда клиенты передают значение этой структуры в качестве параметра, поле должно быть идентификатором ресурса, возвращаемого функцией vmware.vmware_rest.vcenter_vm_hardware_ethernet. ([‘set’]) `disks` (list): Устройство виртуального диска. Список виртуальных дисков в порядке загрузки. Это поле является необязательным и актуально только тогда, когда значение type равно DISK. Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых функцией vmware.vmware_rest.vcenter_vm_hardware_disk. ([‘set’])
session_timeout float добавлено в vmware.vmware_rest 2.1.0	Настройки времени ожидания для сеанса клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с.
state string	Варианты: `"set"` ← (по умолчанию)
vcenter_hostname string / required	Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
vcenter_password string / required	Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
vcenter_rest_log_file string	Этот необязательный параметр можно использовать для указания расположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, на котором выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_REST_LOG_FILE`.
vcenter_username string / required	Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
vcenter_validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vm string / required	Идентификатор виртуальной машины. Параметр должен быть идентификатором ресурса, возвращаемого функцией 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: Set a boot device
  vmware.vmware_rest.vcenter_vm_hardware_boot_device:
    vm: '{{ test_vm1_info.id }}'
    devices:
    - type: CDROM
  register: _result

Значения возврата

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

Ключ	Описание
значение словарь	Устанавливает устройство загрузки Возвращено: При успешном выполнении Пример: `{}`

Авторы

Команда 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_device_module.html