community.vmware.vmware_guest_screenshot – Создание снимка экрана консоли виртуальной машины.
Примечание
Этот плагин является частью коллекции community.vmware (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_guest_screenshot.
Описание
- Этот модуль используется для создания снимка экрана указанной виртуальной машины, когда виртуальная машина включена.
- Все параметры и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cluster строка | Имя кластера, в котором запущена виртуальная машина. Этот параметр обязателен, если esxi_hostname не задан.esxi_hostname и cluster — взаимоисключающие параметры. | |
| datacenter строка | Имя центров обработки данных, к которому принадлежит виртуальная машина. | |
| esxi_hostname строка | Имя хоста ESXi, на котором запущена виртуальная машина. Этот параметр обязателен, если cluster не задан.esxi_hostname и cluster — взаимоисключающие параметры. | |
| 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 | |
| hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| local_path путь | Если local_path не задан, созданный файл снимка экрана будет сохранён в директории виртуальной машины на хосте ESXi. Если local_path задан на валидный путь на локальной машине, то файл снимка экрана будет загружен с хоста ESXi в локальную директорию.Если снимок экрана не загружается на локальную машину, его можно открыть через возвращённый URL файла в фактах снимка вручную. | |
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Этот параметр обязателен, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины. Этот параметр обязателен, если параметр uuid или moid не указан. | |
| 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. | |
| 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. Если установлено true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Проверено на vSphere 6.5 и 6.7
Примеры
- name: take a screenshot of the virtual machine console
community.vmware.vmware_guest_screenshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "{{ folder_name }}"
name: "{{ vm_name }}"
local_path: "/tmp/"
delegate_to: localhost
register: take_screenshot
- name: Take a screenshot of the virtual machine console using MoID
community.vmware.vmware_guest_screenshot:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
folder: "{{ folder_name }}"
moid: vm-42
local_path: "/tmp/"
delegate_to: localhost
register: take_screenshot
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| screenshot_info словарь | всегда | отображает факты файла снимка экрана захваченной виртуальной машины Пример: {'размер_файла_загрузки': 2367, 'локальный_путь_загрузки': '/tmp/', 'результат': 'успех', 'файл_снимка': '[datastore0] test_vm/test_vm-1.png', 'url_файла_снимка': 'https://test_vcenter/folder/test_vm/test_vm-1.png?dcPath=test-dc&dsName=datastore0', 'время_завершения_задачи': '2019-05-25T10:35:04.412622Z', 'время_начала_задачи': '2019-05-25T10:35:04.215016Z', 'виртуальная_машина': 'test_vm'} |
Авторы
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_screenshot_module.html
