Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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 / обязательный

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

Допустимые атрибуты:

- 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 / обязательный

Имя хоста или IP-адрес vSphere vCenter

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_HOST.

vcenter_password

string / обязательный

Пароль vSphere vCenter

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_PASSWORD.

vcenter_rest_log_file

string

С помощью этого необязательного параметра можно указать расположение файла журнала.

Этот файл будет использоваться для записи обмена данными по HTTP REST.

Файл будет сохранён на узле, на котором выполняется модуль.

Если значение не указано в задаче, вместо него будет использоваться значение

переменной окружения VMWARE_REST_LOG_FILE.

vcenter_username

string / обязательный

Имя пользователя vSphere vCenter

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_USER.

vcenter_validate_certs

boolean

Разрешает подключение при недействительных сертификатах SSL. Если сертификаты не являются доверенными, задайте значение false.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения VMWARE_VALIDATE_CERTS.

Допустимые значения:

  • false
  • true ← (по умолчанию)

vm

string / обязательный

Идентификатор виртуальной машины.

Параметр должен содержать идентификатор ресурса, возвращённый модулем 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

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

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

Ключ

Описание

value

dictionary

Задать устройство загрузки

Возвращается: при успешном выполнении

Пример: {}

Авторы

  • Команда Ansible Cloud (@ansible-collections)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/vmware/vmware_rest/vcenter_vm_hardware_boot_device_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API