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服务器的数据中心是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地址。 如果任务中未指定此值，则将使用环境变量 |
|
如果未设置，则创建的屏幕截图文件将保留在ESXi主机上虚拟机的目录中。如果设置为本地计算机上的有效路径，则屏幕截图文件将从ESXi主机下载到本地目录。 如果不将屏幕截图文件下载到本地计算机，则可以通过屏幕截图事实中返回的文件URL手动打开它。 |
|
vSphere vCenter或ESXi服务器的密码。 如果任务中未指定此值，则将使用环境变量 |
|
接收所有HTTPS请求并转发它们的HTTP代理端口。 如果任务中未指定此值，则将使用环境变量 |
|
vSphere vCenter或ESXi服务器的用户名。 如果任务中未指定此值，则将使用环境变量 |
|
备注
注意
所有模块都需要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
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
显示捕获的虚拟机屏幕截图文件的事实。 返回：始终 示例： |