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

Примечание

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

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

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

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

Примечания

Примечание

Для всех модулей требуется доступ для записи API, поэтому они не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- 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 словарь	отображает данные файла снимка экрана захваченного виртуальной машины Возвращается: всегда Пример: `{"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

словарь

отображает данные файла снимка экрана захваченного виртуальной машины

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

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_guest_screenshot_module.html