vmware_deploy_ovf – Deploys a VMware virtual machine from an OVF or OVA file

From Get docs
Ansible/docs/2.7/modules/vmware deploy ovf module


vmware_deploy_ovf – Deploys a VMware virtual machine from an OVF or OVA file

New in version 2.7.


Synopsis

  • This module can be used to deploy a VMware VM from an OVF or OVA file

Requirements

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

  • pyvmomi

Parameters

Parameter Choices/Defaults Comments

allow_duplicates

boolean

  • no
  • yes

Whether or not to allow duplicate VM names. ESXi allows duplicates, vCenter may not.

cluster

-

Cluster to deploy to.

datacenter

-

Default:

"ha-datacenter"

Datacenter to deploy to.

datastore

-

Default:

"datastore1"

Datastore to deploy to.

deployment_option

-

The key of the chosen deployment option.

disk_provisioning

-

  • flat
  • eagerZeroedThick
  • monolithicSparse
  • twoGbMaxExtentSparse
  • twoGbMaxExtentFlat
  • thin

  • sparse
  • thick
  • seSparse
  • monolithicFlat

Disk provisioning type.

fail_on_spec_warnings

boolean

  • no

  • yes

Cause the module to treat OVF Import Spec warnings as errors.

folder

-

Absolute path of folder to place the virtual machine.

If not specified, defaults to the value of datacenter.vmFolder.

hostname

string

The hostname or IP address of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

Environment variable support added in version 2.6.

name

-

Name of the VM to work with.

Virtual machine names in vCenter are not necessarily unique, which may be problematic.

networks

-

Default:

{"VM Network": "VM Network"}

key: value mapping of OVF network name, to the vCenter network name.

ovf

-

Path to OVF or OVA file to deploy.


aliases: ova

password

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

Environment variable support added in version 2.6.


aliases: pass, pwd

port

integer

added in 2.5

Default:

443

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Environment variable support added in version 2.6.

power_on

boolean

  • no
  • yes

Whether or not to power on the virtual machine after creation.

properties

-

The assignment of values to the properties found in the OVF as key value pairs.

resource_pool

-

Default:

"Resources"

Resource Pool to deploy to.

username

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

Environment variable support added in version 2.6.


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.

Environment variable support added in version 2.6.

If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

wait

boolean

  • no
  • yes

Wait for the host to power on.

wait_for_ip_address

boolean

  • no

  • yes

Wait until vCenter detects an IP address for the VM.

This requires vmware-tools (vmtoolsd) to properly work after creation.



Examples

- vmware_deploy_ovf:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    ovf: /path/to/ubuntu-16.04-amd64.ovf
    wait_for_ip_address: true
  delegate_to: localhost

Return Values

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

Key Returned Description

instance

dictionary

always

metadata about the new virtual machine


Sample:

None




Status

Authors

  • Matt Martz (@sivel)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_deploy_ovf_module.html