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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `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. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `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 чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не применяет системное хранилище сертификатов. Хранилище сертификатов можно указать с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях значение «false» для параметра «validate_certs» может игнорироваться. Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- 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 dictionary	метаданные о рекомендуемой конфигурации ВМ Возвращается: всегда Пример: `"None"`

Авторы

Diane Wang (@Tomorrow9)

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

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