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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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. Максимальное количество дисплеев равно 4 в веб-интерфейсе vCenter 6.0, 6.5.
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 или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `VMWARE_HOST`.
memory_3D_mb integer	Значение 3D памяти должно быть степенью двойки, а допустимое значение — от 32 МБ до 2048 МБ.
moid string	Идентификатор управляемого объекта экземпляра для управления, если известен; это уникальный идентификатор только в пределах одного экземпляра vCenter. Это необходимо, если `name` или `uuid` не указаны.
name string	Имя виртуальной машины. Это обязательный параметр, если параметр `uuid` или `moid` не указан.
password aliases: 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`.
renderer_3D string	Если установлено в `automatic`, автоматически выбирает соответствующий вариант (программный или аппаратный) для этой виртуальной машины. Если установлено в `software`, использует обычную обработку ЦП для 3D-вычислений. Если установлено в `hardware`, требует графического оборудования (GPU) для более быстрых 3D-вычислений. Варианты: `"automatic"` `"software"` `"hardware"`
use_auto_detect boolean	Если установлено в `true`, применяет общие настройки видео к гостевой операционной системе, атрибуты `display_number` и `video_memory_mb` игнорируются. Если установлено в `false`, количество дисплеев и общий объем видеопамяти будут переконфигурированы с использованием `display_number` и `video_memory_mb`. Варианты: `false` `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `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 чувствительны к регистру.

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_video_module.html