Модуль community.vmware.vmware_guest_screenshot — создание снимка экрана консоли виртуальной машины.

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: community.vmware.vmware_guest_screenshot.

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
cluster string	Имя кластера, в котором работает виртуальная машина. Этот параметр обязателен, если не задан `esxi_hostname`. `esxi_hostname` и `cluster` являются взаимоисключающими.
datacenter string	Имя центра обработки данных, к которому относится виртуальная машина.
esxi_hostname string	Имя хоста ESXi, на котором работает виртуальная машина. Этот параметр обязателен, если не задан `cluster`. `esxi_hostname` и `cluster` являются взаимоисключающими.
folder string	Целевая папка — абсолютный или относительный путь для поиска существующей гостевой системы. Этот параметр обязателен только в том случае, если найдены несколько виртуальных машин с одинаковым именем. Путь к папке должен включать центр обработки данных. Для сервера 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 string	Имя хоста или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_HOST`.
local_path path	Если параметр не задан, созданный файл снимка экрана останется в каталоге виртуальной машины на хосте ESXi. Если задан допустимый путь на локальном компьютере, файл снимка экрана будет загружен с хоста ESXi в локальный каталог. Если файл снимка экрана не загружается на локальный компьютер, его можно открыть вручную по возвращённому URL-адресу файла в фактах снимка экрана.
moid string	Идентификатор управляемого объекта экземпляра, которым нужно управлять, если он известен. Это уникальный идентификатор только в пределах одного экземпляра vCenter. Этот параметр обязателен, если не указан `name` или `uuid`.
name string	Имя виртуальной машины. Этот параметр обязателен, если не указан параметр `uuid` или `moid`.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы. Укажите имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_PROXY_PORT`.
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_USER`.
uuid string	UUID экземпляра для сбора фактов, если он известен. Это уникальный идентификатор VMware. Этот параметр обязателен, если не указан параметр `name` или `moid`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификатам нельзя доверять. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Всем модулям необходим доступ на запись через API, поэтому они не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: если эта переменная задана, в некоторых случаях значение «false» параметра «validate_certs» может быть проигнорировано. Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

- 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 dictionary	сведения о файле снимка экрана виртуальной машины Возвращается: всегда Пример: `{"download_file_size": 2367, "download_local_path": "/tmp/", "result": "success", "screenshot_file": "[datastore0] test_vm/test_vm-1.png", "screenshot_file_url": "https://test_vcenter/folder/test_vm/test_vm-1.png?dcPath=test-dc&dsName=datastore0", "task_complete_time": "2019-05-25T10:35:04.412622Z", "task_start_time": "2019-05-25T10:35:04.215016Z", "virtual_machine": "test_vm"}`

Ключ

Описание

screenshot_info

dictionary

сведения о файле снимка экрана виртуальной машины

Возвращается: всегда

Пример: {"download_file_size": 2367, "download_local_path": "/tmp/", "result": "success", "screenshot_file": "[datastore0] test_vm/test_vm-1.png", "screenshot_file_url": "https://test_vcenter/folder/test_vm/test_vm-1.png?dcPath=test-dc&dsName=datastore0", "task_complete_time": "2019-05-25T10:35:04.412622Z", "task_start_time": "2019-05-25T10:35:04.215016Z", "virtual_machine": "test_vm"}

Авторы

Diane Wang (@Tomorrow9)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_guest_screenshot_module.html