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

Новая версия с версии 2.8.

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

Обзор

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

Требования

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

python >= 2.6
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
datacenter -	Значение по умолчанию: "ha-datacenter"	Целевой центр обработки данных для операции развертывания. Этот параметр чувствителен к регистру.
folder -		Целевой каталог, абсолютный или относительный путь для поиска существующего гостевого компьютера. Каталог должен включать центр обработки данных. Центр обработки данных ESX — ha-datacenter
hostname строка		Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
name -		Имя виртуальной машины, с которой необходимо работать. Имена виртуальных машин в vCenter не обязательно уникальны, что может быть проблематично, см. `name_match`.
name_match -	Варианты: first ← last	Если есть несколько виртуальных машин, соответствующих имени, используется первая или последняя найденная.
password строка		Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
port целое число добавлен в 2.5	Значение по умолчанию: 443	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. Поддержка переменных окружения добавлена в Ansible 2.6.
state -	Варианты: present ← absent	Устанавливает состояние VNC на виртуальной машине.
username строка		Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
uuid -		UUID экземпляра для управления, если известно, это уникальный идентификатор VMware. Это обязательно, если `name` не указан.
validate_certs логическое значение	Варианты: нет да ←	Разрешает подключение, когда сертификаты SSL недействительны. Установите значение `false` когда сертификаты не доверяются. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено значение `yes`, убедитесь, что на данном компьютере установлен 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
  vmware_guest_vnc:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    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
  vmware_guest_vnc:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: no
    datacenter: "{{ datacenter_name }}"
    uuid: 32074771-7d6b-699a-66a8-2d9cf8236fff
    state: absent
  delegate_to: localhost
  register: vnc_result

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

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

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

Статус

Гарантируется, что этот модуль будет иметь обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Armin Ranjbar Daemi (@rmin)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vmware_guest_vnc_module.html