community.vmware.vmware_guest_screenshot 模块 – 创建虚拟机控制台的屏幕截图。

注意

此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定：community.vmware.vmware_guest_screenshot。

概要

  • 此模块用于在虚拟机启动时截取给定虚拟机的屏幕截图。

参数

参数

注释

集群

字符串

虚拟机正在运行的集群名称。

如果未设置 esxi_hostname，则此为必需参数。

esxi_hostname 和 cluster 是互斥的。

数据中心

字符串

虚拟机所属的数据中心名称。

esxi_hostname

字符串

虚拟机正在运行的 ESXi 主机名。

如果未设置 cluster，则此为必需参数。

esxi_hostname 和 cluster 是互斥的。

文件夹

字符串

目标文件夹，用于查找现有客户机的绝对或相对路径。

仅当找到多个同名虚拟机时，此参数才是必需的。

该文件夹应包含数据中心。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

主机名

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果未在任务中指定该值，则将使用环境变量 VMWARE_HOST 的值。

local_path

路径

如果未设置，则创建的屏幕截图文件将保存在 ESXi 主机上虚拟机的目录中。如果设置为本地计算机上的有效路径，则屏幕截图文件将从 ESXi 主机下载到本地目录。

如果不想将屏幕截图文件下载到本地计算机，可以通过屏幕截图事实中返回的文件 URL 手动打开它。

moid

字符串

要管理的实例的托管对象 ID（如果已知），这只是单个 vCenter 实例中的唯一标识符。

如果未提供 name 或 uuid，则此参数是必需的。

名称

字符串

虚拟机名称。

如果未提供参数 uuid 或 moid，则此为必需参数。

密码

别名：pass, pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

如果未在任务中指定该值，则将使用环境变量 VMWARE_PASSWORD 的值。

端口

整数

vSphere vCenter 或 ESXi 服务器的端口号。

如果未在任务中指定该值，则将使用环境变量 VMWARE_PORT 的值。

默认： 443

proxy_host

字符串

将接收所有 HTTPS 请求并中继它们的代理的地址。

格式为主机名或 IP。

如果未在任务中指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。

proxy_port

整数

将接收所有 HTTPS 请求并中继它们的 HTTP 代理的端口。

如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。

username

别名：admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果任务中未指定该值，则将使用环境变量 VMWARE_USER 的值。

uuid

字符串

如果已知，要收集信息的实例的 UUID，这是 VMware 的唯一标识符。

这是一个必需的参数，如果未提供参数 name 或 moid，则需要此参数。

validate_certs

布尔值

当 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"}

作者

  • Diane Wang (@Tomorrow9)