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 中引入,用于从 67U2 中的内容库克隆模板的 API。

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

要求

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

  • vSphere 自动化 SDK

参数

参数

注释

集群

字符串

数据中心中放置已部署虚拟机的集群的名称。

如果未指定 resource_pool,则为必需。

数据中心

字符串 / 必需

要部署虚拟机的的数据中心的名称。

数据存储

字符串

存储已部署 VM 和磁盘的数据存储的名称。

如果未提供 datastore_cluster,则为必需。

数据存储集群

字符串

存储已部署 VM 和磁盘的数据存储集群的名称。

请确保为给定数据存储集群中的推荐数据存储激活 Storage DRS。

如果未启用 Storage DRS,则选择具有最大可用存储空间的数据存储。

如果未提供 datastore,则为必需。

文件夹

字符串

数据中心中放置已部署虚拟机的文件夹的名称。

默认值: "vm"

主机

字符串

数据中心中放置已部署虚拟机的 ESX 主机的名称。

主机必须是包含资源池的集群的成员。

使用 resource_pool 来查找资源池详细信息时为必需。当存在同名的资源池时,这将用作附加信息。

主机名

字符串

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

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

别名:content_library, content_library_src

字符串

模板所在的内容库的名称。

日志级别

字符串

此模块中所需的日志级别。

选项

  • "debug"

  • "info"

  • "normal" ←(默认)

名称

别名:vm_name

字符串 / 必需

要部署的虚拟机的名称。

密码

别名:pass, pwd

字符串

vSphere vCenter 服务器的密码。

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

端口

整数

vSphere vCenter 的端口号。

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

默认值: 443

协议

字符串

连接到协议。

选项

  • "http"

  • "https" ←(默认)

代理主机

字符串

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

格式为主机名或 IP。

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

代理端口

整数

HTTP 代理的端口,它将接收所有 HTTPS 请求并转发它们。

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

resource_pool

字符串

数据中心中用于放置已部署虚拟机的资源池的名称。

如果未指定 cluster,则为必填项。

对于默认或非唯一的资源池名称,请指定 hostcluster

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": "已部署虚拟机 'Sample_VM'.", "vm_id": "vm-1009"}

作者

  • Pavan Bidkar (@pgbidkar)