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

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.6.0).

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

Для использования в плейбуке укажите: community.vmware.vmware_guest_video.

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

Обзор

Этот модуль используется для переконфигурации настроек видеокарты заданной виртуальной машины.
Все параметры и имена объектов VMware чувствительны к регистру.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter строка	Значение по умолчанию: "ha-datacenter"	Имя датацентра, к которому принадлежит виртуальная машина. Этот параметр чувствителен к регистру.
display_number целое число		Количество дисплеев. Допустимое значение от 1 до 10. Максимальное количество дисплеев — 4 в vCenter 6.0, 6.5 веб-интерфейсе.
enable_3D логическое значение	Варианты: no yes	Включить 3D для гостевых операционных систем, в которых поддерживается 3D VMware.
folder строка		Папка назначения, абсолютный или относительный путь для поиска существующего гостевого компьютера. Это обязательный параметр, только если найдено несколько ВМ с одинаковым именем. Папка должна содержать датацентр. Датацентр сервера 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 логическое значение	Варианты: no ← yes	Если установлено значение `True`, возвращаются настройки видеокарты, другие атрибуты игнорируются. Если установлено значение `False`, выполняется переконфигурация и возвращаются настройки видеокарты.
hostname строка		Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
memory_3D_mb целое число		Значение памяти 3D должно быть степенью двойки и находится в диапазоне от 32 МБ до 2048 МБ.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Это необходимо, если не указаны `name` или `uuid`.
name строка		Имя виртуальной машины. Это обязательный параметр, если не указаны `uuid` или `moid`.
password строка		Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PASSWORD`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PORT`. Поддержка переменных среды добавлена в Ansible 2.6.
proxy_host строка		Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PROXY_HOST`. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12.
proxy_port целое число		Порт HTTP-прокси, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_PROXY_PORT`.
renderer_3D строка	Варианты: automatic software hardware	Если установлено значение `automatic`, автоматически выбирается соответствующий параметр (software или hardware) для данной виртуальной машины. Если установлено значение `software`, для 3D-вычислений используется обычная обработка ЦП. Если установлено значение `hardware`, для более быстрых 3D-вычислений требуется графическое оборудование (GPU).
use_auto_detect логическое значение	Варианты: no yes	Если установлено значение `True`, к гостевой операционной системе применяются общие настройки видео, атрибуты `display_number` и `video_memory_mb` игнорируются. Если установлено значение `False`, количество дисплеев и общий объем видеопамяти переконфигурируются с использованием `display_number` и `video_memory_mb`.
username строка		Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
uuid строка		UUID экземпляра для сбора фактов, если известен. Это уникальный идентификатор VMware. Это обязательный параметр, если не указаны `name` или `moid`.
validate_certs логическое значение	Варианты: no yes ←	Позволяет подключиться, когда сертификаты SSL недействительны. Установите значение `false`, когда сертификаты не доверяются. Если значение не указано в задаче, будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение `true`, убедитесь, что на данном компьютере установлен Python >= 2.7.9.
video_memory_mb вещественное число		Допустимый диапазон общей видеопамяти виртуальной машины составляет от 1,172 МБ до 256 МБ на ESXi 6.7U1, от 1,172 МБ до 128 МБ на ESXi 6.7 и более ранних версиях. Для определенных гостевых ОС поддерживаемые минимальные и максимальные значения видеопамяти отличаются, будьте внимательны при установке этого значения.

Примечания

Примечание

Тестировалось на vSphere 6.0, 6.5 и 6.7

Примеры

- 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 словарь	всегда	метаданные о видеокарте виртуальной машины после управления ими Пример: {'auto_detect': False, 'display_number': 2, 'enable_3D_support': True, 'memory_3D': 524288, 'renderer_3D': 'automatic', 'video_memory': 8192}

Авторы

Diane Wang (@Tomorrow9) <dianew@vmware.com>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_video_module.html