Модуль community.vmware.vmware_guest_video – изменение настроек видеокарты указанной виртуальной машины в заданной инфраструктуре vCenter

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.vmware.vmware_guest_video.

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

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

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

Параметры

Параметр	Комментарии
datacenter string	Имя центра обработки данных, которому принадлежит виртуальная машина. По умолчанию: `"ha-datacenter"`
display_number integer	Количество дисплеев. Допустимое значение — от 1 до 10. Максимальное количество дисплеев в веб-интерфейсе vCenter 6.0 и 6.5 — 4.
enable_3D boolean	Включить 3D для гостевых операционных систем, в которых VMware поддерживает 3D. Варианты: `false` `true`
folder string	Папка назначения — абсолютный или относительный путь для поиска существующей гостевой системы. Этот параметр обязателен, только если найдено несколько виртуальных машин с одинаковым именем. Путь к папке должен включать центр обработки данных. Для сервера ESXi центром обработки данных является ha-datacenter. Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2
gather_video_facts boolean	Если задано значение `true`, возвращаются настройки видеокарты, остальные атрибуты игнорируются. Если задано значение `false`, выполняется перенастройка и возвращаются настройки видеокарты. Варианты: `false` ← (по умолчанию) `true`
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_HOST`.
memory_3D_mb integer	Объём 3D-памяти должен быть степенью числа 2; допустимые значения — от 32 до 2048 МБ.
moid string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не указаны `name` или `uuid`.
name string	Имя виртуальной машины. Этот параметр обязателен, если не указаны параметры `uuid` или `moid`.
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`.
renderer_3D string	Если задано значение `automatic`, подходящий вариант (программный или аппаратный) автоматически выбирается для этой виртуальной машины. Если задано значение `software`, для вычислений 3D используются обычные ресурсы ЦП. Если задано значение `hardware`, для ускорения вычислений 3D требуется графическое оборудование (GPU). Варианты: `"automatic"` `"software"` `"hardware"`
use_auto_detect boolean	Если задано значение `true`, к гостевой операционной системе применяются общие настройки видео; атрибуты `display_number` и `video_memory_mb` игнорируются. Если задано значение `false`, количество дисплеев и общий объём видеопамяти будут перенастроены с использованием `display_number` и `video_memory_mb`. Варианты: `false` `true`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_USER`.
uuid string	UUID экземпляра для сбора фактов, если он известен. Это уникальный идентификатор VMware. Этот параметр обязателен, если не указаны параметры `name` или `moid`.
validate_certs boolean	Разрешает подключение, если сертификаты SSL недействительны. Установите значение `false`, если сертификатам нельзя доверять. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
video_memory_mb float	Допустимый общий объём видеопамяти виртуальной машины составляет от 1,172 до 256 МБ в ESXi 6.7U1 и от 1,172 до 128 МБ в ESXi 6.7 и более ранних версиях. Для разных гостевых ОС минимальный и максимальный поддерживаемые объёмы видеопамяти различаются; задавайте значение внимательно.

Примечания

Примечание

Всем модулям требуется доступ на запись через API, поэтому они не поддерживаются при использовании бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не обращается к системному хранилищу сертификатов. Указать хранилище сертификатов можно с помощью переменной среды REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может привести к тому, что в некоторых случаях значение «false» для параметра «validate_certs» будет проигнорировано. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- name: Change video card settings of virtual machine
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test-vm
    gather_video_facts: false
    use_auto_detect: false
    display_number: 2
    video_memory_mb: 8.0
    enable_3D: true
    renderer_3D: automatic
    memory_3D_mb: 512
  delegate_to: localhost
  register: video_facts

- name: Change video card settings of virtual machine using MoID
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
    gather_video_facts: false
    use_auto_detect: false
    display_number: 2
    video_memory_mb: 8.0
    enable_3D: true
    renderer_3D: automatic
    memory_3D_mb: 512
  delegate_to: localhost
  register: video_facts

- name: Gather video card settings of virtual machine
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test-vm
    gather_video_facts: false
  delegate_to: localhost
  register: video_facts

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

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

Ключ	Описание
video_status dictionary	метаданные видеокарты виртуальной машины после управления ею Возвращается: всегда Пример: `{"auto_detect": false, "display_number": 2, "enable_3D_support": true, "memory_3D": 524288, "renderer_3D": "automatic", "video_memory": 8192}`

Авторы

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_guest_video_module.html