Spec-Zone.ru › Ansible

модуль vmware.vmware_rest.vcenter_vm_hardware_boot_info — возвращает параметры загрузки виртуальной машины.

Примечание

Этот модуль входит в коллекцию 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_info.

Добавлено в vmware.vmware_rest 0.1.0

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

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

  • Возвращает параметры загрузки виртуальной машины.

Требования

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

  • vSphere 7.0.3 или новее
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

session_timeout

float

добавлено в vmware.vmware_rest 2.1.0

Параметры времени ожидания сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа.

Значение по умолчанию — 300 с.

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. Обязателен при state=[‘get’]

Примечания

Примечание

  • Проверено на 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: Retrieve the boot information from the VM
  vmware.vmware_rest.vcenter_vm_hardware_boot_info:
    vm: '{{ test_vm1_info.id }}'

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

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

Ключ

Описание

value

dictionary

Получение информации о загрузке виртуальной машины

Возвращается: В случае успеха

Пример: {"delay": 0, "enter_setup_mode": 0, "retry": 0, "retry_delay": 10000, "type": "BIOS"}

Авторы

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

Spec-Zone.ru

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