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. | |
| moid строка добавлено в 2.9 | Идентификатор управляемого объекта экземпляра для управления, если он известен. Это уникальный идентификатор только в рамках одного экземпляра vCenter. Это необходимо, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины для работы. Имена виртуальных машин в vCenter не обязательно уникальны, что может представлять проблему, см. name_match. | |
| name_match строка |
| Если совпадает несколько виртуальных машин по имени, используется первая или последняя найденная. |
| password строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка добавлено в 2.9 | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_PROXY_PORT. | |
| state строка |
| Установить состояние VNC на виртуальной машине. |
| username строка | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID экземпляра для управления, если известен. Это уникальный идентификатор VMware. Это необходимо, если name или moid не указаны. | |
| 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
- name: Disable VNC remote display on the VM using MoID
vmware_guest_vnc:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
validate_certs: no
datacenter: "{{ datacenter_name }}"
moid: vm-42
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.9/modules/vmware_guest_vnc_module.html
