community.vmware.vmware_vm_config_option модуль — Возвращает список поддерживаемых идентификаторов гостевых систем и рекомендуемые конфигурационные параметры ВМ для определённой гостевой ОС

Примечание

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

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

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

Для использования в книге задач укажите: community.vmware.vmware_vm_config_option.

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

Обзор

Этот модуль используется для получения информации о поддерживаемых версиях аппаратного обеспечения для создания, списке идентификаторов гостевых систем, поддерживаемых хостом ESXi для последней поддерживаемой виртуальной аппаратной версии или указанной версии аппаратного обеспечения, а также рекомендуемых конфигурационных параметров ВМ для указанного идентификатора гостевой ОС.

Параметры

Параметр	Комментарии
cluster_name string	Имя кластера. Если `esxi_hostname` не указан, этот параметр обязателен.
datacenter string	Имя центра обработки данных, используемого для получения указанного кластера или хоста. Значение по умолчанию: `"ha-datacenter"`
esxi_hostname string	Имя хоста ESXi. Получение параметров конфигурации виртуальной машины на этом хосте ESXi. Если `cluster_name` не указан, этот параметр обязателен.
get_config_options boolean	Возвращает словарь рекомендуемых параметров конфигурации виртуальной машины для идентификатора гостевой ОС, указанного `guest_id` с версией оборудования, указанной `hardware_version` или версией оборудования по умолчанию. При установке в `true`, необходимо установить `guest_id`. Варианты: `false` ← (по умолчанию) `true`
get_guest_os_ids boolean	Возвращает список идентификаторов гостевых ОС, поддерживаемых на указанном объекте. Если установлен `hardware_version`, вернет соответствующий список идентификаторов поддерживаемых гостевых ОС, или вернет список идентификаторов гостевых ОС для версии оборудования по умолчанию. Варианты: `false` ← (по умолчанию) `true`
get_hardware_versions boolean	Возвращает список поддерживаемых версий оборудования виртуальных машин для создания и версию оборудования по умолчанию на указанном объекте. Варианты: `false` ← (по умолчанию) `true`
guest_id string	Идентификатор гостевой ОС из возвращаемого списка, когда `get_guest_os_ids=true`, например, ‘rhel8_64Guest’. Этот параметр должен быть установлен, когда `get_config_options=true`.
hardware_version string	Версия оборудования из возвращаемого списка, когда `get_hardware_versions=true`, например, ‘vmx-19’.
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PORT`. Значение по умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и передавать их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет получать все запросы HTTPS и передавать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_PROXY_PORT`.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Известная проблема в vSphere 7.0 (https://github.com/vmware/pyvmomi/issues/915)
Для всех модулей требуется доступ API на запись, поэтому они не поддерживаются в бесплатной лицензии ESXi.
Все имена переменных и объектов VMware чувствительны к регистру.

Примеры

- name: Get supported guest ID list on given ESXi host for with default hardware version
  community.vmware.vmware_vm_config_option:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    get_guest_os_ids: true
  delegate_to: localhost

- name: Get VM recommended config option for Windows 10 guest OS on given ESXi host
  community.vmware.vmware_vm_config_option:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    get_config_options: true
    guest_id: "windows9_64Guest"
  delegate_to: localhost

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

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

Ключ	Описание
instance словарь	метаданные рекомендуемой конфигурации ВМ Возвращается: всегда Пример: `"None"`

Авторы

Diane Wang (@Tomorrow9)

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

© 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/community/vmware/vmware_vm_config_option_module.html