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

Note

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

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

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

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Module to deploy virtual machine from template in content library.
Content Library feature is introduced in vSphere 6.0 version.
vmtx templates feature is introduced in vSphere 67U1 and APIs for clone template from content library in 67U2.
This module does not work with vSphere version older than 67U2.
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.
content_library string		The name of the content library from where the template resides. aliases: content_library_src
datacenter string / required		Name of the datacenter, where VM to be deployed.
datastore string / required		Name of the datastore to store deployed VM and disk.
folder string / required		Name of the folder in datacenter in which to place deployed VM.
host string / required		Name of the ESX Host in datacenter in which to place deployed VM.
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.
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	http https ←	The connection to protocol.
resource_pool string		Name of the resourcepool in datacenter in which to place deployed VM.
state string	present ← poweredon	The state of Virtual Machine deployed from template in content library. If set to `present` and VM does not exists, then VM is created. If set to `present` and VM exists, no action is taken. If set to `poweredon` and VM does not exists, then VM is created with powered on state. If set to `poweredon` and VM exists, no action is taken.
template string / required		The name of template from which VM to be deployed. aliases: 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	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 U3

Examples

- 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

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

Pavan Bidkar (@pgbidkar)

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