community.vmware.vmware_guest_vnc – Управляет удалённым отображением VNC на виртуальных машинах в vCenter

Примечание

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

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

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

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

Обзор

Этот модуль может использоваться для включения и выключения удалённого отображения VNC на виртуальной машине.

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter строка	По умолчанию: "ha-datacenter"	Целевой датацентр для операции развертывания. Этот параметр чувствителен к регистру.
folder строка		Целевой каталог, абсолютный или относительный путь для поиска существующего гостевого сервера. Каталог должен содержать датацентр. Датацентр ESX — ha-datacenter
hostname строка		Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды `VMWARE_HOST`. Поддержка переменных среды добавлена в Ansible 2.6.
moid строка		ID управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Это требуется, если `name` или `uuid` не заданы.
name строка		Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. `name_match`.
name_match строка	Варианты: first ← last	Если существует несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная.
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`.
state строка	Варианты: present ← absent	Установить состояние VNC на виртуальной машине.
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.
vnc_ip строка	По умолчанию: "0.0.0.0"	Устанавливает IP-адрес для VNC на виртуальной машине. Требуется только при state установлен в present и будет проигнорирован, если state установлен в absent.
vnc_password строка	По умолчанию: ""	Устанавливает пароль для VNC на виртуальной машине. Требуется только при state установлен в present и будет проигнорирован, если state установлен в absent.
vnc_port целое число	По умолчанию: 0	Порт, на котором работает VNC. Обычно число от 5900 до 7000 в зависимости от вашей конфигурации. Требуется только при state установлен в present и будет проигнорирован, если state установлен в absent.

Примеры

- name: Enable VNC remote display on the VM
  community.vmware.vmware_guest_vnc:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    folder: /mydatacenter/vm
    name: testvm1
    vnc_port: 5990
    vnc_password: vNc5ecr3t
    datacenter: "{{ datacenter_name }}"
    state: present
  delegate_to: localhost
  register: vnc_result

- name: Disable VNC remote display on the VM
  community.vmware.vmware_guest_vnc:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    uuid: 32074771-7d6b-699a-66a8-2d9cf8236fff
    state: absent
  delegate_to: localhost
  register: vnc_result

- name: Disable VNC remote display on the VM using MoID
  community.vmware.vmware_guest_vnc:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
    state: absent
  delegate_to: localhost
  register: vnc_result

Значения возврата

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

Ключ	Возвращаемое значение	Описание
changed булево	всегда	Если что-либо изменилось в extraConfig VM.
failed булево	всегда	Если изменения не удались.
instance словарь	При успешном выполнении в обоих state	Словарь, описывающий VM, включая информацию о VNC.

Авторы

Armin Ranjbar Daemi (@rmin)

© 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_vnc_module.html