vmware_guest_screenshot – Создание снимка экрана консоли виртуальной машины
Новое в версии 2.9.
Описание
- Этот модуль используется для создания снимка экрана заданной виртуальной машины, когда виртуальная машина включена.
- Все параметры и имена объектов 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 строка добавлено в 2.9 | Идентификатор управляемого объекта экземпляра для управления, если известен, это уникальный идентификатор только внутри одного экземпляра vCenter. Это требуется, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины. Этот параметр обязателен, если параметр uuid или moid не указан. | |
| 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. | |
| 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. |
Примечания
Примечание
- Тестировалось на vSphere 6.5 и 6.7
Примеры
- name: take a screenshot of the virtual machine console
vmware_guest_screenshot:
validate_certs: no
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
vmware_guest_screenshot:
validate_certs: no
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 словарь | всегда | отображает данные о файле снимка экрана захваченной виртуальной машины Пример: {'virtual_machine': 'test_vm', 'screenshot_file': '[datastore0] test_vm/test_vm-1.png', 'task_start_time': '2019-05-25T10:35:04.215016Z', 'task_complete_time': '2019-05-25T10:35:04.412622Z', 'result': 'успех', 'screenshot_file_url': 'https://test_vcenter/folder/test_vm/test_vm-1.png?dcPath=test-dc&dsName=datastore0', 'download_local_path': '/tmp/', 'download_file_size': 2367} |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/vmware_guest_screenshot_module.html
