community.vmware.vmware_content_deploy_template 模块 – 从内容库中部署虚拟机模板。

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.vmware。您需要更多要求才能使用此模块，有关详细信息，请参阅 要求。

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

概要

• 从内容库中的模板部署虚拟机的模块。

• 内容库功能在 vSphere 6.0 版本中引入。

• vmtx 模板功能在 vSphere 67U1 中引入，从内容库克隆模板的 API 在 67U2 中引入。

• 此模块不适用于低于 67U2 的 vSphere 版本。

要求

执行此模块的主机需要以下要求。

• vSphere 自动化 SDK

参数

参数	注释
集群 字符串	要放置已部署 VM 的数据中心中的集群名称。 如果未指定 resource_pool，则需要此参数。
数据中心 字符串 / 必需	要部署 VM 的数据中心名称。
数据存储 字符串	存储已部署 VM 和磁盘的数据存储名称。 如果未提供 datastore_cluster，则需要此参数。
数据存储集群 字符串	存储已部署 VM 和磁盘的数据存储集群名称。 请确保已为给定数据存储集群中推荐的数据存储激活存储 DRS。 如果未启用存储 DRS，则选择具有最大可用存储空间的数据存储。 如果未提供 datastore，则需要此参数。
文件夹 字符串	要放置已部署 VM 的数据中心中的文件夹名称。 默认值： "vm"
主机 字符串	要放置已部署 VM 的数据中心中的 ESX 主机名称。 主机必须是包含资源池的集群的成员。 与 resource_pool 一起使用以查找资源池详细信息。当存在名称相同的资源池时，这将用作附加信息。
主机名 字符串	vSphere vCenter 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 VMWARE_HOST 的值。
库 别名：content_library, content_library_src 字符串	模板所在的內容庫的名稱。
日志级别 字符串	此模块中所需的日志记录级别。 选项 "调试" "信息" "普通" ← (默认)
名称 别名：vm_name 字符串 / 必需	要部署的 VM 的名称。
密码 别名：pass, pwd 字符串	vSphere vCenter 服务器的密码。 如果任务中未指定此值，则将使用环境变量 VMWARE_PASSWORD 的值。
端口 整数	vSphere vCenter 的端口号。 如果任务中未指定此值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
协议 字符串	连接协议。 选项 "http" "https" ← (默认)
代理主机 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定值，则将改用环境变量VMWARE_PROXY_HOST的值。
proxy_port 整数	接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定值，则将改用环境变量VMWARE_PROXY_PORT的值。
resource_pool 字符串	要在其中放置已部署虚拟机的资源池的名称。 如果未指定cluster，则此项为必填。 对于默认或非唯一的资源池名称，请指定host和cluster。 资源池的默认名称为Resources。
state 字符串	从内容库中部署的模板的虚拟机的状态。 如果设置为present且虚拟机不存在，则创建虚拟机。 如果设置为present且虚拟机存在，则不执行任何操作。 如果设置为poweredon且虚拟机不存在，则创建处于开机状态的虚拟机。 如果设置为poweredon且虚拟机存在，则不执行任何操作。 选项 "present" ← (默认) "poweredon"
template 别名：template_src 字符串 / 必需	要从中部署虚拟机的模板名称。
username 别名：admin, user 字符串	vSphere vCenter 服务器的用户名。 如果任务中未指定值，则将改用环境变量VMWARE_USER的值。
validate_certs 布尔值	允许在 SSL 证书无效时进行连接。 当证书不受信任时，设置为false。 如果任务中未指定值，则将改用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认)

备注

注意

• 所有模块都需要 API 写入访问权限，因此在免费 ESXi 许可证上不受支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Deploy Virtual Machine from template in content library
  community.vmware.vmware_content_deploy_template:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    template: rhel_test_template
    datastore: Shared_NFS_Volume
    folder: vm
    datacenter: Sample_DC_1
    name: Sample_VM
    resource_pool: test_rp
    state: present
  delegate_to: localhost

- name: Deploy Virtual Machine from template in content library with PowerON State
  community.vmware.vmware_content_deploy_template:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    template: rhel_test_template
    content_library: test_content_library
    datastore: Shared_NFS_Volume
    folder: vm
    datacenter: Sample_DC_1
    name: Sample_VM
    resource_pool: test_rp
    state: poweredon
  delegate_to: localhost

返回值

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

键	描述
vm_deploy_info 字典	虚拟机部署消息和 vm_id 返回：成功时 示例：{"msg": "Deployed Virtual Machine 'Sample_VM'.", "vm_id": "vm-1009"}

作者

• Pavan Bidkar (@pgbidkar)

收藏链接

• 问题跟踪器
• 主页
• 资源库（源代码）