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

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.7.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 булево	Варианты: нет да	Включить 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 булево	Варианты: нет ← да	Если установлено в `True`, возвращает параметры видеокарты, другие атрибуты игнорируются. Если установлено в `False`, выполнит переконфигурацию и вернет параметры видеокарты.
hostname строка		Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
memory_3D_mb целое число		Значение памяти 3D должно быть степенью двойки и находиться в диапазоне от 32 МБ до 2048 МБ.
moid строка		Идентификатор управляемого объекта экземпляра для управления, если известен, это уникальный идентификатор только в рамках одного экземпляра vCenter. Требуется, если `name` или `uuid` не заданы.
name строка		Имя виртуальной машины. Это обязательный параметр, если параметр `uuid` или `moid` не указан.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число	Значение по умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задании, используется значение переменной окружения `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`, требует графической аппаратной части (GPU) для более быстрых 3D-вычислений.
use_auto_detect булево	Варианты: нет да	Если установлено в `True`, применяет общие настройки видео к гостевой операционной системе, атрибуты `display_number` и `video_memory_mb` игнорируются. Если установлено в `False`, количество дисплеев и общий объём видеопамяти переконфигурируются с использованием `display_number` и `video_memory_mb`.

Имя пользователя строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_USER`. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user
uuid строка		UUID экземпляра для сбора фактов, если известен, это уникальный идентификатор VMware. Это обязательный параметр, если параметр `name` или `moid` не указан.
validate_certs булево	Варианты: нет да ←	Разрешает подключение, когда сертификаты 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_video_module.html