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_template.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster string | Name of the cluster in datacenter in which to place deployed VM. Required if resource_pool is not specified. | |
| datacenter string / required | Name of the datacenter, where VM to be deployed. | |
| datastore string | Name of the datastore to store deployed VM and disk. Required if datastore_cluster is not provided. | |
| datastore_cluster string added in 1.7.0 of community.vmware | Name of the datastore cluster to store deployed VM and disk. Please make sure Storage DRS is active for recommended datastore from the given datastore cluster. If Storage DRS is not enabled, datastore with largest free storage space is selected. Required if datastore is not provided. | |
| 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. Required with resource_pool to find resource pool details. This will be used as additional information when there are resource pools with same name. | |
| 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 | The name of the content library from where the template resides. aliases: content_library, content_library_src | |
| log_level string added in 1.9.0 of community.vmware |
| 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 |
| 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 resource pool in datacenter in which to place deployed VM. Required if cluster is not specified. For default or non-unique resource pool names, specify host and cluster. Resources is the default name of resource pool. | |
| state string |
| 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 |
| 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. |
Note
- 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
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'} |
© 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_template_module.html