community.vmware.vmware_content_deploy_ovf_template – Deploy Virtual Machine from ovf template stored in content library.

Note

This plugin is part of the community.vmware collection (version 1.15.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_content_deploy_ovf_template.

Synopsis

  • Module to deploy virtual machine from ovf template in content library.
  • All variables and VMware object names are case sensitive.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi
  • vSphere Automation SDK

Parameters

Parameter Choices/Defaults Comments
cluster
string
Name of the cluster in datacenter in which to place deployed VM.
datacenter
string / required
Name of the datacenter, where VM to be deployed.
datastore
string
Name of the datastore to store deployed VM and disk.
datastore_cluster
string
added in 1.9.0 of community.vmware
Name of the datastore cluster housing a datastore to store deployed VM and disk.
If datastore is not specified, the recommended datastore from this cluster will be used.
folder
string
Default:
"vm"
Name of the folder in datacenter in which to place deployed VM.
host
string
Name of the ESX Host in datacenter in which to place deployed VM. The host has to be a member of the cluster that contains the resource pool.
hostname
string
The hostname or IP address of the vSphere vCenter server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
library
string
added in 1.5.0 of community.vmware
The name of the content library from where the template resides.

aliases: content_library, content_library_src
log_level
string
added in 1.12.0 of community.vmware
    Choices:
  • debug
  • info
  • normal ←
The level of logging desired in this module.
name
string / required
The name of the VM to be deployed.

aliases: vm_name
password
string
The password of the vSphere vCenter server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

aliases: pass, pwd
port
integer
Default:
443
The port number of the vSphere vCenter.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
protocol
string
    Choices:
  • http
  • https ←
The connection to protocol.
proxy_host
string
added in 1.12.0 of community.vmware
Address of a proxy that will receive all HTTPS requests and relay them.
The format is a hostname or a IP.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
proxy_port
integer
added in 1.12.0 of community.vmware
Port of the HTTP proxy that will receive all HTTPS requests and relay them.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.
resource_pool
string
Name of the resourcepool in datacenter in which to place deployed VM.
storage_provisioning
string
    Choices:
  • thin ←
  • thick
  • eagerZeroedThick
  • eagerzeroedthick
Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor.
template
string / required
The name of OVF template from which VM to be deployed.

aliases: ovf, ovf_template, template_src
username
string
The username of the vSphere vCenter server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes ←
Allows connection when SSL certificates are not valid.
Set to False when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Notes

Note

  • Tested on vSphere 6.7

Examples

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

- name: Deploy Virtual Machine from OVF template in content library with eagerZeroedThick storage
  vmware_content_deploy_ovf_template:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    ovf_template: rhel_test_template
    datastore: Shared_NFS_Volume
    folder: vm
    datacenter: Sample_DC_1
    name: Sample_VM
    resource_pool: test_rp
    storage_provisioning: eagerZeroedThick
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vm_deploy_info
dictionary
on success
Virtual machine deployment message and vm_id

Sample:
{'msg': "Deployed Virtual Machine 'Sample_VM'.", 'vm_id': 'vm-1009'}


Authors

  • Lev Goncharv (@ultral)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_content_deploy_ovf_template_module.html