community.vmware.vmware_export_ovf 模块 – 将 VMware 虚拟机导出到 OVF 文件、设备文件和清单文件

注意

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

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

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

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

概要 

此模块可用于将 VMware 虚拟机从 vCenter Server 或 ESXi 主机导出到 OVF 模板。

参数 

参数	注释
datacenter 字符串	要导出的虚拟机的虚拟中心名称。默认值： `"ha-datacenter"`
download_timeout 整数	导出文件的用户定义超时时间（秒）。如果 vmdk 文件太大，您可以增加此值。默认值： `30`
export_dir 路径 / 必需	在运行此任务的服务器上放置导出文件的绝对路径，必须具有写入权限。如果文件夹不存在，将创建它，还会在此路径下创建一个以 VM 名称命名的文件夹。
export_with_extraconfig 布尔值	导出虚拟机的所有额外配置选项。选项 `false` ← (默认) `true`
export_with_images 布尔值	导出安装在虚拟机 CD/DVD 驱动器上的媒体的 ISO 映像。选项 `false` ← (默认) `true`
folder 字符串	目标文件夹，查找指定客户机的绝对路径。该文件夹应包含数据中心。ESX 数据中心是 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 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
moid 字符串	要管理的实例的托管对象 ID（如果已知），这是仅在单个 vCenter 实例中唯一的标识符。如果未提供 `name` 或 `uuid`，则需要此参数。
name 字符串	要导出的虚拟机的名称。如果未提供参数 `uuid` 或 `moid`，则此参数是必需的。
password 别名：pass、pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定值，则将使用环境变量`VMWARE_PROXY_PORT`的值。
用户名别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定值，则将使用环境变量`VMWARE_USER`的值。
UUID 字符串	要导出的虚拟机的 UUID。这是一个必需参数，如果参数`name`或`moid`未提供。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)

备注 

注意

所有模块都需要 API 写入权限，因此不受免费 ESXi 许可证的支持。
所有变量和 VMware 对象名称都区分大小写。

示例 

- community.vmware.vmware_export_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: '{{ vm_name }}'
    export_with_images: true
    export_dir: /path/to/ovf_template/
  delegate_to: localhost

返回值 

常用返回值已在此处记录，以下是此模块特有的字段

键	描述
instance 字典	已导出文件的列表，如果从 vCenter Server 导出，则设备文件未以虚拟机名称命名返回值：始终示例：`"None"`

作者

Diane Wang (@Tomorrow9)